Jump to: navigation, search

Difference between revisions of "Documentation/WhatsUpDoc"

(Your suggestions for content)
m
 
(401 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
= Documentation Newsletters =
 
= 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:
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 ====
 
==== Distribution List ====
* OpenStack Docs Mailing List <Openstack-docs@lists.openstack.org>
 
 
* OpenStack Development Mailing List <openstack-dev@lists.openstack.org>
 
* OpenStack Development Mailing List <openstack-dev@lists.openstack.org>
 
* Docs liaisons (from https://wiki.openstack.org/wiki/CrossProjectLiaisons#Documentation)
 
* Docs liaisons (from https://wiki.openstack.org/wiki/CrossProjectLiaisons#Documentation)
 
* i18n List <openstack-i18n@lists.openstack.org>
 
* i18n List <openstack-i18n@lists.openstack.org>
  
==== Your suggestions for content ====
+
==== Content Sources ====
* Add
 
* Your
 
* Content
 
* Here
 
 
 
* openstackdocstheme 1.1.0 was released, see http://lists.openstack.org/pipermail/openstack-announce/2015-June/000392.html. Main features: Improvements for bug reporting, variable lists like the glossary are now indented. Next/prev links have been improved.
 
 
 
= 26 June 2015 =
 
 
 
Hi everyone,
 
 
 
First of all, our M release has been named! Sadly, it hasn't cleared legal yet, so we can't publicly announce it, however, here are the poll results: http://civs.cs.cornell.edu/cgi-bin/results.pl?id=E_4983776e190c8dbc It was a close-run contest!
 
 
 
This week, I've been continuing to dust off some old bugs, and have been chatting to a few of our docs liaisons to work out how we can best get them engaged with what we're working on. I've also been spending a lot of time on standards questions, and thinking about the future of the DocImpact flag.
 
 
 
== Progress towards Liberty ==
 
 
 
* RST conversion:
 
** Install Guide: Conversion is now ready to start, sign up here: https://wiki.openstack.org/wiki/Documentation/Migrate#Installation_Guide_Migration
 
** Cloud Admin Guide: is chugging along. Sign up here: https://wiki.openstack.org/wiki/Documentation/Migrate#Cloud_Admin_Guide_Migration
 
** HA Guide: is also underway. Get in touch with Meg or Matt: https://wiki.openstack.org/wiki/Documentation/HA_Guide_Update
 
** Security Guide: In planning. Stand by for more info.
 
 
 
* User Guides information architecture overhaul
 
** Waiting on the RST conversion of the Cloud Admin Guide to be complete
 
 
 
* Greater focus on helping out devs with docs in their repo
 
** Work has started on the Ironic docs, we're now trying to resolve some issues with service name standards ("Bare Metal" or "Bare metal"?). Contact me if you want to know more, or are willing to help out.
 
 
 
* Improve how we communicate with and support our corporate contributors
 
** No progress this week
 
 
 
* Improve communication with Docs Liaisons
 
** I'm very pleased to see liaisons getting more involved in our bugs and reviews. Keep up the good work!
 
 
 
* Clearing out old bugs
 
** Thanks to Yusuke-san for closing bug 1330005!
 
 
 
== RST Migration ==
 
  
The next books we are focusing on for RST conversion are the Install Guide, Cloud Admin Guide, HA Guide, and the Security Guide. If you would like to assist, please get in touch with the appropriate speciality team:
+
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.
  
* Install Guide:
+
If you have something that you would like to add to the next newsletter, please add it here:
** Contact Karin Levenstein <karin.levenstein@rackspace.com>
 
** Sign up here: https://wiki.openstack.org/wiki/Documentation/Migrate#Installation_Guide_Migration
 
  
* Cloud Admin Guide:
+
*  
** Contact Brian Moss <kallimachos@gmail.com> & Joseph Robinson <joseph.r.email@gmail.com>
 
** Sign up to help out here: https://wiki.openstack.org/wiki/Documentation/Migrate#Cloud_Admin_Guide_Migration
 
  
* HA Guide
+
==== Looking for older editions? ====
** Contact Meg McRoberts <dreidellhasa@yahoo.com> or Matt Griffin <me@mattgriffin.com>
+
You can see older newsletters here: [[Documentation/WhatsUpDoc_Archive]]
** Blueprint: https://blueprints.launchpad.net/openstack-manuals/+spec/improve-ha-guide
 
  
* Security Guide
+
= 7 April 2017 =
** Contact Nathaniel Dillon <nathaniel.dillon@hp.com>
 
** Bug: https://bugs.launchpad.net/openstack-manuals/+bug/1463111
 
** Blueprint+Spec: TBD
 
  
For books that are now being converted, don't forget that any change you make to the XML must also be made to the RST version until conversion is complete. Our lovely team of cores will be keeping an eye out to make sure loose changes to XML don't pass the gate, but try to help them out by pointing out both patches in your reviews.
+
Team,
  
== Docs Tools ==
+
This week I have still been working on drafting a governance tag for our guides called "docs:follows-policy". I have been working with Doug Hellmann (dhellmann) in the last week to change to draft dramatically, so it would be good for docs people to review again. We are trying to make this a more broad tag now, so it can be applied for other guides too. To review: https://review.openstack.org/#/c/445536/ I am also in the process of documenting guidelines in our Contribution Guide - which would also benefit from doc reviews:  https://review.openstack.org/#/c/453642/
  
Andreas and Nick just released openstack-docs-tools 0.29.1, after we discovered an RST translation bug in 0.29. Thanks for the quick turnaround on that!
+
Would like to call out and thank John Davidge for his awesome work with the Networking Guide and neutron-related patches. He's been providing valuable guidance, and reviews, and it has been greatly appreciated by myself and the team.
  
== Documentation Standards ==
+
Lana Brindley has done an awesome job for the last two weeks in keeping our bug list under control. We are down to an amazing 102 bugs in queue, and 82 bugs closed this cycle already!
 +
Next week, I will be looking after the bug triage liaison role!
 +
If you're sitting there thinking "bugs are for me, I really love triaging bugs!" well, you're in luck! We have one spot open for the rest of the cycle (14 Aug - 28 Aug): https://wiki.openstack.org/wiki/Documentation/SpecialityTeams#Bug_Triage_Team
  
There's been quite a lot of conversation this week over capitalisation of service names, with the community divided down the middle as to which we prefer! While we all enjoy a good style discussion, I've also asked Anne (in her role on the TC) to confirm the legal restrictions for us. Watch this space! In the meantime, continue to discuss this on the mailing list :) 
+
== The Road to the Summit in Boston ==
  
== Docs Liaisons ==
+
Keep an eye out for the docs and I18n have a project onboarding room at the summit. Melvin Hillsman (mrhillsman) of the User Committee submitted a forum topic for the Ops Guide to get operator feedback.
 +
David Flanders from the Foundation has also proposed a forum topic for developer.openstack.org (which currently houses our API, SDK, and other dev stuff). We'll be discussing major changes to that and would like to see some feedback from people here. Any questions on that, shoot it my way. My main objective for this forum topic is to reduce our current technical debt that lives on this site.
 +
For more information on forum topics: https://wiki.openstack.org/wiki/Forum
 +
Schedule has been released: https://www.openstack.org/summit/boston-2017/summit-schedul
  
Don't forget that we have subject matter experts to help you with documentation questions that you might have. One of the best ways to get our liaisons' attention is to add them to a bug or a patch. Feel free to look up the liaison for the project you're working with, and add them to the cc list for your patch:
+
== Speciality Team Reports ==
  
https://wiki.openstack.org/wiki/CrossProjectLiaisons#Documentation
+
* API - Anne Gentle: API versioning in relation to release versioning is currently manually compiled for the 40-ish API services, so ideas on how to automate and surface that info welcomed. More info: http://lists.openstack.org/pipermail/openstack-dev/2017-March/114690.html
 +
* Configuration Reference and CLI Reference - Tomoyuki Kato: N/A
 +
* High Availability Guide - Ianeta Hutchinson: We are continuing to collaborate with OS DevOps team. See the tag ha-guide-draft for bugs opened to fill content for the new guide.
 +
* Hypervisor Tuning Guide - Blair Bethwaite: N/A
 +
* Installation guides - Lana Brindley: We have now branched, so please remember to backport if you have edits to the Ocata guide now. Big thanks to all the testers who have been working hard over the past month or two (that Nova cells bug was *tough*!), and to Brian and Mariia for doing the heavy lifting. Noticed a bunch links to draft versions of the guide in Newton/Ocata branches, backports for that have been merged, and the Contributor Guide updated so we don't miss it in the future (https://docs.openstack.org/contributor guide/release/taskdetail.html#update-links-in-all-books).
 +
* Networking Guide - John Davidge: More patches landed in the last couple of weeks dealing with the move to OSC, and more are still in flight. Progress also continues on RFC 5737 compliance. Thanks to all contributors for their work.
 +
* Operations and Architecture Design guides - Darren Chan: Arch Guide: edited architecture considerations content and cleaned up the index page structure which was applied across OS manuals. Some ops-related content was moved to the Ops Guide. Our current focus is improving the storage design content and networking design content.
 +
* Training Guides - Matjaz Pancur: N/A
 +
* Training labs - Roger Luethi: We released the Ocata version of training-labs this week.
 +
* User guides - Joseph Robinson: For the user guides - the spec on migrating the Admin Guide content this week moved closer to merging. I started preparing the work items for action on the User Guides tasks wiki page.
 +
* Theme and Tools - Brian Moss: Anne has a spec up for theme consolidation, please check it out: https://review.openstack.org/#/c/454346/, Brian has fixed up the sitemap tool tests, reviews welcome: https://review.openstack.org/#/c/453976/. 41 open bugs, 13 closed in Pike
  
 
== Doc team meeting ==
 
== Doc team meeting ==
 +
 +
Our next meeting will be on Thursday, 20 April at 2100 UTC in #openstack-meeting-alt.
 +
For more meeting details, including minutes and the agenda: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting
 +
The meeting chair will be me!
  
The APAC meeting was held this week, see the minutes here to catch up:
+
Big thanks to Joseph for stepping up in the last 2 meetings and hosting in my absence! Really appreciated it :)
https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-06-24
 
 
 
Next meetings are:
 
US: Wednesday 1 July, 14:00:00 UTC (note that this has NOT changed with daylight savings time)
 
APAC: Wednesday 8 July, 00:30: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
 
 
 
== Spotlight bugs for this week ==
 
 
 
Of the three bugs we spotlighted last week, one of them was closed (thanks Yusuke-san!), and the other two are still up for grabs. Olga is working on a Spotlight bug from last week, too. Let's keep the momentum, with another three sad old bugs that could use some love:
 
 
 
https://bugs.launchpad.net/openstack-manuals/+bug/1212349 vmware documentation
 
 
 
https://bugs.launchpad.net/openstack-manuals/+bug/1212687 xenapi
 
 
 
https://bugs.launchpad.net/openstack-manuals/+bug/1239308 Add notifications for groups and roles
 
  
 
--
 
--
 +
 +
Have a great week :)
 +
 +
