Jump to: navigation, search

Difference between revisions of "Documentation/WhatsUpDoc"

(4 March 2016)
Line 20: Line 20:
 
Hi everyone,
 
Hi everyone,
  
This week I've been working on code reviews and closing some of our oldest bugs from the bug queue. I've also updated the docs-specs core team list to reflect some recent changes to the Speciality Team leads, and doing some general prep work for the Mitaka release. We are now well and truly ready to start testing the Install Guide. If you need help getting started, please contact Matt Kassawara, or any of your friendly core team members :)
+
This week I've been concentrating on getting ready for the release, and I'm very pleased to announce that we now have not one but two release managers for Mitaka. Please welcome Brian and Olga, thanks to you both for stepping up to the challenge! I'm looking forward to working with you both to get this out the door. We also completed the docs core team review, with no changes for this month. Install Guide testing is now well underway, but we can always use more hands, so please consider getting involved. If you need help getting started, please contact Matt Kassawara, or any docs core.
  
 
== Progress towards Mitaka ==
 
== Progress towards Mitaka ==
  
40 days to go!
+
33 days to go!
  
445 bugs closed so far for this release. There is a global bug smash event coming up March 7-9 to try and hit as many Mitaka bugs as possible. You can join an in-person group near you, or participate remotely. There are still plenty of docs bugs that can be attended to. Details here: https://etherpad.openstack.org/p/OpenStack-Bug-Smash-Mitaka
+
465 bugs closed so far for this release. There is a global bug smash event next week to try and hit as many Mitaka bugs as possible. You can join an in-person group near you, or participate remotely. Details here: https://etherpad.openstack.org/p/OpenStack-Bug-Smash-Mitaka
  
 
Docs Testing
 
Docs Testing
Line 32: Line 32:
 
* https://wiki.openstack.org/wiki/Documentation/MitakaDocTesting
 
* https://wiki.openstack.org/wiki/Documentation/MitakaDocTesting
  
RST Conversions
+
Release Managers:
* All planned RST conversions are now complete!
+
We now have two release managers for Mitaka: Brian Moss, and Olga Gusarenko. They'll be making sure we stay on track as we hurtle towards 7 April, and will be backed up by Anne, Andreas, myself, and of course our lovely core team.
  
Reorganisations
+
== The Road to Austin ==
* Arch Guide: really needs a last minute push to get this complete before Mitaka. If you can help out, it would be greatly appreciated!
 
** 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
 
  
DocImpact
+
* The final round of ATC passes have now gone out.
* Is now complete
+
* I have requested workrooms and fishbowls for the Austin Design Summit. I'll let you know when we get our allocation.
 +
* You should be starting to think about booking travel and accommodation soon! If you need a visa to travel to the United States, there's more info here: https://www.openstack.org/summit/austin-2016/austin-and-travel/#visa
  
== The Road to Austin ==
+
== Core Team reviews ==
  
* The final round of ATC passes should be going out shortly.
+
I completed the core team review for March this week, and we decided to make no changes. We did, however, have some discussion about the stats we use to determine the core team membership. I currently use the 30 and 90 day russellbryant stats for determining review participation, and Stackalytics for commit participation, with emphasis being on the top 12 participants in each category. Feedback on the core team selection process is, as always, welcome. It is documented here: http://docs.openstack.org/contributor-guide/docs-review.html#achieving-a-core-reviewer-status
* I have now requested workrooms and fishbowls for the Austin Design Summit. I'll let you know when we get our allocation.
 
* There is a plan to separate the Design Summit from the main conference after Barcelona. I strongly suggest you read the thread on the dev mailing list, if you haven't done so already: http://lists.openstack.org/pipermail/openstack-dev/2016-February/087161.html
 
* You should be starting to think about booking travel and accommodation soon! If you need a visa to travel to the United States, there's more info here: https://www.openstack.org/summit/austin-2016/austin-and-travel/#visa
 
  
 
== Speciality Teams ==
 
== Speciality Teams ==
Line 59: Line 51:
  
 
'''Installation Guide - Matt Kassawara'''
 
'''Installation Guide - Matt Kassawara'''
Continue updating the guide for Mitaka using primarily RDO milestone 3 packages. Review patch that adds manila to the guide. Review patch that adds magnum to the guide.
+
More patches and testing for Mitaka.
  
 
'''Networking Guide - Edgar Magana'''
 
