Jump to: navigation, search

Documentation/Liberty

< Documentation
Revision as of 23:25, 25 May 2015 by Loquacity (talk | contribs) (Cross-Project Workshop)

Liberty Design Summit Wrap-up

Cross-Project Workshop

Observations

  • sorting by user type (ops, admin, etc) is ineffective
  • there is a generally-held assumption that building docs is difficult.

RFEs

  • Need to talk about trying to support multiple releases in one doc. It's a lot of work when you're way behind on docs (e.g., for Keystone).
  • more effective / useful troubleshooting information (neutron troubleshooting in Ops Guide is the best of what's out there currently)
  • socialise info about RST and tox (as oposed to docbook and maven)

Actions

  • discuss the future of the OpsGuide
  • IMplement a post-publish job that copies/links/syndicates Ironic's in-tree ops guide to the admin-cloud-guide? Can we do something similar for every project?
  • Discuss with doc liaisons how to get docs assistance with docs in their repo, without bringing content into docs repo (maintenance overhead stays with dev, not doc)
  • Ensure tox is well-documented (seems to be little understood)
  • Grant core access to docs liaisons

Ops Documentation Workshop

API Docs Workshop

Blueprint Workshop

RST Migration Session

Team Structure Session

Information Architecture Session

Lessons Learned