Alex
  
Remember, if you have content you would like to add to this newsletter, or you would like to be added to the distribution list, please email me directly at openstack@lanabrindley.com, or visit: https://wiki.openstack.org/w/index.php?title=Documentation/WhatsUpDoc
+
IRC: asettle
 
+
Twitter: dewsday
Keep on doc'ing!
 
 
 
Lana
 
 
 
= 19 June 2015 =
 
 
 
Hi everyone,
 
 
 
This week, I've been working on helping out the Ironic team to sort out their Install Guide (thanks have to go to Gauvain and Nick, who have offered to help out with writing assistance here), and trying to come up with some better ways to work with the i18n team, and our docs liaisons. More on all of that further in.
 
 
 
== Progress towards Liberty ==
 
 
 
* RST conversion:
 
** Install Guide: Spec is merged, stand by for conversion to start
 
** Cloud Admin Guide: is well on the way. Get in touch with Brian or Joe, or sign up here: https://wiki.openstack.org/wiki/Documentation/Migrate#Cloud_Admin_Guide_Migration
 
** HA Guide: is also underway. Get in touch with Meg or Matt: https://wiki.openstack.org/wiki/Documentation/HA_Guide_Update
 
** Security Guide: In planning. Stand by for more info.
 
 
 
* User Guides information architecture overhaul
 
