New developer guide: accommodating the login-required NCSA content?

[jsick (Jonathan Sick)]

One of the products I’m working towards launching soon is a new DM Developer Guide based on reStructuredText/Sphinx (as opposed to Confluence).

I’ve noticed that everything having to do with NCSA development servers is currently set to be viewable only by those logged into LSST’s Confluence. This even includes the on-boarding checklist.

The new generation of Sphinx-based docs, being served as static sites, cannot accommodate password protected pages. Our ethos is to be open. This is especially useful for an onboarding checklist since a new developer may not have/or know how to get Confluence credentials early on in the onboarding process.

I’d like feedback from NCSA (@wglick and others) on what aspects of their pages in the existing DM Developer Guide is considered sensitive in nature. Is it that you don’t want server addresses publicized?

If it is critical to have login-protection for NCSA server documentation, a way forward would be for me to provide a landing page in the new Sphinx-based Developer Guide that indexes NCSA’s pages on Confluence so that developers can easily discover what documentation exists for NCSA services. The NCSA pages would be the only Developer Guide pages that remain in Confluence.

[wglick (Bill Glick)]

Can you provide URLs for the specific current pages you’re referring to? I’m not finding them in the list of subpages under https://confluence.lsstcorp.org/display/LDMDG/LSST+DM+Developer+Guide

I think we can provide a less comprehensive list of servers, etc that would be fine for anonymous viewing. I’m not sure we need to list all resources at NCSA, but rather a few that new users need to know about.

[jsick (Jonathan Sick)]

These are pages that are locked down at the moment

• Getting Started in DM
• DM Development Servers
• NCSA Nebula OpenStack User Guide
• Using the Bulk Transfer System at NCSA
• DM System Announcements (which, don’t really believe in the new Dev Guide since it’s fundamentally a status page)

The page on https://confluence.lsstcorp.org/display/LDMDG/Developer+Tools+at+NCSA is openly viewable, however.

The Nebula OpenStack Issues also likely belongs in confluence as a collaborative document.

[wglick (Bill Glick)]

Here are my thoughts on these pages’ availability:

• Getting Started in DM
  Everything here can be publicly viewable.

• DM Development Servers
  This should be moved out of the Developer Guide, or completely deleted.

• NCSA Nebula OpenStack User Guide
  I haven’t read through this entirely, but tentatively think it could be publicly available.

• Using the Bulk Transfer System at NCSA
  This can be publicly viewable.

• DM System Announcements
  This should be moved within Confluence, but could be publicly viewable.

• [Developer Tools at NCSA] (https://confluence.lsstcorp.org/display/LDMDG/Developer+Tools+at+NCSA) This can be publicly viewable.

• [Nebula OpenStack Issues] (https://confluence.lsstcorp.org/display/LDMDG/NCSA+Nebula+OpenStack+Issues)
  This should be moved restricted to LSST users in Confluence. It could potentially point out vulnerabilities that have been discovered, which should not be publicly viewable.