[openstack-dev] [docs][i18n][ptg] Stein PTG Summary
pkovar at redhat.com
Wed Sep 19 23:37:03 UTC 2018
Just wanted to share a summary of docs- and i18n-related meetings
and discussions we had in Denver last week during the Stein Project
The overall schedule for all our sessions with additional comments and
meeting minutes can be found here:
Our obligatory team picture (with quite a few members missing) can be
found here (courtesy of Foundation folks):
To summarize what I found most important:
We met with the Ops community to discuss the future of Ops docs. The plan
is for the Ops group to take ownership of the operations-guide (done),
ha-guide (in progress), and the arch-design guide (to do).
These three documents are being moved from openstack-manuals to their own
repos, owned by the newly formed Operations Documentation SIG.
for more notes.
DOCS SITE & DESIGN
We discussed improving the site navigation, guide summaries (particularly
install-guide), adding a new index page for project team contrib guides, and
more. We met with the Foundation staff to discuss the possibility of getting
assistance with site design work.
We are also looking into accepting contributions from the Strategic Focus
Areas folks to make parts of the docs toolchain like openstackdocstheme more
easily reusable outside of the official OpenStack infrastructure.
We got feedback on front page template for project team docs, with Ironic
being the pilot for us.
We got input on restructuring and reworking specs site to make it easier
for users to understand that specs are not feature descriptions nor project
docs, and to make it more consistent in how the project teams publish their
specs. This will need to be further discussed with the folks owning the
specs site infra.
Support status badges showing at the top of docs.o.o pages may not work well
for projects following the cycle-with-intermediary release model, such as
Swift. We need to rethink how we configure and present the badges.
There are also some UX bugs present for the badges
We met with the infra team to discuss progress on translating project team
docs and, related to that, PDF builds.
With the Foundation staff, we discussed translating Edge and Container
whitepapers and related material.
REFERENCE, REST API DOCS AND RELEASE NOTES
With the QA team, we discussed the scope and purpose of the
/doc/source/reference documentation area in project docs. Because the
scope of /reference might be unclear and used inconsistently by project
teams, the suggestion is to continue with the original migration plan and
migrate REST API and possibly Release Notes under /doc/source, as described
The OpenStack Contributor Guide was discussed in a separate session, see
https://etherpad.openstack.org/p/FC_SIG_ptg_stein for notes.
Please add to the list if I missed anything important, particularly for
Thank you to everybody who attended the sessions, and a special thanks goes
to all the PTG organizers!
More information about the OpenStack-dev