[lsst-dm-stack-users] Confusion over documentation

Srinivasan Chandrasekharan schandra at noao.edu
Fri Sep 19 10:46:45 PDT 2014


Hi KT,

Its absolutely fine to follow what Confluence is doing for documentation but the Site Spaces might become unwieldy if all software projects ended up publishing their documentation with versions on the Site Space level.

What I am suggesting is that Site Space level is called “LSST Software User Guide” and one could pages for versioning underneath because I am sure there will be other versions of the LSST Software User Guide that come along.

Regards,
Srinivasan Chandrasekharan
Senior Software Engineer,
Large Synoptic Survey Telescope,
National Optical Astronomy Observatory,
Tucson, AZ 85726
(520) 318-8383
schandra at noao.edu




On Sep 19, 2014, at 10:36 AM, Dick Shaw <shaw at noao.edu> wrote:

> On Fri, 19 Sep 2014 10:24:27 -0700
> Kian-Tat Lim <ktl at slac.stanford.edu> wrote:
>>> Apologies if this is creating work more than just moving the older versions of documentation to the lower levels.
>> 	I don't think it's easy to make a full Confluence Space into a
>> subsidiary of another Confluence Space.  Among other things, page names
>> are required to be unique within a Space.
>> 	I believe Dick's organization follows the pattern of Atlassian
>> themselves.  If you go to their space directory:
>> <https://confluence.atlassian.com/spacedirectory/view.action>, you'll
>> see much the same.  They do have an explicit "Confluence Latest", and
>> they provide an overview page:
>> <https://confluence.atlassian.com/display/ALLDOC/Confluence+Documentation+Directory>. We could try to emulate that more closely.
> 
> Yeah, I thought about that some months ago, but we hadn't got to the point of having multiple (active) versions of User docs. I guess now it's time. I'll have another look at the Confluence organization.
> 
> BTW, I'm delighted that the SWUG is actually being used.
> 
> -Dick

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://listserv.lsstcorp.org/pipermail/dm-users/attachments/20140919/664d1a5f/attachment.html>


More information about the dm-users mailing list