Difference between revisions of "Documentation/WhatsUpDoc"
(→13 November 2015) |
(→Progress towards Mitaka) |
||
Line 74: | Line 74: | ||
100 bugs closed so far for this release. | 100 bugs closed so far for this release. | ||
− | |||
− | |||
− | |||
DocImpact | DocImpact |
Revision as of 04:10, 13 November 2015
Contents
Documentation Newsletters
This is where I draft the 'What's Up, Doc?' documentation newsletters. The newsletter is distributed every Friday (ish), to the openstack-docs mailing list. If you want to be added to the distribution list, or have content to add, please edit these sections:
Distribution List
- OpenStack Docs Mailing List <Openstack-docs@lists.openstack.org>
- OpenStack Development Mailing List <openstack-dev@lists.openstack.org>
- Docs liaisons (from https://wiki.openstack.org/wiki/CrossProjectLiaisons#Documentation)
- i18n List <openstack-i18n@lists.openstack.org>
Your suggestions for content
- Your
- Content
- Here
- https://wiki.openstack.org/wiki/Successes
Looking for older editions?
You can see older newsletters here: Documentation/WhatsUpDoc_Archive
13 November 2015
Hi everyone,
Well, things are starting to ramp up again after Summit.
This week, I've spent some time catching up with other PTLs, and also worked on my DocImpact spec. I've also implemented my plan to get the Speciality Team leads to provide content on their projects individually, so many thanks to them for replying with so much great info!
Speciality Teams
- HA Guide - Bogdan Dobrelya
Created a poll to shift HA guide IRC meeting time (http://lists.openstack.org/pipermail/openstack-docs/2015-November/007830.html). Submitted a status for HA guide testing (http://lists.openstack.org/pipermail/openstack-docs/2015-October/007718.html), hoping to see more participants in testing. Trying to push few patches, and initiated related discussion: https://review.openstack.org/#/c/225418/ and https://review.openstack.org/235893. Thinking on how to effectively collaborate with Adam Spiers and his Openstack HA initiative (http://lists.openstack.org/pipermail/openstack-dev/2015-November/079127.html) to benefit HA guide project as well.
- Installation Guide - Christian Berendt
Moved the team meeting from Google Hangout to IRC (online at http://eavesdrop.openstack.org/#Documentation_Install_Team_Meeting), we had our first team meeting on the IRC (http://eavesdrop.openstack.org/meetings/docinstallteam/2015/docinstallteam.2015-11-11-01.03.html), we discussed the inclusion of hypervisor specific appendixes, no consensus at the moment, really good progress on the Debian install guide, zigo is doing a good job.
- Networking Guide - Edgar Magana
We have a new spec for OVN: https://review.openstack.org/#/c/244367/ I am going to start pulling people into specific patches.
- Security Guide - Nathaniel Dillon
We have added a new chapter on Manila and have completed the reworking of the case studies.
- User Guides - Joseph Robinson
- Ops and Arch Guides - Shilla Saebi
The operations guide RST migration is on hold until we find out if we are going to move forward with docbook or RST. In the meantime we are looking to add content and update it. The architecture guide RST conversion is underway. The progress on chapters and pages can be checked via the wiki page: https://wiki.openstack.org/wiki/Documentation/Migrate
- API Docs - Anne Gentle
Russell Sim plans to revise the templates for developer.openstack.org landing page to better match docs.openstack.org. We'll also map out a plan for fairy-slipper and the WADL migration. Spec to be updated soon.
- Config Ref - Gauvain Pocentek
The initial structure for the Config Reference RST migration is up, the automation tools are ready to handle RST tables generation, and a couple pages have already been converted. We're waiting for the liberty branching to start pushing more converted pages.
- Training labs - Pranav Salunke
Added Kilo support, still under review but in final stages (https://review.openstack.org/#/c/237061/). Halfway through adding KVM support, will probably need more time. Other small things like fixing readmes etc. Still pending to decide IRC meeting time.
- Training Guides - Matjaz Pancur
Two new core reviewers: Kato Tomoyuki and Tim Freund. We also added a new policy for cores: current lead of Upstream training session (held before each Summit) is now part of the core team by function.
- Hyperviser Tuning Guide - Joe Topjian
All data from the past etherpads have been compiled onto the wiki (https://wiki.openstack.org/wiki/Documentation/HypervisorTuningGuide). My goal right now is to translate the raw notes into something more readable. Once the page starts to resemble a readable guide, I'll try to rally others to join in.
Progress towards Mitaka
145 days to go!
100 bugs closed so far for this release.
DocImpact
- I've removed the WIP from this blueprint, and will be working on this from next week: https://blueprints.launchpad.net/openstack-manuals/+spec/review-docimpact
RST Conversions
- Arch Guide
- https://blueprints.launchpad.net/openstack-manuals/+spec/archguide-mitaka-rst
- Contact the Ops Guide Speciality team: https://wiki.openstack.org/wiki/Documentation/OpsGuide
- Ops Guide
- https://blueprints.launchpad.net/openstack-manuals/+spec/ops-guide-rst
- Lana will reach out to O'Reilly to discuss the printed book before this work begins
- Config Ref
- Thanks for all the offers of help on this one! Please contact the Config Ref Speciality team: https://wiki.openstack.org/wiki/Documentation/ConfigRef
Reorganisations
- Arch Guide
- https://blueprints.launchpad.net/openstack-manuals/+spec/archguide-mitaka-reorg
- Contact the Ops Guide Speciality team: https://wiki.openstack.org/wiki/Documentation/OpsGuide
- User Guides
- https://blueprints.launchpad.net/openstack-manuals/+spec/user-guides-reorganised
- Contact the User Guide Speciality team: https://wiki.openstack.org/wiki/User_Guides
Training
- Labs
- Guides
- Upstream University & 'core' component updates, EOL Upstream Wiki page.
Document openstack-doc-tools
- Need volunteers for this!
Reorganise index page
- The API docs have already moved off the front page
- We need volunteers to look at the organisation of this page and to write one-sentence summaries of each book
Doc team meeting
Meetings will kick off again next week with the APAC meeting:
APAC: Wednesday 11 November, 00:30:00 UTC US: Wednesday 18 November, 14:00 UTC
Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting
--
Keep on doc'ing! Lana
6 November 2015
Hi everyone,
Wow! What a great Summit! And isn't Tokyo a truly beautiful and amazing city? Thank you so much to the Japanese Stackers who hosted us, and to everyone who came along to the docs sessions and helped us hammer out a great plan for Mitaka. I'm very excited about this release!
This week, I've been catching up with everything that happened during Summit, and also working on outreach tasks. Today, I recorded an interview with Foundation about the project, and I've also published a blog post on the same topic, which will be published soon. You might also like to check out the SuperUser interview Anne and I did about the docs while we were in Tokyo: http://superuser.openstack.org/articles/openstack-documentation-why-it-s-important-and-how-you-can-contribute
Progress towards Mitaka
152 days to go!
77 bugs closed so far for this release.
API Docs
- The API docs are will be switched to swagger: http://specs.openstack.org/openstack/docs-specs/specs/liberty/api-site.html
DocImpact
- I've removed the WIP from this blueprint, and will be working on this from next week: https://blueprints.launchpad.net/openstack-manuals/+spec/review-docimpact
RST Conversions
- Arch Guide
- https://blueprints.launchpad.net/openstack-manuals/+spec/archguide-mitaka-rst
- Contact the Ops Guide Speciality team: https://wiki.openstack.org/wiki/Documentation/OpsGuide
- Ops Guide
- https://blueprints.launchpad.net/openstack-manuals/+spec/ops-guide-rst
- Lana will reach out to O'Reilly to discuss the printed book before this work begins
- Config Ref
- Thanks for all the offers of help on this one! Please contact the Config Ref Speciality team: https://wiki.openstack.org/wiki/Documentation/ConfigRef
Reorganisations
- Arch Guide
- https://blueprints.launchpad.net/openstack-manuals/+spec/archguide-mitaka-reorg
- Contact the Ops Guide Speciality team: https://wiki.openstack.org/wiki/Documentation/OpsGuide
- User Guides
- https://blueprints.launchpad.net/openstack-manuals/+spec/user-guides-reorganised
- Contact the User Guide Speciality team: https://wiki.openstack.org/wiki/User_Guides
Training
- Labs
- Guides
- Upstream University & 'core' component updates, EOL Upstream Wiki page.
Document openstack-doc-tools
- Need volunteers for this!
Reorganise index page
- The API docs have already moved off the front page
- We need volunteers to look at the organisation of this page and to write one-sentence summaries of each book
Doc team meeting
Meetings will kick off again next week with the APAC meeting:
APAC: Wednesday 11 November, 00:30:00 UTC US: Wednesday 18 November, 14:00 UTC
Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting
--
Keep on doc'ing! Lana