** Waiting on the RST conversion of the Cloud Admin Guide to be complete
 
 
 
* Greater focus on helping out devs with docs in their repo
 
** We now have a team starting to form to work on Ironic docs. Contact me if you want to know more, or are willing to help out.
 
 
 
* Improve how we communicate with and support our corporate contributors
 
** No progress this week
 
 
 
* Improve communication with Docs Liaisons
 
** I have now reached out to liaisons. More later in this newsletter.
 
 
 
* Clearing out old bugs
 
** Thanks to Tom for closing bug 1195875. Let's keep up the great work!
 
 
 
== RST Migration ==
 
 
 
The next books we are focusing on for RST conversion are the Install Guide, Cloud Admin Guide, HA Guide, and the Security Guide. If you would like to assist, please get in touch with the appropriate speciality team:
 
  
* Install Guide:
+
= 27 March 2017 =
** Contact Karin Levenstein <karin.levenstein@rackspace.com>
 
** Spec: https://review.openstack.org/#/c/183138/
 
** Watch this space: https://wiki.openstack.org/wiki/Documentation/Migrate#Installation_Guide_Migration
 
  
* Cloud Admin Guide:
+
Team team team team team,
** Contact Brian Moss <kallimachos@gmail.com> & Joseph Robinson <joseph.r.email@gmail.com>
 
** Blueprint: https://blueprints.launchpad.net/openstack-manuals/+spec/reorganise-user-guides
 
** Sign up to help out here: https://wiki.openstack.org/wiki/Documentation/Migrate#Cloud_Admin_Guide_Migration
 
  
* HA Guide
+
Well the last month has just FLOWN by since the PTG. We've got plenty going on in the docs team...
** Contact Meg McRoberts <dreidellhasa@yahoo.com> or Matt Griffin <me@mattgriffin.com>
 
** Blueprint: https://blueprints.launchpad.net/openstack-manuals/+spec/improve-ha-guide
 
  
* Security Guide
+
This week I have been helping out the security team with the Security Guide. We've been working on some cursory edits, and removal of content. A few patches have already made it through - thanks to the OSIC security team for tackling some of the outstanding bugs. There'll be more edits coming from me in the next few weeks. To see our planning: https://etherpad.openstack.org/p/sec-guide-pike
** Contact Nathaniel Dillon <nathaniel.dillon@hp.com>
+
I am also in the process of drafting a governance tag for our install guides. Would be great for everyone to review and understand what the process will involve: https://review.openstack.org/#/c/445536/
** Bug: https://bugs.launchpad.net/openstack-manuals/+bug/1463111
 
** Blueprint+Spec: TBD
 
  
For books that are now being converted, don't forget that any change you make to the XML must also be made to the RST version until conversion is complete. Our lovely team of cores will be keeping an eye out to make sure loose changes to XML don't pass the gate, but try to help them out by pointing out both patches in your reviews.
+
Shoutout and big thanks to Brian Moss and the nova team who worked together tirelessly to document Nova v2 Cells and Placement API - which was a massive blocker for our Installation Guide.
  
== Docs Tools ==
+
Also, thank you to our Ocata release managers, Maria Zlatkova and Brian Moss for cutting the branch! Pike is well and truly underway now.
  
Andreas will shortly be updating openstack-docs-tools to 0.29.
+
Ianeta Hutchinson has done an awesome job for the last two weeks in keeping our bug list under control. We are down to an amazing 104 bugs in queue, and 59 bugs closed this cycle already!
  
== Docs Liaisons ==
+
Next week, we have Lana who will be looking after the bug triage liaison role!
 +
If you're sitting there thinking "bugs are for me, I really love triaging bugs!" well, you're in luck! We have a few spots open for the rest of the cycle: https://wiki.openstack.org/wiki/Documentation/SpecialityTeams#Bug_Triage_Team
  
Don't forget that we have subject matter experts to help you with documentation questions that you might have. As you're working on bugs, feel free to give them a quick ping or an email to ask questions. They promise not to laugh at you!
+
== The Road to the Summit in Boston ==
  
https://wiki.openstack.org/wiki/CrossProjectLiaisons#Documentation
+
* Schedule has been released: https://www.openstack.org/summit/boston-2017/summit-schedule/
 +
* Docs and I18n have a project onboarding room at the summit, keep an eye out on the dev ML for more information. Kendall will inform us when the time comes. Anyone around to help me with that? http://lists.openstack.org/pipermail/openstack-dev/2017-March/114149.html
 +
* Docs project update will be delivered by me (asettle) on Mon 8 , 3:40pm-4:20pm. https://www.openstack.org/summit/boston-2017/summit-schedule/global-search?t=Alexandra+Settle
  
== i18n Team ==
+
== Speciality Team Reports ==
  