'''Networking Guide - Edgar Magana'''
Line 68: Line 60:
  
 
'''User Guides - Joseph Robinson'''
 
'''User Guides - Joseph Robinson'''
Team successfully moved across dashboard content from the Admin User Guide to the Cloud Admin guide. Team is preparing to move the command line content, and then continue to edit the Cloud Admin guide over the next week.
+
A patch for the reorganisation is under review - shifting the command line content in the admin user guide to the cloud admin guide. Following this patch merging, the next step is moving down the task list, and completing edits to the content in the Cloud Admin guide to improve the document.
  
 
'''Ops and Arch Guides - Shilla Saebi'''
 
'''Ops and Arch Guides - Shilla Saebi'''
The work items for the Architecture Design Guide have been converted to bugs: https://bugs.launchpad.net/openstack-manuals/+bugs?field.tag=arch-guide We need people to confirm the bugs, so we can start working on them. Call for volunteers email went out to the ops and docs ML from Devon Boatwright. We are still looking for help, not getting many responses. Architecture guide reorganization is underway. We have a drafts repo in openstack-manuals, feel free to ping Shilla or Darren Chan if you are interested in helping out. Considering doing a swarm or work session at the summit in Austin for the Arch guide
+
The work items for the Architecture Design Guide converted to bugs: https://bugs.launchpad.net/openstack-manuals/+bugs?field.tag=arch-guide We still need people to confirm the bugs
 +
Call for volunteers email went out to the ops and docs ML from Devon Boatwright. We are still looking for help, not getting many responses
 +
Considering doing a swarm or work session at the summit in Austin for the Arch guide
  
 
'''API Docs - Anne Gentle'''
 
'''API Docs - Anne Gentle'''
Check for API migration bugs: https://bugs.launchpad.net/openstack-api-site/+bugs?field.tag=migration There are five bugs remaining. Look at the infra spec if you're interested in how we'll build docs with Swagger files. https://review.openstack.org/#/c/276484/ I'm investigating using this tool so that we replace flat HTML files built from WADL with flat HTML files built from Swagger. https://github.com/nknapp/bootprint-openapi
+
Patch fixing three of remaining 7 WADL bugs here: https://review.openstack.org/#/c/283114/
 +
Patch that builds HTML from Swagger files here: https://review.openstack.org/#/c/286659/ This gets us over a big hurdle of making fairy-slipper "feature complete" while also ensuring the migration is complete. Great week, huge shoutout and thanks to Michael Krotscheck for the node/npm solution for building HTML.
  
 
'''Config Ref - Gauvain Pocentek'''
 
'''Config Ref - Gauvain Pocentek'''
Line 80: Line 75:
  
 
'''Training labs - Pranav Salunke, Roger Luethi'''
 
'''Training labs - Pranav Salunke, Roger Luethi'''
Continued fixes to KVM backend and the library functions. Working on creating a webpage for training-labs. https://review.openstack.org/#/c/281713/ https://review.openstack.org/#/c/281721/ https://review.openstack.org/#/c/281367/ Hosting an additional meeting to get our new member on-board and some general discussion.
+
No update this week.
  
 
'''Training Guides - Matjaz Pancur'''
 
