Revision as of 11:34, 10 February 2017

Documentation Newsletters

This is where I draft the 'What's Up, Doc?' documentation newsletters. The newsletter is distributed every second 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>

Content Sources

Speciality team reports are gathered in the docs meeting every two weeks. If you are a speciality team leader and can't attend the meeting, please either send a proxy to the meeting, or email your report to the meeting chair ahead of time.

If you have something that you would like to add to the next newsletter, please add it here:

Looking for older editions?

You can see older newsletters here: Documentation/WhatsUpDoc_Archive

10 February 2017

Team team team team team,

Welcome to my first edition of What's up, Doc!

Firstly, I just want to thank everyone who supported me when I announced I would like to run for manuals PTL. Although I ran the election uncontested (like the beginning of all good dictatorships), it was wonderful to receive messages of support from everyone. So, thank you!

Now, let's get down to business! We have a very short window now between Ocata and the start of Pike, and we still have quite a number of things left to achieve. - If anyone has time to dedicate to Install Guide testing - please sign up (links below). Thanks to those who have already volunteered to help Lana out! - As per my email yesterday, I'd love to see some people out there smashing bugs!

Progress towards Ocata

12 days to go!
Closed 256 bugs so far. We have 128 open bugs left: https://bugs.launchpad.net/openstack-manuals/+bugs
Release tasks are being tracked here: https://wiki.openstack.org/wiki/Documentation/OcataDeliverables
Install Guide testing is being tracked here: https://wiki.openstack.org/wiki/Documentation/OcataDocTesting

The Road to PTG in Atlanta

Docs is a horizontal project, so our sessions will run across the Monday and Tuesday of the event. We will be combining the docs event with i18n, so translators and docs people will all be in the room together. Everyone welcome! Conversation topics for Docs and i18n here: https://etherpad.openstack.org/p/docs-i18n-ptg-pike

Event info is available here: http://www.openstack.org/ptg Purchase tickets here: https://pikeptg.eventbrite.com/ Tickets for the Boston summit: https://www.openstack.org/summit/boston-2017/

The CFP is now closed.

Speciality Team Reports

API - Anne Gentle: The trove API docs are incomplete after migration, and a user reported the bug to the ML. Anne to log the missing clustering API info. Alex and Anne to meet with the app dev community manager at the Foundation to talk about goals for developer.openstack.org. The NFV Orchestration (tacker) team landed their API ref this week. Configuration Reference and CLI Reference - Tomoyuki Kato: CLI Reference: Updated some CLI references. Added aodhclient. Config Reference: Start working on Ocata updates. High Availability Guide - Ianeta Hutchinson: Sent a message to the ML looking for people interested in helping out on the HA guide for Pike. Planning for the PTG as I can’t attend. Hypervisor Tuning Guide - Blair Bethwaite: N/A Installation guides - Lana Brindley: Landing page review: https://review.openstack.org/#/c/425821/12. Install guide testing is well underway. Networking Guide - John Davidge: Working on organising a Networking Guide working group with the neutron team at the PTG. Also been smashing bugs. Operations and Architecture Design guides - Darren Chan: Darren and Ben are working on an action plan for the Arch Guide to be worked on during Pike to get the current draft guide published. Security Guide - Nathaniel Dillon: Moved the sec-guide bugs to the sec team Launchpad. Sec and doc team to coordinate and come up with action plan for the future of the sec guide at the PTG. Training Guides - Matjaz Pancur: N/A Training labs - Pranav Salunke, Roger Luethi: Training-labs has a rough, but working Ocata patch. Issues we found are noted on the Etherpad as you requested. We should be able to release within a week or two after Ocata is official. User guides - Joseph Robinson: The legacy command changes have gone through well this release, and the next steps is to check with the nova, neutron, cinder, and glance teams on the status of some specific project commands

Doc team meeting

Our next meeting will be on Thursday 23 February at 2100 UTC in #openstack-meeting-alt

Meeting chair will be me (Alexandra Settle - asettle)! \o/

For more meeting details, including minutes and the agenda: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting

--

Have a great weekend!

Alex
All round badass and supernaturally good potato peeler

IRC: asettle
Twitter: dewsday

@@ Line 27: / Line 27: @@
 Firstly, I just want to thank everyone who supported me when I announced I would like to run for manuals PTL. Although I ran the election uncontested (like the beginning of all good dictatorships), it was wonderful to receive messages of support from everyone. So, thank you!