At Summit, I spent a lot of time with Ying Chun Guo (Daisy) from the translation team, to try and come up with a way we can make sure our teams are working together better. To that end, we've got a few ideas we're going to be implementing over the next few weeks. First of all, this newsletter now goes direct to the the translation mailing list, as well the dev and doc lists (hi translators!). Secondly, Daisy is going to poll her team to identify an i18n documentation liaison, who will be the go-to person for all questions about translation for docs. The other thing we're going to do is to make sure we're helping the i18n team to keep their status page up to date: https://wiki.openstack.org/wiki/I18nTeam/docs-translation#Document_categorize If you're working on a doc that is translated, please check that table and make sure the translation team know what you're up to! This will help prevent needless effort on their part, which benefits us all in the end.
+
* API - Anne Gentle: There's still a lot of discussion on https://review.openstack.org/#/c/421846/ which is about API change guidelines. Take a look and join in on the review. Also on the openstack-dev list, there's a thread about the future of the app catalog, which is relevant to the app developer audience so I include it here: http://lists.openstack.org/pipermail/openstack dev/2017-March/113362.html Also related to the app dev audience is the wrapping up of the App Ecosystem working group: http://lists.openstack.org/pipermail/user-committee/2017-March/001825.html
 +
* Configuration Reference and CLI Reference - Tomoyuki Kato: N/A
 +
* High Availability Guide - Ianeta Hutchinson: At the Atlanta PTG, the documentation team outlined a new table of contents that is now upstream as a draft here: https://github.com/openstack/openstack-manuals/tree/master/doc/ha-guide-draft. A blocker to progress in the past had been a lack of SME’s for the topic of high availability but that is no longer the case \o/. The OSIC DevOps team has an “adopt-a-guide” project in which they are collaborating with the OpenStack docs community and OSIC Docs team to apply the new ToC and validate all content for the guide. The progress of this collaboration is being tracked here <https://docs.google.com/spreadsheets/d/1hw4axU2IbLlsjKpz9_EGlKQt0S6siViik7ETjNg_MgI/edit?usp=sharing> We are calling for more contributors both as SME's and tech writers. Ping iphutch if interested!
 +
* Hypervisor Tuning Guide - Blair Bethwaite: N/A
 +