'''Training Guides - Matjaz Pancur'''
No update this week.
+
"Getting started" module for Training guides is published (http://docs.openstack.org/draft/training-guides/). Added "Local trainings" chapter to the Upstream training archive (http://docs.openstack.org/upstream-training/upstream-archives.html), cleanup patches (unused extensions, text redundancies and cleanup). Team meetings will be held on 1st and 3rd week in the month.
  
 
'''Hypervisor Tuning Guide - Joe Topjian'''
 
'''Hypervisor Tuning Guide - Joe Topjian'''
Line 89: Line 84:
  
 
'''UX/UI Docs Guidelines - Linette Williams'''
 
'''UX/UI Docs Guidelines - Linette Williams'''
Reviews continue for proposed panels in Invision. Enhancement in UI content guidelines complete for text and icon formatting recommendations (http://docs.openstack.org/contributor-guide/ui-text-guidelines.html).
+
Reviews continue for proposed UI panels in Invision
  
 
== Doc team meeting ==
 
== Doc team meeting ==

Revision as of 04:36, 4 March 2016

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

Your suggestions for content

  • Your
  • Content
  • Here

Looking for older editions?

You can see older newsletters here: Documentation/WhatsUpDoc_Archive

4 March 2016

Hi everyone,

This week I've been concentrating on getting ready for the release, and I'm very pleased to announce that we now have not one but two release managers for Mitaka. Please welcome Brian and Olga, thanks to you both for stepping up to the challenge! I'm looking forward to working with you both to get this out the door. We also completed the docs core team review, with no changes for this month. Install Guide testing is now well underway, but we can always use more hands, so please consider getting involved. If you need help getting started, please contact Matt Kassawara, or any docs core.

Progress towards Mitaka

33 days to go!

465 bugs closed so far for this release. There is a global bug smash event next week to try and hit as many Mitaka bugs as possible. You can join an in-person group near you, or participate remotely. Details here: https://etherpad.openstack.org/p/OpenStack-Bug-Smash-Mitaka

Docs Testing

Release Managers: We now have two release managers for Mitaka: Brian Moss, and Olga Gusarenko. They'll be making sure we stay on track as we hurtle towards 7 April, and will be backed up by Anne, Andreas, myself, and of course our lovely core team.

The Road to Austin

  • The final round of ATC passes have now gone out.
  • I have requested workrooms and fishbowls for the Austin Design Summit. I'll let you know when we get our allocation.
  • You should be starting to think about booking travel and accommodation soon! If you need a visa to travel to the United States, there's more info here: https://www.openstack.org/summit/austin-2016/austin-and-travel/#visa

Core Team reviews

I completed the core team review for March this week, and we decided to make no changes. We did, however, have some discussion about the stats we use to determine the core team membership. I currently use the 30 and 90 day russellbryant stats for determining review participation, and Stackalytics for commit participation, with emphasis being on the top 12 participants in each category. Feedback on the core team selection process is, as always, welcome. It is documented here: http://docs.openstack.org/contributor-guide/docs-review.html#achieving-a-core-reviewer-status

Speciality Teams

HA Guide - Bogdan Dobrelya No update this week.

Installation Guide - Matt Kassawara More patches and testing for Mitaka.

Networking Guide - Edgar Magana No update this week.

Security Guide - Nathaniel Dillon No update this week.

User Guides - Joseph Robinson A patch for the reorganisation is under review - shifting the command line content in the admin user guide to the cloud admin guide. Following this patch merging, the next step is moving down the task list, and completing edits to the content in the Cloud Admin guide to improve the document.

Ops and Arch Guides - Shilla Saebi The work items for the Architecture Design Guide converted to bugs: https://bugs.launchpad.net/openstack-manuals/+bugs?field.tag=arch-guide We still need people to confirm the bugs Call for volunteers email went out to the ops and docs ML from Devon Boatwright. We are still looking for help, not getting many responses Considering doing a swarm or work session at the summit in Austin for the Arch guide

API Docs - Anne Gentle Patch fixing three of remaining 7 WADL bugs here: https://review.openstack.org/#/c/283114/ Patch that builds HTML from Swagger files here: https://review.openstack.org/#/c/286659/ This gets us over a big hurdle of making fairy-slipper "feature complete" while also ensuring the migration is complete. Great week, huge shoutout and thanks to Michael Krotscheck for the node/npm solution for building HTML.

Config Ref - Gauvain Pocentek No update this week.

Training labs - Pranav Salunke, Roger Luethi No update this week.

Training Guides - Matjaz Pancur "Getting started" module for Training guides is published (http://docs.openstack.org/draft/training-guides/). Added "Local trainings" chapter to the Upstream training archive (http://docs.openstack.org/upstream-training/upstream-archives.html), cleanup patches (unused extensions, text redundancies and cleanup). Team meetings will be held on 1st and 3rd week in the month.

Hypervisor Tuning Guide - Joe Topjian No update this week.

UX/UI Docs Guidelines - Linette Williams Reviews continue for proposed UI panels in Invision

Doc team meeting

Next meetings:

The APAC meeting attempted to be held this week, but failed to meet quorum.

Next meetings: US: Wednesday 2 March, 19:00 UTC ***Note the new time!*** APAC: Wednesday 9 March, 00:30 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

https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#4_March_2016