LISTSERV mailing list manager LISTSERV 16.5

Help for QSERV-L Archives


QSERV-L Archives

QSERV-L Archives


QSERV-L@LISTSERV.SLAC.STANFORD.EDU


View:

Message:

[

First

|

Previous

|

Next

|

Last

]

By Topic:

[

First

|

Previous

|

Next

|

Last

]

By Author:

[

First

|

Previous

|

Next

|

Last

]

Font:

Proportional Font

LISTSERV Archives

LISTSERV Archives

QSERV-L Home

QSERV-L Home

QSERV-L  August 2014

QSERV-L August 2014

Subject:

Re: proof-reading qserv docs

From:

"Daniel L. Wang" <[log in to unmask]>

Reply-To:

General discussion for qserv (LSST prototype baseline catalog)

Date:

Fri, 8 Aug 2014 18:06:14 -0700

Content-Type:

text/plain

Parts/Attachments:

Parts/Attachments

text/plain (78 lines)

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

Top of Message | Previous Page | Permalink

Advanced Options


Options

Log In

Log In

Get Password

Get Password


Search Archives

Search Archives


Subscribe or Unsubscribe

Subscribe or Unsubscribe


Archives

March 2018
February 2018
January 2018
December 2017
August 2017
December 2016
November 2016
October 2016
September 2016
August 2016
July 2016
June 2016
May 2016
April 2016
March 2016
February 2016
January 2016
December 2015
November 2015
October 2015
September 2015
August 2015
July 2015
June 2015
May 2015
April 2015
March 2015
February 2015
January 2015
December 2014
November 2014
October 2014
September 2014
August 2014
July 2014
June 2014
May 2014
April 2014
March 2014
February 2014
January 2014
December 2013
November 2013
October 2013
September 2013
August 2013
July 2013
June 2013
May 2013
April 2013
March 2013
February 2013
January 2013
December 2012

ATOM RSS1 RSS2



LISTSERV.SLAC.STANFORD.EDU

Secured by F-Secure Anti-Virus CataList Email List Search Powered by the LISTSERV Email List Manager

Privacy Notice, Security Notice and Terms of Use