* Installation guides - Lana Brindley: Cells bug is closer to being fixed, and we are closer to a complete test install (https://wiki.openstack.org/wiki/Documentation/NewtonDocTesting look at all that green!). We're planning to branch Ocata by the end of this week.
 +
* Networking Guide - John Davidge: N/A
 +
* Operations and Architecture Design guides - Darren Chan: Arch Design Guide: Minor IA and general cleanup of the storage, compute, and networking sections in the Design chapter. Currently updating gaps in storage design content. Ops Guide: Removed cloud architecture content (migrated to the Arch Design Guide).
 +
* Security Guide - Nathaniel Dillon: Edits from Alex going through, and patches from the OSIC DevOps team. See above for more info.
 +
* Training Guides - Matjaz Pancur: For Training guides related topics: a new brand for activities around OpenStack Upstream University/Training. It is now known as OpenStack Upstream Institute (https://wiki.openstack.org/wiki/OpenStack_Upstream_Institute)
 +
* Training labs - Roger Luethi: We are currently testing our automated version of the Ocata install-guide. We had a problem with Ubuntu's new ISO image (16.04.2 LTS) which is now resolved.
 +
* User guides - Joseph Robinson: Several other Legacy commands were converted to OS commands this week. Reviewed the Admin Guide spec.
 +
* Theme and Tools - Brian Moss: I'd like to do an openstackdocstheme release soon, as we've got some items (PDF styling, search page JS fix, image centering) that would be good to have in production. Any concerns or last minute items to merge please let me know. We've had some issues come up with the auto-generation scripts. Some have been fixed already (thanks Kato and Christian!), and we're investigating others. If you notice anything amiss or would like to help out, please let me know. 46 open bugs, 8 closed in Pike
  
 
== Doc team meeting ==
 
== Doc team meeting ==
 
+
The US meeting was held this week, see the minutes here to catch up:
+
Our next meeting will be on Thursday, 7 April at 2100 UTC in #openstack-meeting-alt.
https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-06-17
+
For more meeting details, including minutes and the agenda: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting
 
 
Apologies for the timing confusion on that one, it seems as though daylight savings changes took us by surprise. For now, the meeting will remain at 1400UTC. If you would prefer it to be at a different time, bring it up on the mailing list, or in the next US meeting.
 
 
 
Next meetings are:
 
APAC: Wednesday 24 June, 00:30:00 UTC
 
US: Wednesday 1 July, 14:00: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
 
 
 
== Spotlight bugs for this week ==
 
 
 
Of the three bugs we spotlighted last week, one of them got marked as invalid (thanks Tom!), and another is in progress with SME assistance (thanks Olga!). That's great! Here's another three dusty old bugs that could use a polish up:
 
 
 
https://bugs.launchpad.net/openstack-manuals/+bug/1330005 Glance image properties and values (low hanging fruit)
 
 
 
https://bugs.launchpad.net/openstack-manuals/+bug/1394397 Nova notification_driver
 
 
 
https://bugs.launchpad.net/openstack-manuals/+bug/1205402 iPXE ISO boot support
 
  
 
--
 
--
 +
 +
Have a great week :)
 +
 +
Alex
  
Remember, if you have content you would like to add to this newsletter, or you would like to be added to the distribution list, please email me directly at openstack@lanabrindley.com, or visit: https://wiki.openstack.org/w/index.php?title=Documentation/WhatsUpDoc
+
IRC: asettle
 
+
Twitter: dewsday
Keep on doc'ing!
 
 
 
Lana
 
 
 
= 12 June 2015 =
 
 
 
Hi everyone,
 
 
 
This week, I've been spending some time in the dustier corners of our bug list. Do you know we currently have over 500 bugs open?! Scroll down to the bottom of this newsletter for more on what we're going to do about that.
 
 
 
If you have content you would like to add, or you would like to be added to the distribution list, please email me directly at openstack@lanabrindley.com. If you want to see my early drafts and typos, or check on old newsletters, you can do so here: https://wiki.openstack.org/w/index.php?title=Documentation/WhatsUpDoc
 
 
 
== Progress towards Liberty ==
 
 
 
* RST conversion:
 
** Install Guide: Spec is merged, stand by for conversion to start
 
** Cloud Admin Guide: has been started! Get in touch with Brian or Joe, or sign up here: https://wiki.openstack.org/wiki/Documentation/Migrate#Cloud_Admin_Guide_Migration
 
** HA Guide: is also underway! Get in touch with Meg or Matt: https://wiki.openstack.org/wiki/Documentation/HA_Guide_Update
 
** Security Guide: the security team are also converting the Security Guide for this release. Stand by for more info.
 
* User Guides information architecture overhaul
 
** Waiting on the RST conversion of the Cloud Admin Guide to be complete
 
* Greater focus on helping out devs with docs in their repo
 
** Discussion with the Ironic team was started this week. We need a Speciality Team to take on this work.
 
* Improve how we communicate with and support our corporate contributors
 
** No progress this week
 
* Improve communication with Docs Liaisons
 
** The current list of liaisons is available here: https://wiki.openstack.org/wiki/CrossProjectLiaisons#Documentation
 
** I will be contacting liaisons shortly to discuss ways to improve
 
* Clearing out old bugs
 
** I went through and pruned a lot of two- and three-year old bugs from the list. Please review and re open any you think still require tracking.
 
** As part of this effort, I will be picking out a few old bugs to be spotlighted in each newsletter. Please take a look as they come up and see what you can do to help!
 
 
 
== RST Migration ==
 
 
 
The next books we are focusing on for RST conversion are the Install Guide, Cloud Admin Guide, HA Guide, and the Security Guide. If you would like to assist, please get in touch with the appropriate speciality team:
 
 
 
* Install Guide:
 
** Contact Karin Levenstein <karin.levenstein@rackspace.com>
 
** Spec: https://review.openstack.org/#/c/183138/
 
** Watch this space: https://wiki.openstack.org/wiki/Documentation/Migrate#Installation_Guide_Migration
 
 
 
* Cloud Admin Guide:
 
** Contact Brian Moss <kallimachos@gmail.com> & Joseph Robinson <joseph.r.email@gmail.com>
 
** Blueprint: https://blueprints.launchpad.net/openstack-manuals/+spec/reorganise-user-guides
 
** Sign up to help out here: https://wiki.openstack.org/wiki/Documentation/Migrate#Cloud_Admin_Guide_Migration
 
 
 
* HA Guide
 
** Contact Meg McRoberts <dreidellhasa@yahoo.com> or Matt Griffin <me@mattgriffin.com>
 
** Blueprint: https://blueprints.launchpad.net/openstack-manuals/+spec/improve-ha-guide
 
 
 
* Security Guide
 
** Contact Nathaniel Dillon <nathaniel.dillon@hp.com>
 
** Bug: https://bugs.launchpad.net/openstack-manuals/+bug/1463111
 
** Blueprint+Spec: TBD
 
 
 
For books that are now being converted, don't forget that any change you make to the XML must also be made to the RST version until conversion is complete. Our lovely team of cores will be keeping an eye out to make sure loose changes to XML don't pass the gate, but try to help them out by pointing out both patches in your reviews.
 
 
 
== RST Common Files ==
 
 
 
We're coming across some build issues in the RST books with common files. If you have a common file in the ToC of a guide, please move it into the source file of that guide to prevent build issues. Using :orphan: directive marking on the file can also prevent sphinx marking the doc as an error.
 
 
 
== Bug triaging ==
 
 
 
This week, the core team have noticed a lot of patches that have had to be cancelled, because they were fixing untriaged bugs. If you want to work on a bug, be sure that a core reviewer has triaged it before you create a patch. This will stop you spending time on patches that might not get accepted. We should now have core team available in most timezones, so if you need a bug looked at so you can get started quickly, ping the docs IRC channel, and a core should be around to help you out.
 
 
 
== Doc team meeting ==
 
 
 
The APAC meeting was held this week, see the minutes here to catch up:
 
https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-06-10
 
 
 
Next meetings are:
 
US: Wednesday 17 June, 14:00:00 UTC
 
APAC: Wednesday 24 June, 00:30: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
 
 
 
== Spotlight bugs for this week ==
 
 
 
This is a way of trying to get some eyeballs on old bugs, in an attempt to pay down some of our technical debt. Kudos to Tom Fifield who helped me work out what to do about them! Each week, I'll spotlight a few old bugs here for people to go and look at and determine if they're still valid or not. Please check out these bugs, let's have a conversation (in the bug comments), and if you can close them, do so! To make this slightly more exciting, I'll be attempting to keep track of who is closing these old bugs, and will see if I can't put together a little care package to send the way of anyone who makes a real difference here.
 
 
 
https://bugs.launchpad.net/openstack-manuals/+bug/1195875 Controller Callbacks
 
 
 
https://bugs.launchpad.net/openstack-manuals/+bug/1201978 Pluggable Remote User
 
 
 
https://bugs.launchpad.net/openstack-manuals/+bug/1204566 Stop and delete operations
 
 
 
 
 
Keep on doc'ing!
 
 
 
Lana
 
 
 
= 5 June 2015 =
 
 
 
Hi everyone,
 
 
 
With our Kilo branch now cut, we're running headlong into the Liberty development cycle! And don't forget to have your say on what the M release should be called: https://wiki.openstack.org/wiki/Release_Naming/M_Proposals
 
 
 
If you have content you would like to add, or you would like to be added to the distribution list, please email me directly at openstack@lanabrindley.com. I've also decided to start drafting these 'in the open' (as it were). If you want to see my early drafts and typos, or check on old newsletters, you can do so here: https://wiki.openstack.org/w/index.php?title=Documentation/WhatsUpDoc
 
 
 
== Progress towards Liberty ==
 
 
 
* RST conversion:
 
** Install Guide: there's now a spec awaiting review: https://review.openstack.org/#/c/183138/
 
** Cloud Admin Guide: has been started! Get in touch with Brian or Joe, or sign up here: [[https://wiki.openstack.org/wiki/Documentation/Migrate#Cloud_Admin_Guide_Migration]]
 
** HA Guide: is also underway! Get in touch with Meg or Matt: https://wiki.openstack.org/wiki/Documentation/HA_Guide_Update
 
* User Guides information architecture overhaul
 
** Waiting on the RST conversion of the Cloud Admin Guide to be complete
 
* Greater focus on helping out devs with docs in their repo
 
** No progress this week
 
* Improve how we communicate with and support our corporate contributors
 
** I met with Alison of Oracle to discuss how we can help out their team
 
* Improve communication with Cross Team Liaisons
 
** The current list of liaisons is available here: https://wiki.openstack.org/wiki/CrossProjectLiaisons#Documentation
 
** I will be contacting CPLs shortly to discuss ways to improve
 
 
 
== Kilo Branching ==
 
 
 
Thanks to Andreas, Anne, and Tom for getting the Stable/Kilo branch completed this week. With this, Kilo is now complete* and patches for the Install Guide and the Config Reference will now be against Liberty unless you specifically backport a change to Kilo. You can do this by committing to master with the line ''Backport: Kilo'' in your commit message. Remember that all other book are continuously integrated, and this isn't necessary.
 
 
 
[*] Anne: feel free to go have a lie down ;)
 
 
 
== RST Migration ==
 
 
 
The next books we are focusing on for RST conversion are the Install Guide, Cloud Admin Guide, and the HA Guide. If you would like to assist, please get in touch with the appropriate speciality team.
 
 
 
* Install Guide:
 
** Contact Karin Levenstein <karin.levenstein@rackspace.com>
 
** Blueprint: https://blueprints.launchpad.net/openstack-manuals/+spec/installguide-liberty
 
** Spec WIP: https://review.openstack.org/#/c/183138/
 
 
 
* Cloud Admin Guide:
 
** Contact Brian Moss <kallimachos@gmail.com> & Joseph Robinson <joseph.r.email@gmail.com>
 
** Blueprint: https://blueprints.launchpad.net/openstack-manuals/+spec/reorganise-user-guides
 
** Sign up to help out here: https://wiki.openstack.org/wiki/Documentation/Migrate#Cloud_Admin_Guide_Migration
 
 
 
* HA Guide
 
** Contact Meg McRoberts <dreidellhasa@yahoo.com> or Matt Griffin  <matt.griffin@percona.com>
 
** Blueprint: https://blueprints.launchpad.net/openstack-manuals/+spec/improve-ha-guide
 
 
 
 
 
For books that are now being converted, don't forget that any change you make to the XML must also be made to the RST version until conversion is complete. Our lovely team of cores will be keeping an eye out to make sure loose changes to XML don't pass the gate, but try to help them out by pointing out both patches in your reviews.
 
 
 
== New Core Reviewer Process ==
 
 
 
We did our first monthly round of Core Team review this week, and would like to welcome our newest core team member, Darren Chan. We also bid a fond farewell to Summer Long and Bryan Payne, who have been great core team members and contributors, but have now moved on to other adventures. We sincerely thank them both for their commitment over the time they were core.
 
 
 
The new core process is documented here: https://wiki.openstack.org/wiki/Documentation/HowTo#Achieving_core_reviewer_status The next round will be around 1 July.
 
 
 
== Doc team meeting ==
 
 
 
The US meeting was held this week, see the minutes here to catch up:
 
https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-06-03
 
 
 
Thanks Shilla for running the US team meeting!
 
 
 
Next meetings are:
 
APAC: Wednesday 10 June, 00:30:00 UTC
 
US: Wednesday 17 June, 14:00: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
 
 
 
Thanks!
 
Lana
 
 
 
 
 
 
 
= 29 May 2015 =
 
 
 
Hi everyone,
 
 
 
Continuing in Anne's fine tradition, I intend to send these out every Friday. If you have content you would like to add, or you would like to be added to the distribution list, please email me directly at openstack@lanabrindley.com. I've also decided to start drafting these 'in the open' (as it were). If you want to see my early drafts and typos, or check on old newsletters, you can do so here: https://wiki.openstack.org/w/index.php?title=Documentation/WhatsUpDoc
 
 
 
== Design Summit ==
 
 
 
The Design Summit was a great success. We had ten sessions for docs overall, including two workgroups and a contributors' meetup. Thanks to everyone who came along (or participated remotely!) and had their say on the Liberty release. I've been spending time gathering my thoughts after the Summit, and have summarised the etherpad notes on the wiki here: https://wiki.openstack.org/w/index.php?title=Documentation/Liberty You can also see the original etherpads here: https://wiki.openstack.org/wiki/Design_Summit/Liberty/Etherpads#Documentation
 
 
 
In short, the main things I would like us to achieve for Liberty are:
 
* RST conversion: Install Guide, Cloud Admin Guide, HA Guide
 
* User Guides information architecture overhaul.
 
* Greater focus on helping out devs with docs in their repo
 
* Improve how we communicate with and support our corporate contributors
 
 
 
 
 
If you have a burning issue that didn't get addressed during the Summit, or that you think I've forgotten, now would be your chance to tell me about it! Look out for Blueprints and Specs for this work over the next couple of weeks.
 
 
 
== RST Migration ==
 
 
 
The next books we are focusing on for RST conversion are the Install Guide, Cloud Admin Guide, and the HA Guide. If you would like to assist, please get in touch with the appropriate speciality team.
 
 
 
* Install Guide:
 
** Contact Karin Levenstein <karin.levenstein@rackspace.com>
 
** Blueprint: https://blueprints.launchpad.net/openstack-manuals/+spec/installguide-liberty
 
** Spec WIP: https://review.openstack.org/#/c/183138/
 
 
 
* Cloud Admin Guide:
 
** Contact Brian Moss <kallimachos@gmail.com> & Joseph Robinson <joseph.r.email@gmail.com>
 
** Blueprint: https://blueprints.launchpad.net/openstack-manuals/+spec/reorganise-user-guides
 
** Sign up to help out here: https://wiki.openstack.org/wiki/Documentation/Migrate#Cloud_Admin_Guide_Migration
 
 
 
* HA Guide
 
** Contact Meg McRoberts <dreidellhasa@yahoo.com> or Matt Griffin  <matt.griffin@percona.com>
 
** Blueprint: https://blueprints.launchpad.net/openstack-manuals/+spec/improve-ha-guide
 
 
 
 
 
== New Core Reviewer Process ==
 
 
 
One of the simpler changes I was asked to implement at the Design Summit was a new core reviewer process, with the aim of making it a more balanced approach to selecting core team members. We decided on a process that combines a monthly statistics-based selection process with a continuous nomination-based process. I've written up the details on the HowTo here: https://wiki.openstack.org/wiki/Documentation/HowTo#Achieving_core_reviewer_status and will implement the first round on 1 June.
 
 
 
== Doc team meeting ==
 
 
 
APAC meeting was held this week, see the minutes here to catch up:
 
https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-05-27
 
 
 
Thanks to Joe for holding the APAC fort while I was travelling!
 
 
 
Next meetings are:
 
US: Wednesday 3 June, 14:00:00 UTC
 
APAC: Wednesday 10 June, 00:30: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
 
 
 
Thanks!
 
Lana
 

Latest revision as of 17:37, 30 November 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

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

7 April 2017

Team,

This week I have still been working on drafting a governance tag for our guides called "docs:follows-policy". I have been working with Doug Hellmann (dhellmann) in the last week to change to draft dramatically, so it would be good for docs people to review again. We are trying to make this a more broad tag now, so it can be applied for other guides too. To review: https://review.openstack.org/#/c/445536/ I am also in the process of documenting guidelines in our Contribution Guide - which would also benefit from doc reviews: https://review.openstack.org/#/c/453642/

Would like to call out and thank John Davidge for his awesome work with the Networking Guide and neutron-related patches. He's been providing valuable guidance, and reviews, and it has been greatly appreciated by myself and the team.

Lana Brindley has done an awesome job for the last two weeks in keeping our bug list under control. We are down to an amazing 102 bugs in queue, and 82 bugs closed this cycle already! Next week, I will be looking after the bug triage liaison role! If you're sitting there thinking "bugs are for me, I really love triaging bugs!" well, you're in luck! We have one spot open for the rest of the cycle (14 Aug - 28 Aug): https://wiki.openstack.org/wiki/Documentation/SpecialityTeams#Bug_Triage_Team

The Road to the Summit in Boston

Keep an eye out for the docs and I18n have a project onboarding room at the summit. Melvin Hillsman (mrhillsman) of the User Committee submitted a forum topic for the Ops Guide to get operator feedback. David Flanders from the Foundation has also proposed a forum topic for developer.openstack.org (which currently houses our API, SDK, and other dev stuff). We'll be discussing major changes to that and would like to see some feedback from people here. Any questions on that, shoot it my way. My main objective for this forum topic is to reduce our current technical debt that lives on this site. For more information on forum topics: https://wiki.openstack.org/wiki/Forum Schedule has been released: https://www.openstack.org/summit/boston-2017/summit-schedul

Speciality Team Reports

  • API - Anne Gentle: API versioning in relation to release versioning is currently manually compiled for the 40-ish API services, so ideas on how to automate and surface that info welcomed. More info: http://lists.openstack.org/pipermail/openstack-dev/2017-March/114690.html
  • Configuration Reference and CLI Reference - Tomoyuki Kato: N/A
  • High Availability Guide - Ianeta Hutchinson: We are continuing to collaborate with OS DevOps team. See the tag ha-guide-draft for bugs opened to fill content for the new guide.
  • Hypervisor Tuning Guide - Blair Bethwaite: N/A
  • Installation guides - Lana Brindley: We have now branched, so please remember to backport if you have edits to the Ocata guide now. Big thanks to all the testers who have been working hard over the past month or two (that Nova cells bug was *tough*!), and to Brian and Mariia for doing the heavy lifting. Noticed a bunch links to draft versions of the guide in Newton/Ocata branches, backports for that have been merged, and the Contributor Guide updated so we don't miss it in the future (https://docs.openstack.org/contributor guide/release/taskdetail.html#update-links-in-all-books).
  • Networking Guide - John Davidge: More patches landed in the last couple of weeks dealing with the move to OSC, and more are still in flight. Progress also continues on RFC 5737 compliance. Thanks to all contributors for their work.
  • Operations and Architecture Design guides - Darren Chan: Arch Guide: edited architecture considerations content and cleaned up the index page structure which was applied across OS manuals. Some ops-related content was moved to the Ops Guide. Our current focus is improving the storage design content and networking design content.
  • Training Guides - Matjaz Pancur: N/A
  • Training labs - Roger Luethi: We released the Ocata version of training-labs this week.
  • User guides - Joseph Robinson: For the user guides - the spec on migrating the Admin Guide content this week moved closer to merging. I started preparing the work items for action on the User Guides tasks wiki page.
  • Theme and Tools - Brian Moss: Anne has a spec up for theme consolidation, please check it out: https://review.openstack.org/#/c/454346/, Brian has fixed up the sitemap tool tests, reviews welcome: https://review.openstack.org/#/c/453976/. 41 open bugs, 13 closed in Pike

Doc team meeting

Our next meeting will be on Thursday, 20 April at 2100 UTC in #openstack-meeting-alt. For more meeting details, including minutes and the agenda: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting The meeting chair will be me!

Big thanks to Joseph for stepping up in the last 2 meetings and hosting in my absence! Really appreciated it :)

--

Have a great week :)

