Jacek,
"Welcome to Qserv's documentation!" should just be "Qserv 2014_08.0
documentation
<http://lsst-web.ncsa.illinois.edu/%7Efjammes/qserv-doc/u.fjammes.DM-649-gee2bed707c/index.html#>"
or just "Qserv documentation"
"Software architecture" --> "Administration reference"
---------------------------
quickstart page:
"FOR DEVELOPERS:..." --> "This procedure is for RELEASED and PUBLISHED
qserv software. Developers interested in modifying code or running
unreleased versions should see Quick start guide for developers "
Configuration
The code block should just be:
qserv-configure.py --all
The alert:"Qserv commands listed below provides advanced options, use
–help option to discover how to use it." is unnecessary. Just put a note
below the command saying something like: "For more options, run
qserv-configure.py --help". In the future, we should at least list, of
not document some of the options. The whole point of this page is to
"document".
In general, the alert blocks ( that have (!) ) should only be used to
point out "gotchas" or ways in which the reader may possibly screw up.
The block at the top of the page is appropriate--it just says "Hey,
watch out" and is not really adding to the essentials of the page.
Integration tests
"Integration tests" -> "Testing"
The "Default value for ..." alert should probably be a comment in the
code block below.
Quick start guide for developers
You want something to say: "Using Qserv with your own custom code or
arbitrary versions can be done by connecting your local git clone with
an existing released qserv installation (e.g. from Quick start guide).
This should be stated above "Setup current Qserv version in eups".
Setup current Qserv version in eups:
text should say: "These commands point the infrastructure of an existing
qserv installation to work with a local Qserv git repository."
below code block:
Once the qserv eups stack is integrated with your local Qserv
repository, you will need to re-configure and (if desired) re-test as
described in the Quick start guide.
I'll have to look at "Software architecture" later--it's a bit messy and
not really user documentation--it looks like like a Trac/JIRA ticket or
epic.
Hope this helps,
-Daniel
On 08/08/2014 10:20 AM, Becla, Jacek wrote:
> Daniel, this is related to DM-649, can you proof-read this doc:
>
> http://lsst-web.ncsa.illinois.edu/~fjammes/qserv-doc/u.fjammes.DM-649-gee2bed707c/
>
> thanks
> Jacek
########################################################################
Use REPLY-ALL to reply to list
To unsubscribe from the QSERV-L list, click the following link:
https://listserv.slac.stanford.edu/cgi-bin/wa?SUBED1=QSERV-L&A=1
|