LSST Data Management Communications Platforms

An overview of the communication and documentation platforms for LSST Data Management. We present an information architecture where a social forum, Community.lsst.io and an up-coming Documentation Hub, provide entry points into all of DM's information.

Transcript

1. 3/23/16 Jonathan Sick SQuaRE Software Developer Frossie Economou SQuaRE Technical Manager on behalf of LSST Data Management March 23, 2016 Related Technote: http://sqr-011.lsst.io LSST Data Management Communication Platforms
2. Mandate We provide communication services to DM in construction that supports commissioning and is delivered as a low-maintenance communication platform for sci/data operations.
3. Philosophy How SQuaRE choses & builds tools. Eliminate gatekeepers. Automation & APIs. Preferences. Cost. Everyone in DM is empowered to create & publish content. Peer review process ensures accuracy. Automation removes skill barriers. APIs allow us to integrate platforms. Relies upon an authorization service. Developers should enjoy the tools they use. Standard tooling speeds on- boarding. Open source and non-profit discounts. Cost of migration and operation.
4. Information Architecture We help the science community access & discover DM’s information through two entry points. community.lsst.org Community hub DocHub Front-end + • Venue for DM news. (LSST news?) • User support for DM software and data. • Ask LSST Anything — for sci collaborations. • Open/private collaboration for LSST systems. • Everyone connected to LSST should be here. • All of DM’s artifacts: docs (software/data/design), technotes, papers, presentations, JIRA tickets, Community conversations and code. • Categories, full-text search, curated collections. • Automated: hooks into document archives and the LSST the Docs publication system.
5. Community forum community.lsst.org Community hub On-boarding Members of LSST Project & Science Collaborations Software READMEs & Docs Social Media & mailing lists via Mailbot Always answer questions with links to docs. Resolve difficult issues quickly with chat (for commissioning and ops) lsst.io Docs & Technotes Docs in Docushare/ Zenodo A central hub for LSST news and discussion. Discussions link to documentation (contextual and serendipitous documentation discovery)
6. DocHub Full-text search, categorical browsing, curated collections of all LSST/DM artifacts. Normalizes the source of documents; info lives in the most appropriate platform. Architected with a REST backend that can be re- used by the Project. Automatically updated by integrating into platform APIs. DocHub Front-end lsst.org Tickets & RFCs Code & Pull Requests Community Software & Data Docs Technotes & Design Docs DocuShare LSST the Docs
7. Communication Tasks & Tools Domain Platform Audience DM Project Community Chat HipChat R W ? Slack (RFC-140) R W ? ? Forum Community R W R W R W Wiki Confluence R W R W R Development JIRA R W R W R GitHub R W R W R W Doc Index DocHub R R R R Read/Consume W Write/Contribute ? Possible Not applicable R ? Read, but contribution unknown R* Read indirectly Synchronous Asynchronous Broadcast Archive service
8. Platforms Platform Audience DM Project Community Chat HipChat R W ? Slack R W ? ? Community.lsst.org R W R W R W Confluence R W R W R W JIRA (Tickets & Req. for Comments) R W R W R W GitHub Issues W GitHub Pull Requests R W R W R W Google Docs R W Dropbox R W Change-controlled Docs LSST the Docs R W R W R DocuShare R W R W R Technotes R W R ? R Developer Guide R W R R DocHub R R R NASA/SAO ADS R Zenodo W W R* DocuShare R* W R W R* R Read/Consume W Write/Contribute ? Possible Not applicable R ? Read, but contribution unknown R* Read indirectly Synchronous Asynchronous Broadcast Archive service
9. Authorization Service Requirements • Many platforms require authorization. E.g., private categories in community.lsst.org, private chat rooms, private mailing lists, GitHub push access and other publication services. • DM solves this internally with GitHub teams… but extending the service to science collaborations and operations requires a curated authorization service. E.g., an LDAP database that allows API access. • ContactsDB has overlap with NCSA’s data access authorization; we may need an interim service.
10. http://sqr-011.lsst.io LSST Data Management Communications Platforms Technote