Alex

IRC: asettle Twitter: dewsday

27 March 2017

Team team team team team,

Well the last month has just FLOWN by since the PTG. We've got plenty going on in the docs team...

This week I have been helping out the security team with the Security Guide. We've been working on some cursory edits, and removal of content. A few patches have already made it through - thanks to the OSIC security team for tackling some of the outstanding bugs. There'll be more edits coming from me in the next few weeks. To see our planning: https://etherpad.openstack.org/p/sec-guide-pike I am also in the process of drafting a governance tag for our install guides. Would be great for everyone to review and understand what the process will involve: https://review.openstack.org/#/c/445536/

Shoutout and big thanks to Brian Moss and the nova team who worked together tirelessly to document Nova v2 Cells and Placement API - which was a massive blocker for our Installation Guide.

Also, thank you to our Ocata release managers, Maria Zlatkova and Brian Moss for cutting the branch! Pike is well and truly underway now.

Ianeta Hutchinson has done an awesome job for the last two weeks in keeping our bug list under control. We are down to an amazing 104 bugs in queue, and 59 bugs closed this cycle already!

Next week, we have Lana who will be looking after the bug triage liaison role! If you're sitting there thinking "bugs are for me, I really love triaging bugs!" well, you're in luck! We have a few spots open for the rest of the cycle: https://wiki.openstack.org/wiki/Documentation/SpecialityTeams#Bug_Triage_Team