-Now, let's get down to business! We have a very short window now between Ocata and the start of Pike (2 weeks), and we still have quite a number of things left to achieve.
+Now, let's get down to business! We have a very short window now between Ocata and the start of Pike, and we still have quite a number of things left to achieve.
 - If anyone has time to dedicate to Install Guide testing - please sign up (links below). Thanks to those who have already volunteered to help Lana out!
 - As per my email yesterday, I'd love to see some people out there smashing bugs!
-== Commander's Report ==
-Other than plodding through my massive list of emails, I've been working on finding appropriate ways to deal with our continuously growing bug list. Step one? Deal with bug triaging. Up until this point we haven't really had an official way for bugs to be managed. So, what is hopefully one step in the right direction, for the Pike release we will have dedicated bug-triagers who will rotate on a bi-weekly basis. The roster can be found here: https://wiki.openstack.org/wiki/Documentation/SpecialityTeams#Bug_Triage_Team
-I've also been trying to find ways to deal with some of our guides that have higher technical debt than others. Here's some updates:
-. The Security team has agreed to join forces with us and discuss momentum going forward at the PTG. The bug tracking for the Security Guide bugs can now be found here: https://bugs.launchpad.net/ossp-security-documentation
-. The neutron team has agreed to working with John Davidge on the Networking Guide at the PTG. If anyone is interested in joining him in a working session, get in contact with him!  Big thanks to John who has smashed bugs this week lowering the Networking Guide bug count down to 12!
-. The HA guide is now in the hands of Ianeta Hutchison. Ianeta (OSIC) will be working on a best plan of attack with our SMEs Andrew Beekhof, Adam Spiers, and Ben Silverman. If anyone is interested in working on that team, let Ianeta (or me) know!
 == Progress towards Ocata ==
-* 15 days to go!
+* 12 days to go!
-* Closed 253 bugs so far. We have 139 open bugs left: https://bugs.launchpad.net/openstack-manuals/+bugs
+* Closed 256 bugs so far. We have 128 open bugs left: https://bugs.launchpad.net/openstack-manuals/+bugs
 * Release tasks are being tracked here: https://wiki.openstack.org/wiki/Documentation/OcataDeliverables
 * Install Guide testing is being tracked here: https://wiki.openstack.org/wiki/Documentation/OcataDocTesting
@@ Line 61: / Line 51: @@
 == Speciality Team Reports ==
-KATO Tomoyuki, CLI and Config Reference
+API - Anne Gentle: The trove API docs are incomplete after migration, and a user reported the bug to the ML. Anne to log the missing clustering API info. Alex and Anne to meet with the app dev community manager at the Foundation to talk about goals for developer.openstack.org. The NFV Orchestration (tacker) team landed their API ref this week.
-* CLI Reference: Updated some CLI references. Added aodhclient.
+Configuration Reference and CLI Reference - Tomoyuki Kato: CLI Reference: Updated some CLI references. Added aodhclient. Config Reference: Start working on Ocata updates.
-* Config Reference: Start working on Ocata updates.
+High Availability Guide - Ianeta Hutchinson: Sent a message to the ML looking for people interested in helping out on the HA guide for Pike. Planning for the PTG as I can’t attend.
+Hypervisor Tuning Guide - Blair Bethwaite: N/A
+Installation guides - Lana Brindley: Landing page review: https://review.openstack.org/#/c/425821/12. Install guide testing is well underway.
+Networking Guide - John Davidge: Working on organising a Networking Guide working group with the neutron team at the PTG. Also been smashing bugs.
+Operations and Architecture Design guides - Darren Chan: Darren and Ben are working on an action plan for the Arch Guide to be worked on during Pike to get the current draft guide published.
+Security Guide - Nathaniel Dillon: Moved the sec-guide bugs to the sec team Launchpad. Sec and doc team to coordinate and come up with action plan for the future of the sec guide at the PTG.
+Training Guides - Matjaz Pancur: N/A
+Training labs - Pranav Salunke, Roger Luethi: Training-labs has a rough, but working Ocata patch. Issues we found are noted on the Etherpad as you requested. We should be able to release within a week or two after Ocata is official.
+User guides - Joseph Robinson: The legacy command changes have gone through well this release, and the next steps is to check with the nova, neutron, cinder, and glance teams on the status of some specific project commands
 == Doc team meeting ==

Difference between revisions of "Documentation/WhatsUpDoc"