The Road to the Summit in Boston

Speciality Team Reports

  • API - Anne Gentle: There's still a lot of discussion on https://review.openstack.org/#/c/421846/ which is about API change guidelines. Take a look and join in on the review. Also on the openstack-dev list, there's a thread about the future of the app catalog, which is relevant to the app developer audience so I include it here: http://lists.openstack.org/pipermail/openstack dev/2017-March/113362.html Also related to the app dev audience is the wrapping up of the App Ecosystem working group: http://lists.openstack.org/pipermail/user-committee/2017-March/001825.html
  • Configuration Reference and CLI Reference - Tomoyuki Kato: N/A
  • High Availability Guide - Ianeta Hutchinson: At the Atlanta PTG, the documentation team outlined a new table of contents that is now upstream as a draft here: https://github.com/openstack/openstack-manuals/tree/master/doc/ha-guide-draft. A blocker to progress in the past had been a lack of SME’s for the topic of high availability but that is no longer the case \o/. The OSIC DevOps team has an “adopt-a-guide” project in which they are collaborating with the OpenStack docs community and OSIC Docs team to apply the new ToC and validate all content for the guide. The progress of this collaboration is being tracked here <https://docs.google.com/spreadsheets/d/1hw4axU2IbLlsjKpz9_EGlKQt0S6siViik7ETjNg_MgI/edit?usp=sharing> We are calling for more contributors both as SME's and tech writers. Ping iphutch if interested!
  • Hypervisor Tuning Guide - Blair Bethwaite: N/A
  • Installation guides - Lana Brindley: Cells bug is closer to being fixed, and we are closer to a complete test install (https://wiki.openstack.org/wiki/Documentation/NewtonDocTesting look at all that green!). We're planning to branch Ocata by the end of this week.
  • Networking Guide - John Davidge: N/A
  • Operations and Architecture Design guides - Darren Chan: Arch Design Guide: Minor IA and general cleanup of the storage, compute, and networking sections in the Design chapter. Currently updating gaps in storage design content. Ops Guide: Removed cloud architecture content (migrated to the Arch Design Guide).
  • Security Guide - Nathaniel Dillon: Edits from Alex going through, and patches from the OSIC DevOps team. See above for more info.
  • Training Guides - Matjaz Pancur: For Training guides related topics: a new brand for activities around OpenStack Upstream University/Training. It is now known as OpenStack Upstream Institute (https://wiki.openstack.org/wiki/OpenStack_Upstream_Institute)
  • Training labs - Roger Luethi: We are currently testing our automated version of the Ocata install-guide. We had a problem with Ubuntu's new ISO image (16.04.2 LTS) which is now resolved.
  • User guides - Joseph Robinson: Several other Legacy commands were converted to OS commands this week. Reviewed the Admin Guide spec.
  • Theme and Tools - Brian Moss: I'd like to do an openstackdocstheme release soon, as we've got some items (PDF styling, search page JS fix, image centering) that would be good to have in production. Any concerns or last minute items to merge please let me know. We've had some issues come up with the auto-generation scripts. Some have been fixed already (thanks Kato and Christian!), and we're investigating others. If you notice anything amiss or would like to help out, please let me know. 46 open bugs, 8 closed in Pike

Doc team meeting

Our next meeting will be on Thursday, 7 April at 2100 UTC in #openstack-meeting-alt. For more meeting details, including minutes and the agenda: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting

--

Have a great week :)

Alex

IRC: asettle Twitter: dewsday