Documentation/WhatsUpDoc Archive

= 10 March 2017 =

Team team team team team,

It's been a crazy few weeks since the PTG ramping up our goals for Pike! Big thanks to everyone who has really hit the ground running with our new set of objectives.

This week I have been helping out Ianeta with the High Availability Guide ToC plan, (which you can review here: https://review.openstack.org/#/c/440890/) and Rob Clark with the Security Guide plan (https://etherpad.openstack.org/p/sec-guide-pike). I have also been working alongside Brian and the nova team to unblock ourselves from a particularly nasty, critical, bug affecting the Install Guide. For more information: https://bugs.launchpad.net/openstack-manuals/+bug/1663485

Big thanks to Darren Chan who has been doing an awesome job for the last two weeks in keeping our bug list under control. We are down to an amazing 108 bugs in queue.

Next week, we have Ianeta 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

Progress towards Pike

 * https://www.timeanddate.com/countdown/newyear?p0=24&msg=Pike+release&ud=1&font=slab
 * Bugs closed in Pike: 32! You guys rock :)

The Road to the Summit in Boston
The summit schedule has been announced!
 * https://www.openstack.org/summit/boston-2017/summit-schedule/#day=2017-05-08

I will be representing the docs team at the summit for the new 'Project Update' session. For more information: https://www.openstack.org/summit/boston-2017/summit-schedule/global-search?t=Project+Update+-+Documentation

Let me know if you had any doc talks accepted!

Speciality Team Reports

 * API - Anne Gentle: One prominent change is that the Block Storage API v2 is now exactly replicated with v3 and so is now marked Deprecated. The list of all OpenStack APIs is now also here: https://developer.openstack.org/#api and you can see them based on support level here: https://developer.openstack.org/api-guide/quick-start/
 * Configuration Reference and CLI Reference - Tomoyuki Kato: CLI Reference: NIL this week. Some bugs for the Config Ref and potential bug in the tooling.
 * High Availability Guide - Ianeta Hutchinson: So we have this patch https://review.openstack.org/#/c/440890/13 to establish the new ToC for HA Guide. We are trying to move all content that is relevant in the current guide over to the new ToC. From there, we will be filing bugs to start collaboration with the OSIC DevOps team who have signed up to adopt-a-guide and will be helping to provide content as SME's.
 * Hypervisor Tuning Guide - Blair Bethwaite: The Scientific-WG is considering proposing a hypervisor tuning + guide session for the Boston Forum though, so hopefully if that goes ahead it will create some renewed interest.
 * Installation guides - Lana Brindley: Waiting to sort out the last couple of bugs before we branch, hopefully next week
 * Networking Guide - John Davidge: Huge number of patches this week on the RFC 5737 fix[1] - thanks to caoyuan! Continued progress on replacing neutronclient commands with OSC versions. Thank you to all contributors. A patch[2] changing a documented use of ’tenant’ to ‘project’ sparked a discussion in the neutron team about the mixture of terminology in neutron, with the conclusion that all remaining references to ’tenant’ in our config files and elsewhere are to be replaced with ‘project’ as soon as possible. Some of these will require deprecation cycles. Impact on the networking guide should be minimal. [1] https://launchpad.net/bugs/1656378 [2] https://review.openstack.org/#/c/43816
 * Operations and Architecture Design guides - Darren Chan: A patch to move the draft Arch Guide to docs.o.o has merged. The previous guide has been moved to a "to archive" directory until the archiving process is ready. The Arch Guide working group met this week to rearchitect and scope the design content. We're currently focussed on the storage content.
 * Security Guide - Nathaniel Dillon: Rob Clark (PTL) and Alex are in the process of planning the ins and out of the overhaul of the guide. We're talking about dramatically reducing the scope, and introducing new, maintainable, content. Rob ( hyakuhei ) is also looking at getting a sprint in Austin at some point to get the security team all together and pump out some content. We also have the OSIC Security team pumping out some of the main, non-wishlist, bugs at preset
 * Training Guides - Matjaz Pancur: N/A
 * Training labs - Pranav Salunke, Roger Luethi: We have pushed the current state of the Ocata training-labs changeset in case others find it useful. The scripts follow the install-guide and
 * https://review.openstack.org/#/c/438328/. The resulting cluster cannot launch instances because it fails to find a host (just like others following the install-guide have reported).
 * User guides - Joseph Robinson: For the User and Admin Guides, I've been looping through the bug list - there are SDK bugs and the issue of moving the python SDK examples, which was discussed back in Newton. There are also two telemetry bugs, which I need to contact the liaisons for. The only other point, is reviewing the Admin Guide migration spec: https://review.openstack.org/#/c/439122/

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

I am unavailable to be the meeting chair this week :( is someone able to host? Ping or email if you are able to help out!

-- Have a great weekend! Alex Fastest typer in the universe (2014) and expert cactus photographer IRC: asettle Twitter: dewsday

= 24 February 2017 =

Team team team team team, Welcome to my second edition of What's up, Doc! We have had an extremely busy week in Atlanta for the PTG. We had a really enthusiastic attendance and I am truly impressed by how much we have managed to get done. This newsletter will be a short one and focus on a small PTG update! Our bug triager for the first 2 weeks of Pike is Darren Chan. Looking for more people to sign up and help out: https://wiki.openstack.org/wiki/Documentation/SpecialityTeams#Bug_Triage_Team

Progress towards Pike
Thanks to our amazing release managers, Maria, Brian and Lana for all their amazing hard work on the Ocata release. Big thanks to Anne for stepping in at the last minute!
 * 44 days to go! https://www.timeanddate.com/countdown/newyear?p0=24&msg=Pike+release&ud=1&font=slab

The Road to the Summit in Boston
Voting is now open for topics. You can find the list of topics here: https://www.openstack.org/summit/boston-2017/vote-for-speakers#/ I was able to find some documentation related topics. If anyone has any more topics I am unaware of, please reply to this email thread and share your talks! Please vote for your fellow documenter below: 1. https://www.openstack.org/summit/boston-2017/vote-for-speakers#/17888 2. https://www.openstack.org/summit/boston-2017/vote-for-speakers#/18078 3. https://www.openstack.org/summit/boston-2017/vote-for-speakers#/17711 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/

PTG Update
We had a very successful PTG! Thanks to all those that were able to attend. Thanks to Ian Choi and the I18n team for being wonderful collaborators. We were able to get a lot done in our horizontal sessions. For anyone that is interested, here's our etherpad with all the notes from the sessions: https://etherpad.openstack.org/p/docs-i18n-ptg-pike Here are a few of the exciting things to look out for in Pike: 1.      High Availability Guide improvements a.      Adam Spiers and Ianeta Hutchinson will be leading the charge on the HA guide with a massive restructure and up-to-date new content. 2.      Reno release notes for OpenStack manuals a.      Adam Spiers has been working alongside John Davidge and the Infra team to work on implementing the reno release notes process for documentation. Including looking at implementing new reno templates to work specifically for documentation! 3.      Networking Guide improvements and more collaboration with the neutron team. a.      John Davidge has been working with the neutron team to develop the best way to ensure information flows into the guide. Discussions around the use of the DocImpact tag were successful. 4.      Administrator Guide changes! Keep your eye out for exciting developments. a.      Ildiko Vancsa and Joseph Robinson will be working together to come up with a new specification to implement in Queens for our Administration Guide. Development teams have been enthusiastic about implementing the project-install-guide and are looking for similar structures with the Admin Guide. Stay tuned for more news here! I had the opportunity to report back to meeting attendees yesterday afternoon, if anyone would like to know more, here are the meeting minutes: http://eavesdrop.openstack.org/meetings/docteam/2017/docteam.2017-02-23-20.59.log.txt

Doc team meeting
Our next meeting will be on Thursday 9 March 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 Lamp enthusiast and award winning marathon sleeper IRC: asettle Twitter: dewsday

= 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. I’ve slowly been ramping up and getting used to the mass influx of emails. Turns out I’m really good at sending out emails with the incorrect time and/or date. Big thanks to Andreas for informing me the next 9th of January will be in 2020.

Without further ado, 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! (links also below, and more info in the meeting minutes from yesterday).

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. We will not be skipping the meeting in favor for the PTG as the docs sessions are on the Mon-Tues and I would love the opportunity to immediately report back to people who cannot attend.

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

= 27 January 2017 =

Hi everyone,

I must confess, I'm feeling a little sad. This is my very last What's Up, Doc. Next week, I'll be handling the Docs PTL mantle to Alexandra Settle. I've worked with Alex in varying capacities over many years, and I have no doubt that she will be a fabulous PTL. I'm really looking forward to working with her, and seeing what new directions she's able to take this team. I want to take this opportunity to thank each and every one of you for your continued support and encouragement over the last two years (and almost-four releases!). I have had an absolute ball doing this job, and it's all because of the amazing people I get to work with every day. Of course, I'm not going anywhere just yet. I will stay on as a core contributor, and continue to help out as much as I can.

In the meantime, we have a release to get out the door! We now only have 26 days until Ocata is released, please keep an eye on the docs mailing list for updates, and consider getting your hands dirty with some Install Guide testing: https://wiki.openstack.org/wiki/Documentation/OcataDocTesting

Progress towards Ocata
26 days to go!

Closed 211 bugs so far.

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
Event info is available here: http://www.openstack.org/ptg Purchase tickets here: https://pikeptg.eventbrite.com/

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.

Conversation topics for Docs and i18n here: https://etherpad.openstack.org/p/docs-i18n-ptg-pike

Also, a quick note that the CFP and ticket sales for *Boston in May* are now open: https://www.openstack.org/summit/boston-2017/call-for-presentations/

Speciality Team Reports
No speciality team reports this week, as we didn't have quorum for the docs meeting.

Doc team meeting
Our next meeting will be on Thursday 9 Februarey at 2100 UTC in #openstack-meeting-alt

Meeting chair will be Alexandra Settle.

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

--

Keep on doc'ing!

Lana

https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#27_January_2017

= 13 January 2017 =

Hi everyone,

Welcome to 2017. I hope you all had a chance to rest up a little before we hurtle straight into another release, as Ocata is now only 40 days away! I'll be in contact with our lovely release managers Brian and Mariia over the next week or so to kick off release management tasks. We will need people to test the Installation Guide again, too, so if you're interested in helping out there, please let me know.

As many of you already know, I'm not planning on running for Pike PTL. PTL nominations open in the week of 23 January, and I'll be working with Alex and Kato-san who have both expressed interest in taking on this role. If you're interested in running for PTL (for Pike or any future release), and would like a crash course in PTLing, please let me know and I can share whatever meagre wisdom I've gleaned.

Progress towards Ocata
40 days to go!

Closed 149 bugs so far.

Release tasks are being tracked here: https://wiki.openstack.org/wiki/Documentation/OcataDeliverables

The Road to PTG in Atlanta
Event info is available here: http://www.openstack.org/ptg Purchase tickets here: https://pikeptg.eventbrite.com/

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.

The incoming PTL will be responsible for planning and running sessions at the Atlanta PTG.

Also, a quick note that the CFP and ticket sales for *Boston* in May are now open: https://www.openstack.org/summit/boston-2017/call-for-presentations/

Speciality Team Reports
Fairy-slipper is being retired. It was a good tool, served its purpose, and can now traipse into the sunset, thanks to AJaeger and stevemar for the help with the patches. Be sure to follow the service catalog naming conventions work going on in the API WG. And there's also a new EC2 API reference: http://developer.openstack.org/api-ref/ec2-api/
 * API: Anne Gentle

Config Reference: Updated a few plug-ins. CLI reference: Updated a few command references and removed unsupported Block Storage API v1 and Image API v1.
 * Configuration Reference and CLI Reference: Tomoyuki Kato

No report this week
 * High Availability Guide: Andrew Beekhof

No report this week
 * Hypervisor Tuning Guide: Joe Topjian

Testing for Ocata will be opening soon. Also, we need a web dev for the landing page, if you know of anyone, please get me in touch.
 * Installation guides: Lana Brindley

No update this week.
 * Networking Guide: John Davidge

Ben Silverman has spent some time refining the Compute content in the Arch Guide draft. Thanks Ben! We are also looking for more SMEs to help with the Arch Guide. So if you're interested, contact asettle or me.
 * Operations and Architecture Design guides: Darren Chan

No update this week.
 * Security Guide: Nathaniel Dillon

No update this week.
 * Training Guides: Matjaz Pancur

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

The command conversions have happened at a good pace, the User Guide appears to be mostly complete, with the condition that the trove and manila teams do not have OpenStack commands yet. I have started checking through the Admin Guide files. I suspect there is more to convert, but it should be ready for Ocata.
 * User guides: Joseph Robinson

Doc team meeting
Our next meeting will be on Thursday 27 January at 2100 UTC in #openstack-meeting-alt

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

--

Keep on doc'ing!

Lana

https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#13_January_2017

= 1 December 2016 =

Hi everyone,

The end of the year is nearly upon us already, and this will be my last newsletter for 2016, before I disappear for the holidays on the 16th. I've had yet another wonderful year with all you lovely OpenStack people, and I wish all of you and your families a happy and safe holiday, wherever and however you celebrate it. Here in Australia, the temperature is starting to soar, so I'm off on another cruise, followed by a few lazy days by the pool with family and friends. I'll be back in the office early in the new year, and ready to kick Ocata out of the door!

As many of you already know, I'm not planning on running for Pike PTL. If you're interested in running for PTL (for Pike or any future release), and would like a crash course in PTLing, please let me know and I can share whatever meagre wisdom I've gleaned before self nominations open in mid-January.

Progress towards Ocata
82 days to go!

Closed 106 bugs so far.

Release tasks are being tracked here: https://wiki.openstack.org/wiki/Documentation/OcataDeliverables

The Road to PTG in Atlanta
Event info is available here: http://www.openstack.org/ptg Purchase tickets here: https://pikeptg.eventbrite.com/

Docs is a horizontal project, so our sessions will run across the Monday and Tuesday of the event.

The incoming PTL will be responsible for planning and running sessions at the Atlanta PTG.

Speciality Team Reports
The App Dev Support WG is working on a survey to determine which content areas to invest in for content on http://www.openstack.org/appdev (http://lists.openstack.org/pipermail/user-committee/2016-November/001469.html)
 * API: Anne Gentle

We try to recreating the single page view for the "openstack" command. I'd like to generate the reference from source code automatically. However, python-openstackclient has many plug-ins. It is difficulty, but worth to tackle it. We need your help!
 * Configuration Reference and CLI Reference: Tomoyuki Kato

No formal report, but Alex Settle has been doing a lot of work on this guide recently, cleaning up, and raising bugs for some of the TODO items. We need to consider if the HA guide is an ongoing concern. Ben Silverman is wondering if we can fold the content into the Ops/Arch Guides. This will be raised on the mailing list for more conversation.
 * High Availability Guide: Andrew Beekhof

No report this week
 * Hypervisor Tuning Guide: Joe Topjian

We've heard back from Foundation on design resources, I'm going to reply to that email today and hopefully start drafting the new design next week. I've also got Piet from the UX team on board to help. Anyone who wants to be involved with that, please contact me.
 * Installation guides: Lana Brindley

No update this week.
 * Networking Guide: John Davidge

For the Arch guide, patches for networking and compute content were merged, thanks to Ben and Shaun. For the Ops Guide, there is patch up to update the upgrades chapter and include links to the project upgrade notes: https://review.openstack.org/#/c/404528/
 * Operations and Architecture Design guides: Darren Chan

No update this week.
 * Security Guide: Nathaniel Dillon

BCN Upstream training article in the Superuser magazine: http://superuser.openstack.org/articles/openstack-upstream-training-revamp/ - actively looking for contributors to join the Upstream training, please see http://lists.openstack.org/pipermail/openstack-docs/2016-November/009382.html - cleaned test entries in the Launchpad bug queue and the Sandbox repository (left from the Barcelona Upstream training) - updated Training guides README.rst
 * Training Guides: Matjaz Pancur

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

The legacy command conversion continues at a good pace. I have some more updates to patch today. The only obstacle I have run into is generating new output to match the OpenStack command client. Otherwise, contributors have been adding to the table, and there's been steady patching completed. Just a reminder to update the table if making a change: https://wiki.openstack.org/wiki/Documentation/ReorganizeUserGuides
 * User guides: Joseph Robinson

Doc team meeting
Our next meeting will be on Thursday 16 December at 2100 UTC in #openstack-meeting-alt

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

--

Keep on doc'ing!

Lana

https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#1_December_2016

= 18 November 2016 =

Hi everyone,

Welcome to Ocata! It was great to catch up with many of you in Barcelona, and always refreshing to see the energy around our little project and catch that enthusiasm all over again :) Of course, Ocata is a *very* short cycle, so we've deliberately cut down our deliverables list to ensure we can squeeze it all in. We have two main priorities this release: tidying up the new Install Guides index page, and a little bit of navel gazing in terms of social structures and procedures. More on that in this newsletter!

Progress towards Ocata
96 days to go!

Closed 77 bugs so far.

Release tasks are being tracked here: https://wiki.openstack.org/wiki/Documentation/OcataDeliverables

The Road to PTG in Atlanta
Event info is available here: http://www.openstack.org/ptg Purchase tickets here: https://pikeptg.eventbrite.com/

Docs is a horizontal project, so our sessions will run across the Monday and Tuesday of the event.

Specs on review
https://review.openstack.org/#/c/392372/ [arch-design] Revise the Architecture Design Guide https://review.openstack.org/#/c/394261/ [ops-guide] Add project upgrade notes https://review.openstack.org/#/c/391786/ Proposed use case form
 * Ops/Arch Guides:

https://review.openstack.org/#/c/391548/ training-labs: Rewrite training-labs in python
 * Training Labs:

Speciality Team Reports
We've made some structural changes to how Speciality Teams and our regular docs meeting work. Speciality teams will now meet no more than once monthly (most on an 'as needed' basis), and participants are instead encouraged to attend the main docs meeting to discuss work and report on progress. This is aiming to keep all the information about the work we're doing a little more centralised, and give newcomers a way to find out where they can best help. It also gives us a chance to find out where we can help each other, without going to a dozen meetings!

Karen Bradshaw has been working on updates to the openstackdocstheme that would fix this bug: https://launchpad.net/bugs/1583623. The review is up at https://review.openstack.org/#/c/393890/ and getting input from the affected teams who have recognized the need because of errors building when you have multiple API versions with very similar calls, so you end up with identical headings. Launchpad bug 1583623 in openstack-doc-tools "os-api-ref: duplicate labels for selectors" [Low,In progress] - Assigned to Karen Bradshaw (kbhawkey) I've had a couple of inquiries on IRC about "where did the draft/swagger files go?" but to meet their stated end goals, those particular files wouldn't have worked any way due to inaccuracies in the content and incomplete content. See the 100 api-ref doc patches up for review at: https://review.openstack.org/#/q/status:open+file:api-ref.
 * API: Anne Gentle

No report this week
 * Configuration Reference and CLI Reference: Tomoyuki Kato

No report this week
 * High Availability Guide: Andrew Beekhof

No report this week
 * Hypervisor Tuning Guide: Joe Topjian

No major updates to the guides themselves, but we are planning updates to the landing page. We're also working on getting our first deployment guide landed there, with OpenStack Ansible. I've requested design resources from foundation, but haven't heard back yet, so if you have ideas/suggestions (or design skillz!) then please let me know.
 * Installation guides: Lana Brindley

A couple of new articles are close to merging: https://review.openstack.org/#/c/361776/ - VLAN Trunking and https://review.openstack.org/#/c/356013/ - Routed Provider Networks. Need to decide how best to track the work that's going on for https://blueprints.launchpad.net/openstack-manuals/+spec/use-openstack-command. Probably a google spreadsheet or etherpad with a list of all the network guide pages to be converted, and the person working on it would be best. That way we can hopefully avoid duplicating efforts.
 * Networking Guide: John Davidge

We're slowly making progress with the arch guide, and have cloudnull onboard to help. So the focus is completing the design chapter and migrating stuff from the ops guide.
 * Operations and Architecture Design guides: Darren Chan

No update this week.
 * Security Guide: Nathaniel Dillon

We changed our IRC meeting to every two weeks (on even weeks) on Tuesday at 1300 UTC in #openstack-meeting-3. There will be an article published about BCN Upstream training in OpenStack's Superuser magazine. BCN Upstream training retrospective https://etherpad.openstack.org/p/upstream-training-barcelona-retrospective
 * Training Guides: Matjaz Pancur

We have the python port already under review, the spec is not done yet, but we hope to get them merged soonish and in the right order :)
 * Training labs: Pranav Salunke, Roger Luethi

User guides: Joseph Robinson
 * This the current work on converting the legacy commands to OS commands: https://wiki.openstack.org/wiki/Documentation/ReorganizeUserGuides#Ocata_Tasks. Thanks to csatari and visnyei and allen, there's progress happening. I need to finish adding the files affected to the checklist, and then also start making changes. Apart from that, keeping track of any admin or user guide bugs is also a task.

Doc team meeting
We have re-started the docs team meetings, with a new cadence. Our first meeting was held today, with much success. Thank you to everyone who participated, either directly in IRC, or by making sure you sent me your updates ahead of schedule.

Our next meeting will be on Thursday 1 December at 2100 UTC in #openstack-meeting-alt

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

--

Keep on doc'ing!

Lana

https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#18_November_2016

= 7 October 2016 =

Hi everyone,

First of all, Newton docs are live on http://docs.openstack.org/ \o/

Thank you to our release managers, Olena and Alex, who have put in the hard yards over the past few weeks to get us in good shape. Thanks also to Andreas and Kato-san, for everything that they do, and to our speciality team leads and cross project liaisons. And thanks to Christian and Matt for the last minute assistance.

Of course, every release belongs to all of you who have written, tested, reviewed, updated, triaged, and edited over the last six months. Well done on another successful release :)

Don't forget that you can still use "#success" before a message in any OpenStack IRC channel to call out wins, they are gathered here: https://wiki.openstack.org/wiki/Successes

Progress towards Newton
Newton has been released unto the world. We fixed 479 bugs this cycle, and completed 15 blueprints.

We'll begin planning for Ocata over the next couple of weeks, culminating in the Barcelona Summit 25-28 October, where we'll develop our Ocata deliverables list. Stay tuned!

The Road to Barcelona
Our docs schedule is now available here: https://www.openstack.org/summit/barcelona-2016/summit-schedule/global-search?t=Documentation%3A

We are also hoping to have a docs session in the Ops track. I'll get back to you with more information on that as soon as I have it.

I've requested a docs track at the PTG in Atlanta next February, which will be used for Ocata review and Pike planning. Please let me know if you intend to participate.

Core Team Reviews
Just a quick note that we won't be holding a core team review in November, as it conflicts with Summit. We'll resume these in December for the Ocata cycle.

Doc team meeting
We will take a short break and resume the normal meeting schedule after Summit. In the meantime, you can catch most of us in #openstack-doc in a variety of timezones, so feel free to drop in and ask questions any time.

--

Keep on doc'ing!

Lana

https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#7_October_2016

= 30 September 2016 =

Hi everyone,

We're on the final countdown to Newton now! The release managers Olena and Alex are busy getting the release patches ready, the Install Guide testing team are madly working through the last few sections, and Andreas and I have our fingers hovering over the big red GO button! Don't forget that you can contact any of us (or just send mail to the docs mailing list) if you have any questions about the Newton docs release.

Please be aware that the core team will not be merging non-critical patches until after we've branched for Newton, particularly for the Installation Guide. We usually cut the branch about a week after Summit concludes, so you might be asked to wait until then. If that happens, a core will -2 your patch until after we've branched.

Progress towards Newton
5 days to go!

Bugs closed so far: 466

Release managers: Olena Logvinova and Alexandra Settle

Release tasks are being tracked here: https://etherpad.openstack.org/p/NewtonRelease

Install Guide testing is being tracked here: https://wiki.openstack.org/wiki/Documentation/NewtonDocTesting

The Road to Barcelona
I have a draft schedule up, which you can see here: https://etherpad.openstack.org/p/Ocata-DocsSessions I'll put this into Sched once the tool becomes available, and your early feedback is welcome. Additionally, if you're interested in moderating a session in Barcelona, please let me know.

Core Team Reviews
Just a quick note that we won't be holding a core team review in October, as it conflicts with release, or in November, as it conflicts with Summit. We'll resume these in December for the Newton cycle.

Doc team meeting
Next meetings:

The US meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-09-28

Next meetings: APAC: Wednesday 5 October, 00:30 UTC (This will be the final meeting before release day!) US: Wednesday 12 October, 19: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

https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#30_September_2016

= 23 September 2016 =

Hi everyone,

Newton goes out in just two weeks, and the release team and I have been busy working through release tasks in preparation. Don't forget that you can contact any of us (or just send mail to the docs mailing list) if you have any questions about the Newton docs release.

I'm also pleased to announce that I have been returned as the documentation PTL for Ocata, which will be my fourth term. Thanks for all the support!

Progress towards Newton
12 days to go!

Bugs closed so far: 455

Release managers: Olena Logvinova and Alexandra Settle

Release tasks are being tracked here: https://etherpad.openstack.org/p/NewtonRelease

Install Guide testing is being tracked here: https://wiki.openstack.org/wiki/Documentation/NewtonDocTesting

The Road to Barcelona

 * I have a draft schedule starting to take shape, which you can see here: https://etherpad.openstack.org/p/Ocata-DocsSessions I'll put this into Sched once the tool becomes available, and your early feedback is welcome. Additionally, if you're interested in moderating a session in Barcelona, please let me know.
 * By now, you should be well on the way to having your travel and accommodation booked for Barcelona. In case you're still working on it, though, there's travel information available on the Summit site here: https://www.openstack.org/summit/barcelona-2016/travel/
 * Looking a little further forward, Foundation have now announced that the first Project Team Gathering (PTG) will be held in Atlanta, US, on Feb 20-24: http://www.openstack.org/ptg

Doc team meeting
Next meetings:

The APAC meeting was skipped this week.

Next meetings: US: Wednesday 28 September, 19:00 UTC APAC: Wednesday 5 October, 00:30 UTC

These two meetings will be the final meetings before release day.

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#23_September_2016

= 16 September 2016 =

Hi everyone,

Newton goes out in three weeks, and the release team and I have been busy working with our cross-project liaisons to ensure the docs suite is up to date and ready to go. Don't forget that you can contact any of us (or just send mail to the docs mailing list) if you have any questions about the Newton docs release.

This week, I've also been working on Summit planning, and drafting my PTL candidacy, which you can read here: http://lists.openstack.org/pipermail/openstack-docs/2016-September/009112.html Big thanks to everyone who has emailed me over the past few days to offer their support. Knowing you all have my back is the reason I keep doing this :)

Progress towards Newton
19 days to go!

Bugs closed so far: 444

Release managers: Olena Logvinova and Alexandra Settle

Release tasks are being tracked here: https://etherpad.openstack.org/p/NewtonRelease

Install Guide testing is being tracked here: https://wiki.openstack.org/wiki/Documentation/NewtonDocTesting

The Road to Barcelona

 * I have a draft schedule starting to take shape, which you can see here: https://etherpad.openstack.org/p/Ocata-DocsSessions I'll put this into Sched once the tool becomes available, and your early feedback is welcome. Additionally, if you're interested in moderating a session in Barcelona, please let me know.
 * By now, you should be well on the way to having your travel and accommodation booked for Barcelona. In case you're still working on it, though, there's travel information available on the Summit site here: https://www.openstack.org/summit/barcelona-2016/travel/
 * Looking a little further forward, Foundation have now announced that the first Project Team Gathering (PTG) will be held in Atlanta, US, on Feb 20-24: http://www.openstack.org/ptg

Speciality Team Reports
This will be the last Speciality Team report before we release Newton, as focus shifts to final preparations, testing, and release notes. I'd like to take this opportunity to thank all our speciality team leads, who work very hard behind the scenes to keep their books in top shape, and their teams working together towards a common goal. Our docs suite wouldn't be what it is without these hard working people.

HA Guide: Andrew Beekhof No report this week.

Install Tutorials: Lana Brindley Core Guide testing is underway! Check out progress and sign up here: https://wiki.openstack.org/wiki/Documentation/NewtonDocTesting Next meeting: 27 September August 0600UTC.

Networking Guide: Edgar Magana No report this week.

Security Guide: Nathaniel Dillon No report this week.

User Guides: Joseph Robinson No report this week.

Ops Guide: Shilla Saebi, Darren Chan No report this week.

API Guide: Anne Gentle Working with teams who want to write guides similar to FirstApp: Murano and Heat for example. This patch moves Cinder v1 API to Deprecated: https://review.openstack.org/#/c/370407/ Thanks Mark Voelker for all the links to go with the patch!

Config/CLI Ref: Tomoyuki Kato Updating Configreference for Newton release. We need to help, especially for vendor plug-in configuration.

Training labs: Pranav Salunke, Roger Luethi No report this week.

Training Guides: Matjaz Pancur No report this week.

'''Hypervisor Tuning Guide: Blair Bethwaite No report this week.

UX/UI Guidelines: Michael Tullis, Rodrigo Caballero No report this week.

Doc team meeting
Next meetings:

The US meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-09-14

Next meetings: APAC: Wednesday 21 September, 00:30 UTC US: Wednesday 28 September, 19: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

https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#16_September_2016

= 9 September 2016 =

Hi everyone,

Only four weeks to go until Newton! Andreas, Brian, Olga, and I met with our new release managers Olena and Alex a few days ago, and we're all ready and waiting with bated breath to get started on the release. Don't forget that you can contact any of us (or just send mail to the docs mailing list) if you have any questions about the Newton docs release.

This week, I've also done a core team review, and we bid farewell to two core team members. More on that in this newsletter.

Progress towards Newton
26 days to go!

Bugs closed so far: 428

Release managers: Olena Logvinova and Alexandra Settle

Release tasks are being tracked here: https://etherpad.openstack.org/p/NewtonRelease

Install Guide testing is being tracked here: https://wiki.openstack.org/wiki/Documentation/NewtonDocTesting

The Road to Barcelona

 * If there's something you want to make sure we discuss at Summit, please put your ideas here: https://etherpad.openstack.org/p/Ocata-DocsSessions When we get our room allocations, I'll organise it into a schedule.
 * If you require a visa invitation letter to travel to Spain, then you need to fill out the form here: https://www.openstack.org/summit/barcelona-2016/travel/#visa

Looking a little further forward, Foundation have now announced that the first Project Team Gathering (PTG) will be held in Atlanta, US, on Feb 20-24: http://www.openstack.org/ptg

Core Team Review
The core team have completed their review for August, and I'm a bit sad to announce that both Atsushi Sakai and Gauvain Pocontek are no longer core team members.

Gauvain has been committing to OpenStack manuals since well before my time, and has been an invaluable resource for many people (including myself!) over the years. He is currently working on some new projects, but we hope to still see him around from time to time.

Atsushi-san joined the core team last year, and during that time has proven an extremely effective reviewer. He is still very busy on OpenStack, with an increased focus on cross-project tasks, so we will be sure to still see him around. I wish you well on your endeavours!

I thank you both for your commitment to being core team members, and for all your contributions. We are better because of your effort.

Speciality Team Reports
HA Guide: Andrew Beekhof Organizing a HA meetup at summit Intention is get an update plan finalized shortly

Install Tutorials: Lana Brindley Core Guide testing is underway! Check out progress and sign up here: https://wiki.openstack.org/wiki/Documentation/MitakaDocTesting Next meeting: 13 September August 0600UTC.

Networking Guide: Edgar Magana No report this week.

Security Guide: Nathaniel Dillon No report this week.

User Guides: Joseph Robinson No report this week.

Ops Guide: Shilla Saebi, Darren Chan No report this week.

API Guide: Anne Gentle Working on an article for Super User describing the switchover in API guide sources to project repos and the new navigation.

Config/CLI Ref: Tomoyuki Kato Consolidating the OSC command reference into the OSC specific doc.

Training labs: Pranav Salunke, Roger Luethi No report this week.

Training Guides: Matjaz Pancur Finished first day of our virtual sprint series (6 Sep): Common items: https://etherpad.openstack.org/p/upstream-uni-common-items (coordinated by Ildiko Vancsa, ildikov), Code contribution: https://etherpad.openstack.org/p/upstream-uni-code-contribution (coordinated by Kendall Nelson, diablo_rojo) Next virtual sprint dates: 12,13 and 16 September (https://wiki.openstack.org/wiki/VirtualSprints#Upstream_training_Sprint)

'''Hypervisor Tuning Guide: Blair Bethwaite No report this week.

UX/UI Guidelines: Michael Tullis, Rodrigo Caballero No report this week.

Doc team meeting
Next meetings:

The APAC meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-09-07

Next meetings: US: Wednesday 14 September, 19:00 UTC APAC: Wednesday 21 September, 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#9_September_2016

= 2 September 2016 =

Hi everyone,

We have five weeks left until the Newton release goes out, so this week has been all about getting started on testing the Install Guide. We now have beta releases for all our distros, so thanks to our lovely package maintainers for getting back to me so quickly! We can still use more testers, though, all you need to do is sign up on the wiki page and start testing: https://wiki.openstack.org/wiki/Documentation/NewtonDocTesting

This week Andreas, Brian, Olga, and I will be meeting with our new release managers Olena and Alex, to make sure they're up to speed. Don't forget that you can contact any of us (or just send mail to the docs mailing list) if you have any questions about the Newton docs release.

Progress towards Newton
33 days to go!

Bugs closed so far: 407

Release managers: Olena Logvinova and Alexandra Settle

Install Guide testing is being tracked here: https://wiki.openstack.org/wiki/Documentation/NewtonDocTesting

The Road to Barcelona

 * If there's something you want to make sure we discuss at Summit, please put your ideas here: https://etherpad.openstack.org/p/Ocata-DocsSessions When we get our room allocations, I'll organise it into a schedule.
 * Talk acceptances have gone out, congratulations to everyone who got something accepted!
 * If you require a visa invitation letter to travel to Spain, then you need to fill out the form here: https://www.openstack.org/summit/barcelona-2016/travel/#visa

Docs Tools
There is a lot of cleanup happening on the docs site right now, so you might see some old and unloved content disappear. If you notice anything strange, please let Andreas or the docs mailing list know so we can get it straightened out.

Speciality Team Reports
HA Guide: Andrew Beekhof No report this week.

Install Tutorials: Lana Brindley Core Guide testing is underway! Check out progress and sign up here: https://wiki.openstack.org/wiki/Documentation/MitakaDocTesting Next meeting: 13 September August 0600UTC.

Networking Guide: Edgar Magana No report this week.

Security Guide: Nathaniel Dillon No report this week.

User Guides: Joseph Robinson No report this week.

Ops Guide: Shilla Saebi, Darren Chan No meeting last week in light of the ops mid cycle and OpenStack East conference Updating use cases chapter in Arch Guide Looking for more enterprise troubleshooting docs to push upstream for the ops guide

API Guide: Anne Gentle New landing page for a collection of all API Reference docs and Guides in one place: https://review.openstack.org/#/c/361480/ Improvements to the sidebar link collection: https://review.openstack.org/#/c/362436/

Config/CLI Ref: Tomoyuki Kato Updated some CLI reference. Closed some bugs for Config Reference.

Training labs: Pranav Salunke, Roger Luethi No report this week.

Training Guides: Matjaz Pancur No report this week.

'''Hypervisor Tuning Guide: Blair Bethwaite No report this week.

UX/UI Guidelines: Michael Tullis, Rodrigo Caballero No report this week.

Site Stats
For the month of August, we had a 6% increase in traffic over July.

Doc team meeting
Next meetings:

The US meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-08-31

Next meetings: APAC: Wednesday 7 September, 00:30 UTC US: Wednesday 14 September, 19: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

https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#2_September_2016

= 26 August 2016 =

Hi everyone,

This week marks six weeks left to the Newton release, so I've been busy getting everything prepared. We're now ready to start testing the core Installation Tutorial, so check out the wiki and get signed up: https://wiki.openstack.org/wiki/Documentation/NewtonDocTesting#Testers We've also selected two new release managers to assist with this release, please welcome Olena and Alex! More on those topics in this newsletter.

Progress towards Newton
40 days to go!

Bugs closed so far: 387

Release planning: https://etherpad.openstack.org/p/NewtonRelease

Release Managers
There was an overwhelming response to my request for release managers, which was very cool! The first two responders were Olena Logvinova  and Alexandra Settle , so please welcome them to the release team. Their main role during this process is to make sure that all the tasks we have to complete get done accurately and on schedule. It's an important job, and we're really glad to have you both on board.

Install Tutorial Testing
Install Tutorial testing is just about ready to kick off. If you're interested in helping, make sure you've added your name on to the list on our testing wiki page: https://wiki.openstack.org/wiki/Documentation/NewtonDocTesting (if you don't have wiki access, just email me directly and I'll add you in).

Thanks to our package maintainers, we now have b2 pre-release packages ready for Ubuntu and Debian, so those are ready to be tested.

Docs Tools
I'm very pleased to announce that we have now removed DocBook from our build tools. The end of an era! Thanks to Anne, Andreas, and David Cramer for keeping this project alive for so long, and eventually seeing it come to fruition.

Version 1.5.0 of openstackdoccstheme was released this week.

In other tools news, there are plans afoot to move developer.openstack.org and docs.openstack.org away from Rackspace Cloudsites, and on to pages that OpenStack Infra control. This has been on the proverbial backburner for a long time, but the Infra team is now in a position to make it happen. You can read and comment on the Infra spec here: https://review.openstack.org/#/c/276482/

Speciality Team Reports
HA Guide: Andrew Beekhof No report this week.

Install Tutorials: Lana Brindley Core Guide testing is underway! Check out progress and sign up here: https://wiki.openstack.org/wiki/Documentation/MitakaDocTesting Next meeting: 30 August 0600UTC.

Networking Guide: Edgar Magana Attending the OpenStack East in NYC. No report this week.

Security Guide: Nathaniel Dillon No report this week.

User Guides: Joseph Robinson No report this week.

Ops Guide: Shilla Saebi, Darren Chan No report this week.

API Guide: Anne Gentle Releasing openstackdocstheme with new sidebar and integration with os-api-ref Sphinx Extension. Many thanks to Karen Bradshaw, Sean Dague, Graham Hayes, Andreas Jaeger (and anyone I may have missed!) for their tireless efforts on this release. WOW.

Config/CLI Ref: Tomoyuki Kato Merged some patches, updated a few CLI reference, nothing special.

Training labs: Pranav Salunke, Roger Luethi Some minor changes, backports of features. The parser is almost done. https://github.com/dguitarbite/rst2bash Updated the openstack-manuals, install-guides with the new syntax which is parser friendly. I should start sending the required patches to manuals repo. soon after finalizing the syntax.. https://github.com/dguitarbite/openstack-manuals/commit/c9e7e1bb2c7269f02a757768dd2dd309fa2233ac

Training Guides: Matjaz Pancur Upstream training improvement (https://etherpad.openstack.org/p/upstream-university-improvements). Please consider participating in the Remote content sprint (proposed timeframe: first half of September, see etherpad for details).

'''Hypervisor Tuning Guide: Blair Bethwaite No report this week.

UX/UI Guidelines: Michael Tullis, Rodrigo Caballero No report this week.

Site Stats
Keystone and Ceph are this week's most popular search terms.

Doc team meeting
Next meetings:

The APAC meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-08-24

Next meetings: US: Wednesday 31 August, 19:00 UTC APAC: Wednesday 7 September, 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#26_August_2016

= 19 August 2016 =

Hi everyone,

Watch out, Install Guide testing season is about to begin! If you're a package maintainer, cross-project liaison, or just a helpful testing regular, look out for an email from me real soon now! In the meantime, keep hitting those bugs, and letting us know if you spot any problems in the guide.

Progress towards Newton
47 days to go!

Bugs closed so far: 371

Newton deliverables: https://wiki.openstack.org/wiki/Documentation/NewtonDeliverables Feel free to add more detail and cross things off as they are achieved throughout the release.

Speciality Team Reports
HA Guide: Andrew Beekhof Some reviews, nothing interesting

Install Tutorials: Lana Brindley Core Guide testing to kick off Real Soon Now (tm). Next meeting: 30 August 0600UTC.

Networking Guide: Edgar Magana No report this week.

Security Guide: Nathaniel Dillon No report this week.

User Guides: Joseph Robinson No report this week.

Ops Guide: Shilla Saebi, Darren Chan Reorganized monitoring content in the Ops Guide Migrating ops, legal, and security content in the Arch Guide Working on use cases chapter and design chapter in the Arch Guide

API Guide: Anne Gentle No report this week.

Config/CLI Ref: Tomoyuki Kato A few cleanups are under going. Updated some client references.

Training labs: Pranav Salunke, Roger Luethi No report this week.

Training Guides: Matjaz Pancur No report this week.

'''Hypervisor Tuning Guide: Blair Bethwaite No report this week.

UX/UI Guidelines: Michael Tullis, Rodrigo Caballero No report this week.

Site Stats
Just under 90,000 sessions on the docs site this week.

Doc team meeting
Next meetings:

The US meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-08-17

Next meetings: APAC: Wednesday 24 August, 00:30 UTC US: Wednesday 31 August, 19: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

https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#19_August_2016

= 12 August 2016 =

Hi everyone,

I have been struck down with flu yet again this week, so a quiet one from me (I'll be glad when winter is over, let me tell you!). Anne, however, has been kicking it out of the park with her work on the API docs; I suggest you take a look at the update she sent to the mailing lists the other day to catch up: http://lists.openstack.org/pipermail/openstack-dev/2016-August/101380.html

Progress towards Newton
54 days to go!

Bugs closed so far: 365

Newton deliverables: https://wiki.openstack.org/wiki/Documentation/NewtonDeliverables Feel free to add more detail and cross things off as they are achieved throughout the release.

Speciality Team Reports
HA Guide: Andrew Beekhof No report this week.

Install Tutorials: Lana Brindley Next meeting: 16 August 0600UTC

Networking Guide: Edgar Magana No report this week.

Security Guide: Nathaniel Dillon Bug hunt continued, all contributions are welcome, grammatical and technical alike! Focusing on the last half of the SecurityGuide, and the 'freshness' of code examples Threat analysis documentation and templates added

User Guides: Joseph Robinson The Consistency and Editing patch is ready to merge, and just needs more reviews https://review.openstack.org/#/c/347641/. Some pages in the User Guides are resulting in 404s (dashboard manage shares for example), and this bug is tracking the changes https://bugs.launchpad.net/openstack-manuals/+bug/1611792 Thanks to Maria for taking on the file name changes to the User Guide, and Anne for also patching the Admin Guide file names!

Ops Guide: Shilla Saebi, Darren Chan Working on storage, networking, and compute sections in the Arch Guide. Arch Guide working group proposed a series of short sprints, working in pairs as SME/writer. Dates TBD Waiting on enterprise ops documentation to migrate to the Ops Guide.

API Guide: Anne Gentle Ceilometer migrated content has landed! \o/ https://review.openstack.org/334028 Many thanks to Khushbu Parakh for sticking with it, and to Julien Danjou and Gordon Chung for accepting the (rather outdated) migrated content and taking responsiblity for it from now on. Working on a template for http-status.yaml file that teams can use for new pretty HTTP Status code tables that just landed last week. https://review.openstack.org/#/c/351835/ Ever closer to landing the API reference navigation. https://review.openstack.org/#/c/329508/ Refer to status report on -dev and -docs mailing lists: http://lists.openstack.org/pipermail/openstack-dev/2016-August/101380.html

Config/CLI Ref: Tomoyuki Kato Closed a few bugs with mitaka backport.

Training labs: Pranav Salunke, Roger Luethi No report this week.

Training Guides: Matjaz Pancur Updating Upstream training for the next OpenStack Summit (https://etherpad.openstack.org/p/upstream-university-improvements) Next meeting: Monday 15 August 1700 UTC in #openstack-meeting

'''Hypervisor Tuning Guide: Blair Bethwaite No report this week.

UX/UI Guidelines: Michael Tullis, Rodrigo Caballero No report this week.

Site Stats
This week, 385 visitors came to the docs site from Stack Overflow, 423 visitors came via searching on duckduckgo, and 508 came from ask.openstack.org.

Doc team meeting
Next meetings:

The APAC meeting failed to make quorum this week, but thanks to Darren for trying anyway :)

Next meetings: US: Wednesday 17 August, 19:00 UTC APAC: Wednesday 24 August, 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#12_August_2016

= 29 July 2016 =

Hi everyone,

A fairly quiet week this week, as I've been gradually working my way through old bugs. We're now only ten weeks out from release, so I've also been trying to tidy up some loose ends around the Contributor Guide. We have a couple of specs out for review right now, so if you're looking for some docs work to pick up, try checking these out: https://review.openstack.org/#/q/status:open+project:openstack/docs-specs,n,z

Progress towards Newton
68 days to go!

Bugs closed so far: 339

Newton deliverables: https://wiki.openstack.org/wiki/Documentation/NewtonDeliverables Feel free to add more detail and cross things off as they are achieved throughout the release.

Speciality Team Reports
HA Guide: Andrew Beekhof Informal discussions about appropriate contents and structure

Install Tutorials: Lana Brindley Next meeting: 2 August 0600 UTC

Networking Guide: Edgar Magana Guide re-organization patch has been merged: https://review.openstack.org/#/c/345110/

Security Guide: Nathaniel Dillon Performing full read-through and bug hunt Opened 5 new bugs Currently looking at Neutron chapter Incoming addition on rate-limiting and anti-DDoS (framework merged tonight (thanks Kato!) and additional details coming)

User Guides: Joseph Robinson No report this week.

Ops Guide: Shilla Saebi, Darren Chan Weekly Arch Guide working group meeting on Wednesday 20:00 UTC in progress. Currently drafting the Design chapter and reusing existing content. Working on getting more enterprise docs uploaded and pushed upstream for ops guide

API Guide: Anne Gentle First App tutorial for the Shade SDK now moving out of draft state. Way to go Marcela Bonell and infra people who make this SDK possible. Thank you to Kato Tomoyuki for deletions of the Image and Networking WADL files in api-site. This ongoing dedication and cleanup is super valuable and much appreciated.

Config/CLI Ref: Tomoyuki Kato Reflecting comments from Stackers. Closed a few bugs for Configuration Reference. Working on the common configurations.

Training labs: Pranav Salunke, Roger Luethi No report this week.

Training Guides: Matjaz Pancur No report this week.

'''Hypervisor Tuning Guide: Blair Bethwaite No report this week.

UX/UI Guidelines: Michael Tullis, Rodrigo Caballero No report this week.

Site Stats
Just under 55% of our mobile visitors are using an Android operating system to access the site, while just under 40% of our mobile visitors are using iOS. A statistically insignificant 0.07% are still using their Blackberries ...

Doc team meeting
Next meetings:

The APAC meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-07-27

Next meetings: US: Wednesday 3 August, 19:00 UTC APAC: Wednesday 10 August, 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#29_July_2016

= 22 July 2016 =

Hi everyone,

As many of you would have noticed from the email onslaught, I've been working on some Launchpad housekeeping this week. The blueprints are all tidied up now, and I intend to start on the bug list next week, so keep those email filters handy ;)

I'd also like to point out the hard work Andreas has been putting in to evaluate moving our docs jobs to Ubuntu Xenial. If you notice any weirdness, please let Andreas know.

Progress towards Newton
75 days to go!

Bugs closed so far: 315

Newton deliverables: https://wiki.openstack.org/wiki/Documentation/NewtonDeliverables Feel free to add more detail and cross things off as they are achieved throughout the release.

Speciality Team Reports
HA Guide: Andrew Beekhof Got drafted (pun intended) Started figuring out the current status and direction

Install Tutorials: Lana Brindley Next meeting: 2 August 0600 UTC

Networking Guide: Edgar Magana No report this week.

Security Guide: Nathaniel Dillon No report this week.

User Guides: Joseph Robinson No report this week.

Ops Guide: Shilla Saebi, Darren Chan Started a weekly Arch Guide working group meeting on Wednesday 20:00 UTC. Currently drafting the Design chapter and reusing existing content.

API Guide: Anne Gentle Sent email to -dev and -docs list to determine next steps for releasing openstackdocstheme and os-api-ref sphinx extension so we can get the better theming output: http://lists.openstack.org/pipermail/openstack-dev/2016-July/099373.html Released 1.4.0 of openstackdocstheme in preparation for August (hopefully) readiness of theme/extension for unifying API docs navigation. Completed updated of governance/reference/projects.yaml to indicate contributor and api docs URLs. Found that three projects have not completed migration (trove, telemetry/ceilometer, ) and found that nn projects don't use the openstackdocstheme and os-api-ref extension and then won't be included in a unified navigation solution for all OpenStack APIs.

Config/CLI Ref: Tomoyuki Kato Adding Clustering service configuration options. Fixed some bugs. Updated a few CLI reference. Added python-watcherclient.

Training labs: Pranav Salunke, Roger Luethi No report this week.

Training Guides: Matjaz Pancur No report this week.

'''Hypervisor Tuning Guide: Blair Bethwaite No report this week.

UX/UI Guidelines: Michael Tullis, Rodrigo Caballero All five personas are up for review on Gerrit. https://review.openstack.org/#/c/326662/ Further improvements are planned for after the basic information is merged.

HA Guide Speciality Team Update
Bogdan Dobrelya is stepping down from leading the HA Guide Speciality Team, and I would like to thank him for his hard work. I'd like to welcome Andrew Beekhof to the role, and wish him all the best. If you're interesting in helping out on the HA Guide, please let Andrew or me know and we'll get you started.

Site Stats
While 70% of our site traffic comes through Google, just under 5% comes through Baidu, beating Bing on just 1.45%.

Doc team meeting
Next meetings:

The US meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-07-20

Next meetings: APAC: Wednesday 27 July, 00:30 UTC US: Wednesday 3 August, 19: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

https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#22_July_2016

= 15 July 2016 =

Hi everyone,

CFP for the Barcelona Summit closed this week, so I've been caught up in the flurry of talk submissions. I hope you got yours in on time! We have more Installation Tutorials going up all the time, with Swift up and Designate now in progress. I'd also like to remind you all that we have instructions for creating your team's Install Tutorial in our Contributor Guide here: http://docs.openstack.org/contributor-guide/project-install-guide.html We'd love to get your feedback on that content!

Progress towards Newton
82 days to go!

Bugs closed so far: 280

Newton deliverables: https://wiki.openstack.org/wiki/Documentation/NewtonDeliverables Feel free to add more detail and cross things off as they are achieved throughout the release.

The CFP for Barcelona is now closed. Best of luck to everyone who submitted a talk :)

Speciality Team Reports
HA Guide: Bogdan Dobrelya No report this week.

Install Tutorials: Lana Brindley Continued to publish new guides, Swift is now up, Designate is on review. Submitted Summit talk on this topic. Don't miss our insstructions for creating a new Install Tutorial:http://docs.openstack.org/contributor-guide/project-install-guide.html Next meeting: 19 July 0600 UTC

Networking Guide: Edgar Magana No meeting this week.

Security Guide: Nathaniel Dillon No report this week.

User Guides: Joseph Robinson No report this week.

Ops Guide: Shilla Saebi OpenStack ops guide reorg in progress & documented here: https://etherpad.openstack.org/p/ops-guide-reorg Added enterprise docs troubleshooting information to the Ops Guide

API Guide: Anne Gentle Keystone API sprint this week, details are here: https://etherpad.openstack.org/p/keystone-api-sprint Lance Bragstad is on FIRE! Review these api-ref patchsets in progress: https://review.openstack.org/#/q/status:open+file:api-ref Working on a plan for how to merge HTTP Status Code tables and Graham Hayes's patch to use the openstackdocstheme and Karen Bradshaw's overall API navigation in time for release, stay tuned.

Config/CLI Ref: Tomoyuki Kato Got feedbacks from Dolph Matthews, thank you! Closed a few bugs. Updated some CLI reference.

Training labs: Pranav Salunke, Roger Luethi Many minor improvements to training-labs library scripts Finalzing PXE feature, still more work is required but the current patch should be in a state to be merged soon. Finalizing parser POC to parse install-guides to BASH for testing install guides and also auto-creation of guest side scripts for training-labs

Training Guides: Matjaz Pancur Removed unused images for Training guides, improvements on Getting Started (core and optional services, link updates).

'''Hypervisor Tuning Guide: Blair Bethwaite No report this week.

UX/UI Guidelines: Michael Tullis, Rodrigo Caballero No report this week.

Core Team Review
Regretfully, Diane Fleming is no longer a core team member. I'd like to thank Diane for all her contributions to our team. She's been a powerhouse core team member since well before I did my very first OpenStack patch, and I think it's fair to say that many of us wouldn't be here without Diane's support and guidance.

Site Stats
The number of people browsing the site using Opera has dropped by 5% over the past 30 days, but nearly 20% more people are using Edge (which I'm told is the new Windows browser that's replacing IE). Oddly, IE users have increased slightly as well, though, by 7%. Are people abandoning their Macs?!

Doc team meeting
Next meetings:

The APAC meeting was held this week (big thanks to Joseph for chairing that meeting in my absence!), you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-07-13

Next meetings: US: Wednesday 20 July, 19:00 UTC APAC: Wednesday 27 July, 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#15_July_2016

= 8 July 2016 =

Hi everyone,

This week I'm pleased to report that the index page for the new Install Guides Tutorials is up and running! We also had some lengthy discussions about the use of conditionalised formatting (with ``only``), so there were a few meaty topics to go through in the meeting this week. It's also been way too long since we last did a core team review, so that happened this week. I'd also like to remind you that the CFP for Barcelona is only open until mid next week, so get your proposals in soon!

Progress towards Newton
89 days to go!

Bugs closed so far: 256

I think 50 bugs in two weeks is something of a record! Thanks to all the bug smashers working hard this week :)

Newton deliverables: https://wiki.openstack.org/wiki/Documentation/NewtonDeliverables Feel free to add more detail and cross things off as they are achieved throughout the release.

The CFP for Barcelona is open now, until 13 July. If you want to brainstorm some documentation-related ideas, please get in touch!

Speciality Team Reports
HA Guide: Bogdan Dobrelya No report this week.

Install Guide: Lana Brindley Index page is now up, needs some iteration to improve. Decided against using ``only`` for now (review after Newton), Manila patch to be updated. Next meeting: 19 July 0600 UTC

Networking Guide: Edgar Magana No meeting this week. Keep trying to move documentation from other dispersed places to the networking guide.

Security Guide: Nathaniel Dillon No report this week.

User Guides: Joseph Robinson Adding the consistency notes to the work items wiki page. Team emails.

Ops Guide: Shilla Saebi No report this week.

API Guide: Anne Gentle Sign up on the etherpad to participate in a keystone Identity API sprint: https://etherpad.openstack.org/p/keystone-api-sprint New patch this week to migrate the ceilometer Telemetry API docs, please review: https://review.openstack.org/334028 Thank you Khushbu! Need another +2 from the swift team for their migration patch: https://review.openstack.org/#/c/312315/ Updated patch in the governance repo projects.yaml file to indicate both contributor docs URLs and API docs URLs: https://review.openstack.org/#/c/316396/ Consider a work in progress for URL completeness and accuracy, but please review for format. Responding to input about API versions and release versions. See http://lists.openstack.org/pipermail/openstack-docs/2016-July/008818.html

Config/CLI Ref: Tomoyuki Kato Closed many bugs. Implementing common configuration sections for shared services and libraries. Updated a few clients reference, and added solum client.

Training labs: Pranav Salunke, Roger Luethi No report this week.

Training Guides: Matjaz Pancur No report this week.

'''Hypervisor Tuning Guide: Blair Bethwaite No report this week.

UX/UI Guidelines: Michael Tullis, Rodrigo Caballero Three out of the five personas have been created and are being reviewed. https://review.openstack.org/#/c/326662/ The last two personas will be added to the change within the week. It was suggested to add a checklist for developers to be able to identify the appropriate persona for their work.

Core Team Review
The core team have completed their review for July, and we would like to welcome Joseph Robinson to the openstack-doc-core team.

Joseph has been leading the User Guides speciality team for some time now, and has been a docs-specs-core as part of that role. Welcome to the larger core team, Joseph, we're really pleased to have you aboard :)

Site Stats
25% of our hits are coming from new (rather than returning) users.

Doc team meeting
Next meetings:

The US meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-07-06

Next meetings: APAC: Wednesday 13 July, 00:30 UTC US: Wednesday 20 July, 19: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

https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#8_July_2016

= 24 June 2016 =

Hi everyone,

We're starting to see a real rush of projects publishing their Install Guides this week, which is really exciting! We're also working on getting the index page on docs.openstack.org up and running, so we should have that ready to go up by the time I'm writing this newsletter next week. Well done to all the docs people, and the cross-project liaisons who have been working hard to make this happen. It's great to see it all start to come together :)

Progress towards Newton
103 days to go!

Bugs closed so far: 207

Newton deliverables: https://wiki.openstack.org/wiki/Documentation/NewtonDeliverables Feel free to add more detail and cross things off as they are achieved throughout the release.

Also, just a note that the CFP for Barcelona is open now, until 13 July. If you want to brainstorm some documentation-related ideas, please get in touch!

Speciality Team Reports
HA Guide: Bogdan Dobrelya No report this week.

Install Guide: Lana Brindley Swift, Manila patches in progress. Petr is working on the index page: https://review.openstack.org/331704 Feedback requested! Next meeting: 5 July 0600 UTC

Networking Guide: Edgar Magana No report this week.

Security Guide: Nathaniel Dillon No report this week.

User Guides: Joseph Robinson No report this week.

Ops Guide: Shilla Saebi Team is currently reviewing enterprise ops documentation to incorporate into the Ops Guide. Ops tasks are documented here: https://etherpad.openstack.org/p/ops-arch-tasks OpenStack ops guide reorg in progress & documented here: https://etherpad.openstack.org/p/ops-guide-reorg Members of the ops guide team are joining ops meetings to find volunteers

API Guide: Anne Gentle Progress ongoing on navigation for multiple OpenStack APIs: https://review.openstack.org/#/c/329508 Working on lists of project's API references that don't use RST+YAML framework: http://lists.openstack.org/pipermail/openstack-docs/2016-June/008775.html

Config/CLI Ref: Tomoyuki Kato Got some comments for improvements from Brian Rosmaita, Hemanth Makkapati and Richard Jones. Thank you! Closed many bugs for Configuration Reference. Updated openstack, glance, neutron-sanity-check, and trove-manage CLI reference.

Training labs: Pranav Salunke, Roger Luethi Webpage is looking good and also all the URL's point to the right link http://docs.openstack.org/training_labs/ Trying to finalize PXE support https://review.openstack.org/#/c/305991/

Training Guides: Matjaz Pancur Italian translation of the Upstream training Details about running a Lego session (https://review.openstack.org/#/c/325020/, https://review.openstack.org/#/c/330819/)

'''Hypervisor Tuning Guide: Blair Bethwaite No report this week.

UX/UI Guidelines: Michael Tullis, Rodrigo Caballero No report this week.

Site Stats
The top five search terms on the site so far during June: snapshot, cinder, nova, security group, quota

Doc team meeting
Next meetings:

The US meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-06-22

Next meetings: APAC: Wednesday 29 June, 00:30 UTC US: Wednesday 6 July, 19: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

https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#24_June_2016

= 17 June 2016 =

Hi everyone,

This week I've very pleased to announce that we have our first project-specific Install Guide published! Petr Kovar got Heat over the line in first place, and it's looking great: http://docs.openstack.org/project-install-guide/orchestration/draft/index.html Well done Petr, and of course all the wonderful docs people who helped us get to this point. We're also expecting to see Trove published very soon. I've been using the lessons learned from these early projects to flesh out our instructions a little more, so it should be even easier for projects to get their Install Guides up and running. We still need to create the central index, but it's all starting to come together now.

I'm also excited to announce that, for the very first time, we have a specific Ops Cross-Project Liaison. Please welcome Robert Starmer to the CPL family :)

Progress towards Newton
110 days to go!

Bugs closed so far: 185

Newton deliverables: https://wiki.openstack.org/wiki/Documentation/NewtonDeliverables Feel free to add more detail and cross things off as they are achieved throughout the release.

Also, just a note that the CFP for Barcelona is open now, until 13 July. If you want to brainstorm some documentation-related ideas, please get in touch!

Speciality Team Reports
HA Guide: Bogdan Dobrelya No report this week.

Install Guide: Lana Brindley Orchestration is done! Well done, Petr :) Working on updating instructions in the Contributor Guide. Instructions: http://docs.openstack.org/contributor-guide/project-install-guide.html Next meeting: Tue 21 June 0600 UTC

Networking Guide: Edgar Magana No report this week.

Security Guide: Nathaniel Dillon No report this week.

User Guides: Joseph Robinson Began a consistency and IA plan, and held the US meeting. Emailing one new interested contributor.

Ops Guide: Darren Chan Some architecture content moved from the Ops Guide to the draft Arch Guide. Patches will be submitted to remove old content from the Ops Guide. Team is currently reviewing enterprise ops documentation to incorporate into the Ops Guide.

API Guide: Anne Gentle Check out all the open reviews for api-ref: https://review.openstack.org/#/q/status:open+file:api-ref Nice. Went to weekly team meeting for swift, landed build patch for swift's api-ref, responding to reviews. Noodling with Karen Bradshaw about API navigation, https://review.openstack.org/#/c/329508/ (though I can't take any credit for the work!)

Config/CLI Ref: Tomoyuki Kato Closed many bugs continuously. Started working on the common configurations for shared services and libraries.

Training labs: Pranav Salunke, Roger Luethi No report this week.

Training Guides: Matjaz Pancur No report this week.

'''Hypervisor Tuning Guide: Blair Bethwaite No report this week.

UX/UI Guidelines: Michael Tullis, Stephen Ballard No report this week.

Training Guides/Labs Core Team Changes
We've adjusted the training guides and labs core teams so that speciality team leads are core in their own repos, and the docs core team is an 'included group' in both repos. This is intended to stop the core teams for these groups drifting out of date too quickly. Note that it is expected that docs cores will not be the primary reviewers/mergers for training repos, but are there as backup in case extra eyes are needed. That responsibility will continue to lie with the training teams themselves, as they know the codebase the best.

You can see the updated core team lists here: Training Guides: https://review.openstack.org/#/admin/groups/uuid-3490bf37012cb344104cb315f3dd5c76dabea62f,members Training Labs: https://review.openstack.org/#/admin/groups/1118,members

Site Stats
During May the top viewed book was the Mitaka Ubuntu Install Guide, followed closely by the Mitaka RDO Install Guide. Rolling into third place was the Admin Guide.

Also, apologies for an error I made in this section last week. The correct number for the total number of views in May was 2,365,626.

Doc team meeting
Next meetings:

The APAC meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-06-15

Next meetings: US: Wednesday 22 June, 19:00 UTC APAC: Wednesday 29 June, 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#17_June_2016

= 10 June 2016 =

Hi everyone,

My week has been spent on the Install Guide, and a big thanks to Andreas for getting the Infra patch up and documenting the new process. The Install Guide team meeting was well attended this week, and I've been following up on the actions from that. I also contacted the cross project liaisons with the information they need to get their content moved, and I'm looking forward to seeing some of these start work next week.

In other news, Joseph has been busy reviewing the User Guides, and could use a little help working on the information architecture, and getting a few new projects documented. User Guide meetings are held in US and APAC timezones and volunteers are essential to get this effort complete for Newton. Get all the info here: https://wiki.openstack.org/wiki/User_Guides

Progress towards Newton
117 days to go!

Bugs closed so far: 163

Newton deliverables: https://wiki.openstack.org/wiki/Documentation/NewtonDeliverables Feel free to add more detail and cross things off as they are achieved throughout the release.

Speciality Team Reports
HA Guide: Bogdan Dobrelya No report this week.

Install Guide: Lana Brindley Infra patch: https://review.openstack.org/#/c/326039/ Instructions: http://docs.openstack.org/contributor-guide/project-install-guide.html Next meeting: Tue 21 June 0600 UTC

Networking Guide: Edgar Magana No meeting this week. Working on a better ToC for the guide that may impact of the of scenarios. Moving more networking content from other guides into the Networking one in order to keep everything in one central point and better updated.

Security Guide: Nathaniel Dillon No report this week.

User Guides: Joseph Robinson Outstanding Tasks - Contacting more project teams for inclusion status, IA plans for the new guide. Some team discussion on fixing old links - contact me if anyone is interested in contributing more content to the User Guides team.

Ops Guide: Shilla Saebi Ops tasks are documented here: https://etherpad.openstack.org/p/ops-arch-tasks OpenStack ops guide reorg in progress & documented here: https://etherpad.openstack.org/p/ops-guide-reorg Working on posting enterprise docs for cleanup. Looking for volunteers in ops/arch docs group to attend ops specific meetings to find additional info and help.

API Guide: Anne Gentle Call for help for unified all-OpenStack API navigation design: http://lists.openstack.org/pipermail/openstack-docs/2016-June/008730.html Discussing project-level organization in https://review.openstack.org/312259 Discussing source organization in https://review.openstack.org/314819 Redirects and deletions in api-site are welcomed! For example, see https://review.openstack.org/327399 Updated README for api-site: https://review.openstack.org/327395

Config/CLI Ref: Tomoyuki Kato Closed a few bugs continuously. Cleaned up many bugs about tool-generated configuration options that are already released for Mitaka. **We need folks for vendor plug-in docs from each vendor.**

Training labs: Pranav Salunke, Roger Luethi Working on the training-labs landing page to make it look much better. Reintroducing the tooling to build zip files. Working on PXE support for baremetal provisioning. Working on Python port of training-labs.

Training Guides: Matjaz Pancur No report this week.

'''Hypervisor Tuning Guide: Blair Bethwaite No report this week.

UX/UI Guidelines: Michael Tullis, Stephen Ballard No report this week.

Site Stats
During May, the docs.openstack.org site had 620 sessions, with just under 20% by new users. The average time of all sessions for the month was about 5 and a half minutes, looking at an average of 3 and a half pages.

Doc team meeting
Next meetings:

The US meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-06-08

Next meetings: APAC: Wednesday 15 June, 00:30 UTC US: Wednesday 22 June, 19: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

https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#10_June_2016

= 3 June 2016 =

Hi everyone,

I'm very pleased to be able to announce the results of our Install Guide naming poll this week. We ended up with 31 responses, and a very clear winner in "OpenStack Installation Tutorial". Thank you to everyone who voted! Also, just a note that I'm still very much in need of representatives from the various project teams to pitch in and help us get things running. Please make sure your project is represented by coming along to meetings, or at least contacting us through the mailing list.

This week I've also spent some time with the Upstream training team, identifying gaps in the current material, and preparing for Barcelona.

Progress towards Newton
124 days to go!

Bugs closed so far: 134

Newton deliverables https://wiki.openstack.org/wiki/Documentation/NewtonDeliverables Feel free to add more detail and cross things off as they are achieved throughout the release.

Speciality Team Reports
HA Guide: Bogdan Dobrelya No report this week.

Install Guide: Lana Brindley Poll concluded, winner is "OpenStack Installation Tutorial". Connected with CPLs this week to encourage more participation. Next meeting: Tue 7 June 0600 UTC.

Networking Guide: Edgar Magana Moved DHCP HA chapter to Networking Guide for better maintenance and updates. Planning to move more sections and focus on DVR HA. Suffering of very low attendance for the IRC meeting.

Security Guide: Nathaniel Dillon No report this week.

User Guides: Joseph Robinson Some contact with the Magnum team. Held meetings, brought up the link changes, which is something I most need some assistance with. IA plan still forthcoming.

Ops Guide: Shilla Saebi No report this week.

API Guide: Anne Gentle New layout for API reference docs from additions to openstackdocs theme. Also already added four-color scheme for GET/PUT/POST/DELETE Thanks Graham Hayes! Work in progress here: https://api.os.gra.ham.ie/compute/ Reviews: https://review.openstack.org/#/q/project:openstack/openstackdocstheme+status:open and https://review.openstack.org/#/q/project:openstack/os-api-ref+status:open Discussion on SDKs and FirstApp audience happening on user-committee list: http://lists.openstack.org/pipermail/user-committee/2016-May/000889.html

Config/CLI Ref: Tomoyuki Kato Closed some bugs with Mitaka backport. Fixed the incorrect RST markup at the new options section, with generation tool update.

Training labs: Pranav Salunke, Roger Luethi No report this week.

Training Guides: Matjaz Pancur Upstream training updates, Barcelona schedule.

'''Hypervisor Tuning Guide: Blair Bethwaite No report this week.

UX/UI Guidelines: Michael Tullis, Stephen Ballard The first prototype of content was presented and source information gaps were identified. A first draft will be complete by June 9.

Site Stats
In the Install Guide naming poll, "OpenStack Installation Tutorial" finished with 29% of the vote, well ahead of "OpenStack Evaluation Setup Guide" at 19%, and "Basic Install Guide" at 16%. And, because charts are fun, here are the final results: https://docs.google.com/spreadsheets/d/1VlNFebI_KFobs-XIT5oRhULRymwrqON8SV9pH4uiYIQ/pubchart?oid=2070399201&format=image

I personally thought "OpenStack from Scratch" was the most creative title. And the potentially confusing "Manual Install Guide" ("Guided Install Manual"?) had a small following at just under 10% of the vote. Thanks for all the great suggestions :)

Doc team meeting
Next meetings:

The APAC meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-06-01

Next meetings: US: Wednesday 8 June, 19:00 UTC APAC: Wednesday 15 June, 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#3_June_2016

= 27 May 2016 =

Hi everyone,

This week I've been focused on getting the Install Guide project back up and running, with the team meeting being rebooted, our specs finally merged, and organising the list of tasks to be getting on with. Also, don't forget to vote in our naming poll: [link redacted for wiki] I'm still very much in need of representatives from the various project teams to pitch in and help us get things running. Please make sure your project is represented by coming along to meetings, or at least contacting us through the mailing list.

In other news, the Ops and Arch Guide re-architecture is proceeding apace. Specs were merged this week, and the new Arch Guide ToC is looking great! Check it out here: http://specs.openstack.org/openstack/docs-specs/specs/newton/arch-guide-restructure.html We are also still looking for feedback on the current Ops guide. Add your notes here: https://etherpad.openstack.org/p/ops-guide-reorg

Progress towards Newton
131 days to go!

Bugs closed so far: 107

Newton deliverables https://wiki.openstack.org/wiki/Documentation/NewtonDeliverables Feel free to add more detail and cross things off as they are achieved throughout the release.

Speciality Team Reports
HA Guide: Bogdan Dobrelya No report this week.

Install Guide: Lana Brindley Specs are now merged, an blueprints created. Tasks listed here: https://wiki.openstack.org/wiki/Documentation/InstallGuideWorkItems Please go ahead and pick up work items. Need project representation in meetings. Next meeting: Tue 7 June 0600 UTC

Networking Guide: Edgar Magana We did not have meeting this week. Nothing to report. Next IRC meeting: Thursday June 2nd at 1600 UTC

Security Guide: Nathaniel Dillon No report this week.

User Guides: Joseph Robinson Action items to follow up - email meeting minutes to the mailing list to update the community. Currently, the team has two contributors. Please let me know if you're interested in working on the User Guide Team.

Ops Guide: Shilla Saebi Shilla & Darren working on collecting enterprise docs to push upstream Ops tasks are documented here: https://etherpad.openstack.org/p/ops-arch-tasks OpenStack ops guide reorg in progress & documented here: https://etherpad.openstack.org/p/ops-guide-reorg Spec was merged: https://review.openstack.org/#/c/311998/

API Guide: Anne Gentle No report this week.

Config/CLI Ref: Tomoyuki Kato A few configuration docs patches for some vendor plug-ins has been merged, with mitaka backport. Heat CLI is marked as deprecated.

Training labs: Pranav Salunke, Roger Luethi No report this week.

Training Guides: Matjaz Pancur Updates for Upstream training material

'''Hypervisor Tuning Guide: Blair Bethwaite No report this week.

UX/UI Guidelines: Michael Tullis, Stephen Ballard No report this week.

Site Stats
This month, two thirds of our site visitors have been using their Mac to read the docs. Just under 30% used Windows, and Linux rounded out the remainder at 4%.

So far in the Install Guide naming poll, "OpenStack Installation Tutorial" has a commanding lead at 30%, with "Basic Install Guide" and "OpenStack Evaluation Setup Guide" (try saying that ten times fast!) tying for second place with 17% of the vote each. I'll keep the poll open for another week or so, and announce our winning name in next week's newsletter.

Doc team meeting
Next meetings:

The US meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-05-25

Next meetings: APAC: Wednesday 1 June, 00:30 UTC US: Wednesday 8 June, 19: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

https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#27_May_2016

= 20 May 2016 =

Hi everyone,

I've been struck down by the dreaded flu this week, so it's been a bit quiet around here. I have, however, crawled out from under the tissues, throat lozenges, and episodes of Containment to pen my regular newsletter for you. See how dedicated I am to the cause? ;)

The biggest updates this week have been on the API side of the ship, with the api-site bug list cleared out. Well done to Anne and Atsushi-san for the heavy lifting there. We also saw a lot of speciality team meetings kick off again this week, with more coming next week, so keep an eye on the mailing list and your ical for the projects you're interested in. We have also now hit our stride on the regular docs meetings, with the APAC meeting held this week, and the US one rolling around again next week. If you're a docs cross-project liaison, make sure you check out the timing and pick one that works for you, so we can make sure we're discussing *your* project.

Progress towards Newton
138 days to go!

Bugs closed so far: 89

Newton deliverables https://wiki.openstack.org/wiki/Documentation/NewtonDeliverables Feel free to add more detail and cross things off as they are achieved throughout the release. I will also do my best to ensure it's kept up to date for each newsletter.

Speciality Team Reports
HA Guide: Bogdan Dobrelya No report this week.

Install Guide: Lana Brindley Meetings start up next week: http://eavesdrop.openstack.org/#Documentation_Install_Team_Meeting Cookie cutter has been merged, repo here: http://git.openstack.org/cgit/openstack/installguide-cookiecutter/ Need to merge spec: https://review.openstack.org/#/c/310588

Networking Guide: Edgar Magana We have successfully changedthe bi-weekly meeting schedule from odd to even weeks. There will not be meetingthis week. Next meeting will be on June 2nd.

Security Guide: Nathaniel Dillon No report this week.

User Guides: Joseph Robinson Team Meeting restarted - Just me this week, I'll send a summary to the mailing list to keep everyone up to date, and if anyone is interested in joining in. Python SDK file moving - one item left from the Mitaka patch - Finding a location to move these files - dev and doc mailing list email forthcoming on where to put these files.

Ops Guide: Shilla Saebi No report this week.

API Guide: Anne Gentle The extension, os-api-ref, is now available via Pypi so that all projects can re-use it with test-requirements.txt. Thanks Sean Dague for this effort! Several projects have reviews in progress for their API reference conversion: glance https://review.openstack.org/#/c/312259/, manila https://review.openstack.org/#/c/313874, neutron https://review.openstack.org/#/c/314819, swift https://review.openstack.org/#/c/312315/, trove https://review.openstack.org/#/c/316381. (There are probably more but those are on my radar). Please review the response code table at https://review.openstack.org/#/c/318281/ and http://i.imgur.com/onsRFtI.png for your use cases for API reference docs.

Config/CLI Ref: Tomoyuki Kato No report this week.

Training labs: Pranav Salunke, Roger Luethi No report this week.

Training Guides: Matjaz Pancur Work on the slides for Training guides (https://review.openstack.org/#/c/295016/) Feedback about Upstream training in Austin (see http://eavesdrop.openstack.org/meetings/training_guides/2016/training_guides.2016-05-16-17.02.html)

'''Hypervisor Tuning Guide: Blair Bethwaite Hi! I'm going to try looking after this for a while as Joe focusses on other things. Not promising much at this point beyond a little wiki gardening, but longer term I hope to align it with some activities in the scientific-wg (which I'm co-chairing with Stig Telfer), and it will probably become a point of reference for some of the activities we already have planned this cycle.

UX/UI Guidelines: Michael Tullis, Stephen Ballard No report this week.

Site Stats
While 90% of our readers have their browsers set to US English, just under 8% browse in Chinese, and a mere 0.15% use British English. That last one might be just me ;)

Doc team meeting
Next meetings:

The APAC meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-05-18

Next meetings: US: Wednesday 25 May, 19:00 UTC APAC: Wednesday 1 June, 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#20_May_2016

= 13 May 2016 =

Hi everyone,

Wow, what a busy week! I've been mainly focused on the Install Guide speciality team this week, with gathering interested participants, ensuring our specs are ready to be merged, and setting a new meeting time. I'm also pleased to say that our speciality team reports make a post-Summit comeback in this newsletter.

Just another reminder that all projects should update their cross-project liaison for docs on the wiki here: https://wiki.openstack.org/wiki/CrossProjectLiaisons#Documentation If you're one of the lucky people nominated by your PTL to be a docs CPL, then please do your very best to attend docs meetings in your favourite timezone to make sure we hear the voice of your project when we're making documentation decisions. Details of upcoming docs meetings are at the end of this newsletter every week.

On a related note, it was refreshing to read the conversation from the US meeting this week, and the associated conversation on the mailing lists about developer contributions to documentation. We'd love to find out what it is that prevents you from contributing to the docs, and what the docs team can do to make things that little bit easier for you! Reach out to us either on the dev mailing list (with [docs] in the subject line), or on the docs mailing list at openstack-docs@lists.openstack.org.

Progress towards Newton
145 days to go!

Bugs closed so far: 71

Newton deliverables https://wiki.openstack.org/wiki/Documentation/NewtonDeliverables Feel free to add more detail and cross things off as they are achieved throughout the release. I will also do my best to ensure it's kept up to date for each newsletter.

The Ops and HA Guides now exist in openstack-manuals, and the old repos have now been set to read-only.

We also have the first patch in for the Install Guide 'cookie cutter' template, which is a great start!

Speciality Team Reports
HA Guide: Bogdan Dobrelya No report this week.

Install Guide: Lana Brindley New meeting time proposed: https://review.openstack.org/#/c/314831/ Still need to merge final spec: https://review.openstack.org/#/c/310588/ If you're interested in helping out, add your name here: https://wiki.openstack.org/wiki/Documentation/InstallGuide#Team_members

Networking Guide: Edgar Magana We are planning to resume the meeting next week.

Security Guide: Nathaniel Dillon Summit Recap: https://etherpad.openstack.org/p/austin-docs-workgroup-security Good conversations around API rate limiting, OSSN in-flight, SecGuide work being prep'd (Thanks to Luke Hinds for taking this on!) Added Doc reviewer (Thanks Shilla and welcome!) Will be focusing on Neutron security

User Guides: Joseph Robinson No report this week.

Ops Guide: Shilla Saebi Proposed architecture guide restructure: https://review.openstack.org/#/c/311998/ Ops guide session Etherpad from Austin: https://etherpad.openstack.org/p/AUS-ops-Docs-ops-guide OpsGuide reorg: https://etherpad.openstack.org/p/PAO-ops-ops-guide-fixing Newton Plans: Review content of both guides, and delete anything out of date Review architecture of both guides, and possibly combine Ops Guide in openstack-manuals repo Gather content from Ops internal documentation

API Guide: Anne Gentle All but two services have someone working on landing a migration patch in the project's repo. Read: Status on bugs and migration http://lists.openstack.org/pipermail/openstack-docs/2016-May/008624.html Read: Summit session recap http://lists.openstack.org/pipermail/openstack-dev/2016-May/094472.html

Config/CLI Ref: Tomoyuki Kato Discussing documenting auto generation of config options with Oslo team. Dropped keystone command-line client from CLI reference. Keystone CLI was removed in python-keystoneclient 3.0.0 release.

Training labs: Pranav Salunke, Roger Luethi Working on adding new features like PXE boot. Stabilizing current release and backends. Figuring out the zip file generation and web site/page. Chaging the meeting time to more CET/CEST friendly time.

Training Guides: Matjaz Pancur No report this week.

Hypervisor Tuning Guide: Joe Topjian No report this week.

UX/UI Guidelines: Michael Tullis, Stephen Ballard No report this week.

Site Stats
The interesting fact I'd like to share with you this week is that just over 25% of our viewers this month are new to the site.

Doc team meeting
Next meetings:

The US meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-05-11

Next meetings: APAC: Wednesday 18 May, 00:30 UTC US: Wednesday 25 May, 19: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

https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#13_May_2016

= 6 May 2016 =

Hi everyone,

I hope you all had a safe journey home from Summit, and are now fully recovered from all the excitement (and jetlag)! I'm really pleased with the amount of progress we made this time around. We have a definitive set of goals for Newton, and I'm confident that they're all moving us towards a much better docs suite overall. Of course, the biggest and most important work we have to do is to get our Install Guide changes underway. I'm very excited to see the new method for documenting OpenStack installation, and can't wait to see all our big tent projects contributing to docs in such a meaningful way. Thank you to everyone (in the room and online) who contributed to the Install Guide discussion, and helped us move forward on this important project.

In other news, I've written a wrapup of the Austin design summit on my blog, which you might be interested in: http://lanabrindley.com/2016/05/05/openstack-newton-summit-docs-wrapup/

Progress towards Newton
152 days to go!

Bugs closed so far: 61

Because we have such a specific set of deliverables carved out for Newton, I've made them their own wiki page: https://wiki.openstack.org/wiki/Documentation/NewtonDeliverables Feel free to add more detail and cross things off as they are achieved throughout the release. I will also do my best to ensure it's kept up to date for each newsletter.

One of the first tasks we've started work on after Summit is moving the Ops and HA Guides out of their own repositories and into openstack-manuals. As a result, those repositories are now frozen, and any work you want to do on those books should be in openstack-manuals.

We are almost ready to publish the new RST version of the Ops Guide, there's just a few cleanup edits going in now, so make sure you have the right book, in the right repo from now on. This was our very last book remaining in DocBook XML, so the docs toolchain will be removing DocBook XML support. See spec https://review.openstack.org/311698 for details.

Another migration note is that the API reference content is moving from api-site to project specific repositories and api-site is now frozen. For more detail, see Anne's email: http://lists.openstack.org/pipermail/openstack-docs/2016-May/008536.html

Mitaka wrapup
We performed a Mitaka retrospective at Summit, notes are here: https://etherpad.openstack.org/p/austin-docs-mitakaretro

In particular, I'd like to call out our hard working tools team Andreas and Christian, all our Speciality Team leads, and the Mitaka release managers Brian and Olga. Well done on a very successful release, everyone :)

Total bugs closed: 645

Site Stats
Thanks to the lovely people at Foundation (thanks Allison!) I now have access to more stats than I could possibly guess what to do with, and I'm hoping to be able to share some of these with you through the newsletter. If there's something in particular you would like to see, then please let me know and I'll endeavour to record it here!

So far I can tell you that docs.openstack.org had 1.63M unique pageviews in April, down slightly from 1.72M in March, and the average session duration is just over six minutes, looking at just under 4 pages per session.

Doc team meeting
Next meetings:

We'll be restarting the meeting series next week.

Next meetings: US: Wednesday 11 April, 19:00 UTC APAC: Wednesday 18 April, 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#6_May_2016

= 1 April 2016 =

Hi everyone,

While it was very tempting to write something something shocking here for April Fools', I thought everyone might have already had their heart rate raised enough by the fact that Mitaka is only five days away! This will be my final docs newsletter before the release, and the docs are in great shape ready to go out.

I would like to sincerely thank Andreas and our release managers Brian and Olga, not only for the hard work they've done so far, but also for holding down the fort over the next few days while I'm out of contact. Please remember to contact them directly if you have any last minute documentation fires that need putting out. I'd also like to mention the hard work that the Installation Guide testers have been putting in over the past couple of weeks. The testing matrix is looking very green (https://wiki.openstack.org/wiki/Documentation/MitakaDocTesting) and I'm confident that we'll get the Mitaka guide out fully tested and on schedule.

Don't forget you can check release progress on the etherpad here: https://etherpad.openstack.org/p/MitakaRelease

Progress towards Mitaka
5 days to go!

558 bugs closed so far for this release.

Docs Testing
 * https://wiki.openstack.org/wiki/Documentation/MitakaDocTesting
 * Only a few items left to check off, at this stage we're good to publish the Ubuntu, RDO, and Suse guides on release day.

Release Tasks:
 * Release planning occurs in our etherpad here: https://etherpad.openstack.org/p/MitakaRelease
 * All tasks that should be completed at this stage are done, and we're on track to start the release process in the 24-48 hours before the release drops.
 * Release notes for the docs project are in a "reno-style" directory in the openstack-manuals repo. This directory is not being managed by Reno, however, so please propose patches to it directly.

The Road to Austin

 * First of all, thanks for the amazing feedback on what docs sessions you would like to see at the Austin Design Summit! We have filled our entire allocation (and then some), and the schedule so far is here: https://etherpad.openstack.org/p/Newton-DocsSessions
 * There's been a really robust and exciting conversation about the Install Guide on the dev list over the past week or so, which I have been following closely. If you're interested in overhauling our Install Guide (and it certainly seems like a lot of people are!), then please make sure you add our Install Guide Design Summit session to your agenda. It is on Wednesday at 11:50, so placed so that it can run over into lunchtime if required.
 * A note for those who noticed the Ops guide omission: this should take place in the Ops track, and I'll let you know when that session will be.

Doc team meeting
Next meetings:

The US meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-03-30

Next meetings: APAC: No APAC meeting this week US: Wednesday 13 April, 19:00 UTC (This is after the Mitaka release)

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#1_April_2016

= 18 March 2016 =

Hi everyone,

It is with great pleasure that I announce that I will be the PTL again for Newton, which will be my third release for openstack-manuals. I'm overwhelmed by the positive messages I've received since announcing my candidacy, and very excited to be leading such a dedicated and innovative group into the fray again. This week I spent some time on the Contributor Guide, working with Brian to get the docs tools documented, which is something we've been wanting to do for some time. Very soon I'll be calling for your ideas on Summit sessions, and beginning to do Design Summit planning. The Install Guide is now in the last push to have everything tested before release, but we can still use your help getting it all done! If you can help, please contact Matt Kassawara, or any docs core.

Progress towards Mitaka
19 days to go!

515 bugs closed so far for this release.

Docs Testing
 * Volunteers required!
 * https://wiki.openstack.org/wiki/Documentation/MitakaDocTesting

Release Tasks:
 * Release planning occurs in our etherpad here: https://etherpad.openstack.org/p/MitakaRelease
 * We're now freezing larger changes to the Install Guide, so cores will not be merging anything that changes the architecture of the guide, or significantly changes the technical content (except where that change is as a result of testing). This is to make the Install Guide testers work a little easier, by stopping the book from moving too much from under them.
 * We will be publishing release notes for our own projects to

Docs-tools

 * Andreas and team have released a new version of the docs theme, which removes the versions information from the sidebar, and also removes the duplicated titles. This should make navigating the CI guides much easier, and reduce confusion over versions.

The Road to Austin

 * PTL elections are now open for those projects that have more than one candidate. You should have received an email for elections in which you are eligible to vote.
 * I am pleased to announce that I am remaining as docs PTL for Newton (elected unopposed). I would also like to congratulate KATO Tomoyuki on becoming the new PTL for i18n, and to thank Daisy for her hard work in that group for many releases.
 * I have requested workrooms and fishbowls for the Austin Design Summit. I'll let you know when we get our allocation. I will send out a note next week to start gathering your ideas for sessions.

Speciality Teams
HA Guide - Bogdan Dobrelya New for Mitaka release notes: Improved Pacemaker/Corosync cluster installation and configuration details http://docs.openstack.org/ha-guide/controller-ha-pacemaker.html (kudos Andrew Beekhof). Pacemaker Cluster Manager http://docs.openstack.org/ha-guide/intro-ha-arch-pacemaker.html and Keepalived http://docs.openstack.org/ha-guide/intro-ha-arch-keepalived.html architecture details and limitations (kudos Andrew Beekhof). Detailed Mariadb/Galera cluster installation, configuration and management guide http://docs.openstack.org/ha-guide/controller-ha-galera.html (kudos Kenneth Dyer). Improved RabbitMQ clustering guide http://docs.openstack.org/ha-guide/controller-ha-rabbitmq.html - HAProxy antipattern explained, new A/A option with Pacemaker resource agents (kudos KATO Tomoyuki, Andrew Beekhof). Many more, so read everything carefully ;-)

User Guides - Joseph Robinson Larger patch for editing submitted this week, and working within the user guide team to reorganize the command line content in the admin user guide by moving common files into the cloud admin guide.

API Docs - Anne Gentle Swagger files now built to developer.openstack.org. Project teams have templates for writing API guides within their project repository.

Doc team meeting
Next meetings:

No meeting was held this week.

Next meetings: APAC: Wednesday 23 March, 00:30 UTC US: Wednesday 30 March, 19: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

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

= 11 March 2016 =

Hi everyone,

This week I've been smashing some older bugs from our queue, and can now confirm that as a team we've closed everything older than a year! What a great effort, and a fabulous way to go into our release period. We have less than a month now before release, so I've been briefing our new release managers Brian and Olga, and have also spent some time speaking to various people about what docs will be releasing for Mitaka. 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
26 days to go!

500 bugs closed so far for this release, which means we're about on par with where we were this time last release. Keep squishing those bugs!

Docs Testing
 * Volunteers required!
 * https://wiki.openstack.org/wiki/Documentation/MitakaDocTesting

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

 * Speaker acceptances have now gone out, and the schedule is available: https://www.openstack.org/summit/austin-2016/summit-schedule/#day=2016-04-24
 * PTL nominations for Newton have now opened: https://wiki.openstack.org/wiki/PTL_Elections_March_2016. I'm very pleased to announce that I will be submitting my candidacy for docs.
 * 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

Speciality Teams
HA Guide - Bogdan Dobrelya No update this week.

Installation Guide - Matt Kassawara No update this week.

Networking Guide - Edgar Magana Progress towards the missing features and new ones for Mitaka. DSCP for QoS section is in good shape: https://review.openstack.org/#/c/273638/ Last Networking Guide meeting: http://eavesdrop.openstack.org/meetings/networking_guide/2016/networking_guide.2016-03-03-16.03.log.html Still missing a lot of attendence to the IRC meeting but we are happy with more contributions to the guide. Matt provided a short overview on how to contribute during the Neutron mid-cycle sessions

Security Guide - Nathaniel Dillon No update this week.

User Guides - Joseph Robinson User Guide APAC and US meetings this week - discussed merging the CLI reorganization patch, which was merged following the meeting. Becuase of a meetbot error, the APAC meeting did not take place, but I am sending a summary out to the mailing list, which I am still working on.

Ops and Arch Guides - Shilla Saebi No update this week.

API Docs - Anne Gentle No update this week.

Bug days: Work on api-site bugs: https://bugs.launchpad.net/openstack-api-site Work on these remaining WADL bugs which have patches: https://review.openstack.org/#/c/288315/    https://review.openstack.org/#/c/283114/ Continue to review and work on bootprint patch. Karin Bradshaw working on CSS updates.

Config Ref - Gauvain Pocentek No update this week.

Training labs - Pranav Salunke, Roger Luethi We merged support for snapshots in the KVM backend. Osbash works now on 32-bit i386 nodes which also makes nested virtualization (creating the whole VM cluster within a VM) possible. There is a new configuration file for users who only want an automated VM cluster setup, but no automated OpenStack installation. Finally, a new feature splits server log files according to cluster build phases, which makes it much easier to identify the origin of a specific log entry.

Training Guides - Matjaz Pancur Enabled automatic bug status resolving at merge (https://review.openstack.org/#/c/283453/) WIP - Upstream training - add toolchain info for trainees (https://review.openstack.org/#/c/286941/)

Hypervisor Tuning Guide - Joe Topjian I included a bunch of links related to NUMA and large memory pages. It'd be nice if the relevant information was pulled from the links and summarized. I also included some information about virtio-scsi.

UX/UI Docs Guidelines - Linette Williams No update this week.

Doc team meeting
Next meetings:

The APAC meeting was held this week. You can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-03-09

Next meetings: US: No meeting this week APAC: Wednesday 23 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#11_March_2016

= 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
 * Volunteers required!
 * https://wiki.openstack.org/wiki/Documentation/MitakaDocTesting

API Docs I'm very pleased to announce that Anne and the API docs team have managed to get HTML generation working directly from Swagger now. This is a massive leap forward for the API docs conversion. Well done to everyone involved!

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 US meeting was held this week, at the new time. You can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-03-02

Next meetings: APAC: Wednesday 9 March, 00:30 UTC US: Wednesday 16 March, 19:00 UTC ***Note the new time!***

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

= 26 February 2016 =

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 :)

Progress towards Mitaka
40 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

Docs Testing
 * Volunteers required!
 * https://wiki.openstack.org/wiki/Documentation/MitakaDocTesting

RST Conversions
 * All planned RST conversions are now complete!

Reorganisations
 * 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
 * Is now complete

The Road to Austin

 * The final round of ATC passes should be going out shortly.
 * 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
HA Guide - Bogdan Dobrelya No update this week.

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.

Networking Guide - Edgar Magana No update this week.

Security Guide - Nathaniel Dillon No update this week.

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.

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

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

Config Ref - Gauvain Pocentek No update this week.

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.

Training Guides - Matjaz Pancur No update this week.

Hypervisor Tuning Guide - Joe Topjian No update this week.

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).

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#26_February_2016

= 19 February 2016 =

Hi everyone,

This week I've been focusing on general housekeeping duties as we prepare to rush headlong into the release. I've cleaned up the blueprints list, and also been burning through the oldest bugs in our queue. I'm very pleased to report that the overall number of bugs has reduced dramatically in the past month or two, and the number of untriaged bugs is holding steady at a much lower rate than previously. I think this probably has a lot to do with the DocImpact changes we made at the beginning of the year, so it's very gratifying to see some solid improvement starting to filter through. In other news, thanks to all those people who helped us with locating pre-release packages for the Install Guide. Please feel free to begin testing! The more people we have testing, the better and more accurate our docs will be, which helps everyone.

Progress towards Mitaka
47 days to go!

417 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

Docs Testing
 * Volunteers required!
 * https://wiki.openstack.org/wiki/Documentation/MitakaDocTesting

RST Conversions
 * All planned RST conversions are now complete!

Reorganisations
 * 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
 * Is now complete

The Road to Austin

 * ATC passes are going out now, so keep an eye on your inbox for your discount code if you haven't received yours yet.
 * Talk voting is now closed
 * 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
HA Guide - Bogdan Dobrelya No update this week.

Installation Guide - Matt Kassawara Testing Mitaka milestone 3 using RDO packages and submitting patches for review. Lead of the install guide changed from Christian Berendt to Matt Kassawara.

Networking Guide - Edgar Magana No update this week.

Security Guide - Nathaniel Dillon No update this week.

User Guides - Joseph Robinson The new User Guide team meetings are a success. We now have more contributors, and are disucssing doc editing, new content, and Information Architecture of the User Guides.

Ops and Arch Guides - Shilla Saebi 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. Operations guide RST migration pending - conversations still happening to see which route we'll take. Still deciding if the ops guide should have another revision or edition, see ML e-mails. Call for volunteers email went out to the ops and docs ML from Devon Boatwright. We are looking for help! There is a global OpenStack bug smash scheduled for the Mitaka release in March. Details can be found here: https://etherpad.openstack.org/p/OpenStack-Bug-Smash-Mitaka We're looking for people to specifically help with the Architecture Guide, which is currently going through a reorganization. Here is the link for more details: https://wiki.openstack.org/wiki/Architecture_Design_Guide_work_items If you are interested in helping out, more details can be found about our team and our meetings here: https://wiki.openstack.org/wiki/Documentation/OpsGuide

API Docs - Anne Gentle http://lists.openstack.org/pipermail/openstack-docs/2016-February/008286.html Swagger files now available at http://developer.openstack.org/draft/swagger/

Config Ref - Gauvain Pocentek No update this week.

Training labs - Pranav Salunke, Roger Luethi Fixing various things in training-labs cluster for VirtualBox and KVM backends. Improving workflow, configuration and making the library scripts nicer. Adding training-labs landing page (WIP). Summit related work. Some minor improvements.

Training Guides - Matjaz Pancur No update this week.

Hypervisor Tuning Guide - Joe Topjian No update this week.

UX/UI Docs Guidelines - Linette Williams Enhancement to UI content guidelines underway. Expect a new review shortly that covers icons and text formatting. If interested or have questions, contact Linette or Piet Kruithof.

Doc team meeting
Next meetings:

The US meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-02-14

Next meetings: APAC: Wednesday 24 February, 00:30 UTC US: Wednesday 2 March, 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

Note that there is currently discussion about moving the US meeting to 20:00 UTC. A patch is open to change this, with ongoing discussion about finding a meeting room: https://review.openstack.org/#/c/271361/

--

Keep on doc'ing!

Lana

https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#19_February_2016

= 12 February 2016 =

Hi everyone,

This week has been all about the Install Guide. We're locating pre-release packages now so we can begin testing in about two weeks' time. Please consider being a tester for this release. Even if you've never done it before, it's a great way to improve your OpenStack knowledge, and the more people we have testing, the better and more accurate our docs will be, which helps everyone. We're also starting to see a little more action in the lead up to the Austin Summit. ATC passes are going out, and the talk sessions are now open for voting: https://www.openstack.org/summit/austin-2016/vote-for-speakers/

Progress towards Mitaka
54 days to go!

389 bugs closed so far for this release.

Docs Testing
 * Volunteers required!
 * https://wiki.openstack.org/wiki/Documentation/MitakaDocTesting

RST Conversions
 * All planned RST conversions are now complete!

Reorganisations
 * 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
 * Is now complete

The Road to Austin

 * ATC passes are going out now, so keep an eye on your inbox for your discount code if you haven't received yours yet.
 * Don't forget to vote on your favourite talks: https://www.openstack.org/summit/austin-2016/vote-for-speakers/

Speciality Teams
HA Guide - Bogdan Dobrelya Minor updates to the corosync/pacemaker, rabbitmq clusters setup guides

Installation Guide - Christian Berendt Mitaka Installation guide changes spec: https://review.openstack.org/#/c/274231/ Testing beginning, require packages: https://wiki.openstack.org/wiki/Documentation/MitakaDocTesting

Networking Guide - Edgar Magana Move the IRC meeting agenda to etherpad: https://etherpad.openstack.org/p/docnetworkingteam-agenda. Important Commits: DSCP addition to advanced qos guide: https://review.openstack.org/#/c/273638/ Add networking guide to Contributors Section: https://review.openstack.org/#/c/278330/ Last IRC Meeting Notes: http://eavesdrop.openstack.org/meetings/networking_guide/2016/networking_guide.2016-02-04-16.02.log.html

Security Guide - Nathaniel Dillon Continuing bugfixes and beginning Networking review (thanks to all Neutron contributors!)

User Guides - Joseph Robinson Held First US/EU Meeting, which was 1 and a 1/2 hours before the APAC meeting (Need to reserve the meeting time). Discussed Reorg- High Priority step - moving Dashboard content from the Admin Guide to the Cloud Admin Dashboard Chapter.

Ops and Arch Guides - Shilla Saebi 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. Operations guide RST migration pending - conversations still happening to see which route we'll take. Still deciding if the ops guide should have another revision or edition, see ML emails.

API Docs - Anne Gentle No update this week.

Config Ref - Gauvain Pocentek No update this week.

Training labs - Pranav Salunke, Roger Luethi We reviewed and merged several patches: bug fixes, refactoring and some code to help with debugging.

Training Guides - Matjaz Pancur No update this week.

Hypervisor Tuning Guide - Joe Topjian No update this week.

UX/UI Docs Guidelines - Linette Williams No update this week.

Doc team meeting
Next meetings:

The APAC meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-02-10

Next meetings: US: Wednesday 17 February, 14:00 UTC APAC: Wednesday 24 February, 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

Note that there is currently discussion about moving the US meeting to 20:00 UTC. A patch is open to change this, with ongoing discussion about finding a meeting room: https://review.openstack.org/#/c/271361/

--

Keep on doc'ing!

Lana

https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#12_February_2016

= 6 February 2016 =

Hi everyone,

A busy week here in docs, with today marking only two months left until Mitaka goes out. I've been working on the DocImpact script, the core team review, and a whole lot of general chasing things up and tidying around the place. I also note that the Installation Guide team is busy ramping up for Mitaka, so watch this space for your opportunity to jump into testing for that very soon. Next week, I'll be cleaning up the blueprints, and also starting to get in touch with our packaging contacts to get ready for release.

Progress towards Mitaka
60 days to go!

382 bugs closed so far for this release.

RST Conversions
 * All planned RST conversions are now complete!

Reorganisations
 * 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 implementation plan for the DocImpact script changed after we received feedback from Infra and Nova. Now, *all* projects (including the five 'defcore' projects) default to opening DocImpact bugs in their own bug queues. This change was proposed in https://review.openstack.org/#/c/276065/ and merged yesterday, very quickly! Projects will now be able to determine for themselves how they would like to use the DocImpact script within their own groups, and hopefully the quality of bug reporting to docs will improve dramatically as a result of this. I'd like to thank all the PTLs, cross-project liaisons, project core team members, and especially the Infra and Nova teams for their assistance and patience while we worked through this knotty problem. I'm happy to be able to report that, as of today, this project is now complete.

Speciality Teams
HA Guide - Bogdan Dobrelya No update this week.

Installation Guide - Christian Berendt Mitaka Installation guide changes spec: https://review.openstack.org/#/c/274231/

Networking Guide - Edgar Magana No update this week.

Security Guide - Nathaniel Dillon RST bug fixes and cleaning up of lingering migration issues. Looking for Neutron reviewers to see what is still accurate and what needs to be updated, please ping Nathaniel. Looking to setup PDF creation job.

User Guides - Joseph Robinson An action item from last meeting was addressed this week - working with new User Guide team members to continue reorganisation edits. Plans for an earlier, US+EU meeting, which would roll into an APAC meeting on Wedneday/Thursday fornightly meeting times are in place.

Ops and Arch Guides - Shilla Saebi 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. Operations guide RST migration pending - conversations still happening to see which route we'll take. Still deciding if the ops guide should have another revision or edition, see ML emails.

API Docs - Anne Gentle Continuing to work on builds of Swagger plus RST.

Config Ref - Gauvain Pocentek No update this week.

Training labs - Pranav Salunke, Roger Luethi Liberty support has been merged. The new default for training-labs clusters is the Liberty release.

Training Guides - Matjaz Pancur Removal of redundant Jenkins jobs (gate-training-guides-tox-slides) and tox targets. Upstream training archives (http://docs.openstack.org/upstream-training/upstream-archives.html) are now separated from the main landing page.

Hypervisor Tuning Guide - Joe Topjian No update this week.

UX/UI Docs Guidelines - Linette Williams Collaboration between the UX project and Doc project. The first UI text guidelines are live: http://docs.openstack.org/contributor-guide/ui-text-guidelines.html. Enhancements to guidelines in progress - specifically related to icons and text formatting. Text reviews are ongoing for new UI prototypes, as applicable. If interested in helping with UI panel reviews or with UI text guidelines, feel free to ping Linette or Piet Kruithof.

Doc team meeting
Next meetings:

The US meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-01-20

Next meetings: APAC: Wednesday 10 February, 00:30 UTC US: Wednesday 17 February, 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

Note that there is currently discussion about moving the US meeting to 20:00 UTC. A patch is open to change this, with ongoing discussion about finding a meeting room: https://review.openstack.org/#/c/271361/

--

Keep on doc'ing!

Lana

https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#6_February_2016

= 29 January 2016 =

Hi everyone,

We seem to be more or less back into the swing of things here in docs land this week, with our meeting schedule back up and running, and now our very first full-length newsletter for 2016! We only have two and a half months until Mitaka goes out, but we're in great shape so far, with 345 bugs dealt with, and all the planned RST conversions complete. Most of the discussion this week has been around API documentation and Fairy Slipper, Docs Tools and some site theme changes, and a little back and forth on meeting times.

Progress towards Mitaka
75 days to go!

345 bugs closed so far for this release.

RST Conversions
 * All RST conversions are now complete! Well done to all the contributors and reviewers who made this happen so quickly this time around. We are now, with only a couple of exceptions, completely converted. Great job :)

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

DocImpact
 * After some discussion on the dev list, we're adjusting our approach to this problem. Watch this space.

Speciality Teams
HA Guide - Bogdan Dobrelya Meeting moved http://lists.openstack.org/pipermail/openstack-docs/2016-January/008209.html. Kenneth finished his Galera patch https://review.openstack.org/#/c/263075/, there were also several patches from different contributors, so things are improving.

Installation Guide - Christian Berendt AODH instructions near completion, EU/US meeting moved (Every two weeks (on even weeks) on Tuesday at 1600 UTC), APAC meeting will be dropped the next weeks if if not more participants join.

Networking Guide - Edgar Magana No update this week.

Security Guide - Nathaniel Dillon No update this week.

User Guides - Joseph Robinson One patch combining Images and Instances content merged, and a patch on Shared File Systems is now available for review. User Guide team meetings are set to begin next Thursday, with guidelines for combining admin and cloud admin files a topic for discussion.

Ops and Arch Guides - Shilla Saebi No update this week.

API Docs - Anne Gentle Anne imported and triaged over 60 GitHub Issues into Launchpad bugs. Anne working on build jobs for making API docs with fairy-slipper: https://review.openstack.org/#/c/269809. Anne emailed over 25 individuals about the plans for API docs and answered follow-up questions. Karen worked on validated Swagger: https://review.openstack.org/#/c/266527/. Need to release fairy-slipper this week or next.

Config Ref - Gauvain Pocentek No update this week.

Training labs - Roger Luethi Liberty is making good progress, trying to get Liberty patches working. Early beginnings of Fedora support switched to CentOS. Copy-on-write disks for KVM. Bug fixing and refactoring, as usual. Early work on python port. Plan to host training labs on a web page.

Training Guides - Matjaz Pancur German translation of the Upstream training (http://docs.openstack.org/de/upstream-training/) - this makes 3 full translations (en, de, ko_kr), ja is at 80%. A patch that enables direct bug reporting on the slides (https://review.openstack.org/#/c/259654/), several other patches.

Hyperviser Tuning Guide - Joe Topjian No update this week.

Core Team Changes
The next core team review will occur on 1 February. In the meantime, it's probably a good time to go over what being a core means, and how the review system works. For more detail, see the Contributor Guide: http://docs.openstack.org/contributor-guide/docs-review.html

Docs cores have the ability to +2 docs reviews, and they also have the ability to merge reviews. Reviews are merged by cores only once there's been *two* +2 votes, and at least one +1. There are very few exceptions to this rule, for changes that need to go through very quickly to resolve gate breakages or similar, but this rule holds in just about every situation. Cores are assigned based on merit, usually through the core review process that we do every month. During a core review, the PTL gathers statistics on reviews made, and patches created and merged, and uses that to determine who should be added to (or removed from) the core list. That then goes to a vote of the existing core team before being actioned and announced. Core team members also have the ability to nominate (and vote on) exceptional team members, where the statistics might not reflect the amount of effort they have put in.

If you ever have any questions about becoming a docs core, or about getting your docs patch merged, you can contact the team on the usual docs mailing list, or ping any of us on IRC.

Doc team meeting
The US team meeting was held last week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-01-20

Next meetings: APAC: Wednesday 27 January, 00:30 UTC US: Wednesday 3 February, 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

Note that there is currently discussion about moving the US meeting four hours later to 20:00 UTC. If you have a strong opinion on this matter, make sure you weigh in on the mailing list thread: http://lists.openstack.org/pipermail/openstack-docs/2016-January/008206.html

--

Keep on doc'ing!

Lana

= 22 January 2016 =

Hi everyone,

We seem to be more or less back into the swing of things here in docs land this week, with our meeting schedule back up and running, and now our very first full-length newsletter for 2016! We only have two and a half months until Mitaka goes out, but we're in great shape so far, with 345 bugs dealt with, and all the planned RST conversions complete. Most of the discussion this week has been around API documentation and Fairy Slipper, Docs Tools and some site theme changes, and a little back and forth on meeting times.

Progress towards Mitaka
75 days to go!

345 bugs closed so far for this release.

RST Conversions
 * All RST conversions are now complete! Well done to all the contributors and reviewers who made this happen so quickly this time around. We are now, with only a couple of exceptions, completely converted. Great job :)

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

DocImpact
 * After some discussion on the dev list, we're adjusting our approach to this problem. Watch this space.

Speciality Teams
HA Guide - Bogdan Dobrelya Meeting moved http://lists.openstack.org/pipermail/openstack-docs/2016-January/008209.html. Kenneth finished his Galera patch https://review.openstack.org/#/c/263075/, there were also several patches from different contributors, so things are improving.

Installation Guide - Christian Berendt AODH instructions near completion, EU/US meeting moved (Every two weeks (on even weeks) on Tuesday at 1600 UTC), APAC meeting will be dropped the next weeks if if not more participants join.

Networking Guide - Edgar Magana No update this week.

Security Guide - Nathaniel Dillon No update this week.

User Guides - Joseph Robinson One patch combining Images and Instances content merged, and a patch on Shared File Systems is now available for review. User Guide team meetings are set to begin next Thursday, with guidelines for combining admin and cloud admin files a topic for discussion.

Ops and Arch Guides - Shilla Saebi No update this week.

API Docs - Anne Gentle Anne imported and triaged over 60 GitHub Issues into Launchpad bugs. Anne working on build jobs for making API docs with fairy-slipper: https://review.openstack.org/#/c/269809. Anne emailed over 25 individuals about the plans for API docs and answered follow-up questions. Karen worked on validated Swagger: https://review.openstack.org/#/c/266527/. Need to release fairy-slipper this week or next.

Config Ref - Gauvain Pocentek No update this week.

Training labs - Roger Luethi Liberty is making good progress, trying to get Liberty patches working. Early beginnings of Fedora support switched to CentOS. Copy-on-write disks for KVM. Bug fixing and refactoring, as usual. Early work on python port. Plan to host training labs on a web page.

Training Guides - Matjaz Pancur German translation of the Upstream training (http://docs.openstack.org/de/upstream-training/) - this makes 3 full translations (en, de, ko_kr), ja is at 80%. A patch that enables direct bug reporting on the slides (https://review.openstack.org/#/c/259654/), several other patches.

Hyperviser Tuning Guide - Joe Topjian No update this week.

Core Team Changes
The next core team review will occur on 1 February. In the meantime, it's probably a good time to go over what being a core means, and how the review system works. For more detail, see the Contributor Guide: http://docs.openstack.org/contributor-guide/docs-review.html

Docs cores have the ability to +2 docs reviews, and they also have the ability to merge reviews. Reviews are merged by cores only once there's been *two* +2 votes, and at least one +1. There are very few exceptions to this rule, for changes that need to go through very quickly to resolve gate breakages or similar, but this rule holds in just about every situation. Cores are assigned based on merit, usually through the core review process that we do every month. During a core review, the PTL gathers statistics on reviews made, and patches created and merged, and uses that to determine who should be added to (or removed from) the core list. That then goes to a vote of the existing core team before being actioned and announced. Core team members also have the ability to nominate (and vote on) exceptional team members, where the statistics might not reflect the amount of effort they have put in.

If you ever have any questions about becoming a docs core, or about getting your docs patch merged, you can contact the team on the usual docs mailing list, or ping any of us on IRC.

Doc team meeting
The US team meeting was held last week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-01-20

Next meetings: APAC: Wednesday 27 January, 00:30 UTC US: Wednesday 3 February, 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

Note that there is currently discussion about moving the US meeting four hours later to 20:00 UTC. If you have a strong opinion on this matter, make sure you weigh in on the mailing list thread: http://lists.openstack.org/pipermail/openstack-docs/2016-January/008206.html

--

Keep on doc'ing!

Lana

= 15 January 2016 =

Hi everyone,

Welcome to 2016! A short newsletter this week as I get my feet back under me after my vacation. I hope you all had a wonderful holiday period, and got some well-earned down time. I'm looking forward to working hard with you all over the next few months to get Mitaka out into the wild :)

Progress towards Mitaka
82 days to go!

324 bugs closed so far for this release.

RST Conversions
 * All RST conversions are now complete! Well done to all the contributors and reviewers who made this happen so quickly this time around. We are now, with only a couple of exceptions, completely converted. Great job :)

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

DocImpact
 * After some discussion on the dev list, we're adjusting our approach to this problem. Watch this space.

Speciality Teams
No updates this week, as I'm totally disorganised. Next week for sure!

Core Team Changes
I would like to offer a warm welcome to Atsushi Sakai as our newest core team member. Welcome to the team :)

We will resume regular reviews in February 2016.

Doc team meeting
There's been some confusion over the meeting schedule, but as far as I can tell, these are the next meeting dates:

Next meetings: US: Wednesday 20 January, 14:00 UTC APAC: Wednesday 27 January, 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

= 11 December 2015 =

Hi everyone,

This is my final newsletter for the year, as I'm taking summer vacation over the next few weeks (yay for Southern Hemisphere weather!). Your regularly scheduled programming will resume in mid-January.

I would like to take a moment to acknowledge the incredible work of the entire documentation team, especially the core team who have worked all year to keep on top of reviews, the speciality team leads who motivate and inspire their teams each and every day, and every single documentation contributor and reviewer: without you all doing your little bit, we wouldn't have had the success we have had. Thank you also to our crew of support people: from infra and release management, to our subject matter experts and the wonderful people on the TC and at Foundation. Thanks for helping us be the best we can be. I would also like to make special mention of Andreas Jaeger and Anne Gentle, who both continue to hold my hand daily and make sure I don't make too much of a fool of myself in public. Your support and encouragement have been invaluable.

While we're on the goodwill wagon: if there's someone (or something!) you would like to call out for a special mention, you can do so using #success in our IRC channel. All successes get logged here: https://wiki.openstack.org/wiki/Successes and it's a great way to show your appreciation for your fellow community members.

Progress towards Mitaka
117 days to go!

150 bugs closed so far for this release.

RST Conversions
 * Arch Guide
 * RST conversion is complete! Well done Shilla and team for getting this done so incredibly quickly :)
 * Config Ref
 * Is underway: contact the Config Ref Speciality team: https://wiki.openstack.org/wiki/Documentation/ConfigRef
 * Virtual Machine Image Guide
 * Is complete! Well done Tomoyuki-san :)

Reorganisations
 * Arch Guide
 * https://blueprints.launchpad.net/openstack-manuals/+spec/archguide-mitaka-reorg
 * Doc sprint planned for December 21-22. Contact the Ops Guide speciality team for more info or to get involved.
 * 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
 * Waiting to merge the patch for the new Jenkins job: https://review.openstack.org/#/c/251301/ which for now will be against Nova only so we can make sure it's working correctly before we roll it out across the board.

Document openstack-doc-tools and reorganise index page
 * Thanks to Brian and Christian for volunteering to take this on!

Horizon UX work
 * Thanks to the people who offered to help out on this! If you're interested but haven't gotten in touch yet, contact Piet Kruithof of the UX team. There is now a blueprint + spec in draft: https://blueprints.launchpad.net/openstack-manuals/+spec/ui-content-guidelines and https://review.openstack.org/#/c/252668/

Speciality Teams
HA Guide - Bogdan Dobrelya The change to shift IRC meeting was not accepted. Going to create a new poll this time with correct options suggested by Tony Breeds. No more updates.

Installation Guide - Christian Berendt We require Debian Install Guide testers. Please contact Christian if you're interested.

Networking Guide - Edgar Magana The networking guide had its first official IRC meeting: https://wiki.openstack.org/wiki/Documentation/NetworkingGuideMeetings We are restructuring a little bit the wikis for better engagement with new contributors; Versioning spec for networking guide has been merged: https://review.openstack.org/#/c/253283/ Working of the remaining actions items from the meeting: http://eavesdrop.openstack.org/meetings/networking_guide/2015/networking_guide.2015-12-03-16.00.txt We have proposed a time and date for an IRC meeting covering APAC time zone: https://review.openstack.org/#/c/254999/

Security Guide - Nathaniel Dillon Planning for a bug sprint and general triage/cleanup.

User Guides - Joseph Robinson The User Guide Reorganization Spec merged this week, and the final User Guide meeting for 2016 has been rescheduled to next Thursday December 16 at 23:30 UTC, and the plan is to discuss work items. A patch for the User Guide Dashboard has begun using the blueprint implementation as a start to the reorg.

Ops and Arch Guides - Shilla Saebi Regarding this spec - https://review.openstack.org/#/c/227660/, we decided we are going to hold off until the N-release; Architecture Guide Swarm - Asking for everyone who wants to help to please use the https://etherpad.openstack.org/p/arch-guide-reorg to document potential changes; The arch guide RST conversion is complete; For the swarm, everyone works in their timezone. They will then submit patches and allocate team members in the other timezones to review; The final dates for the arch guide virtual swarm is: 12/21-12/22.

API Docs - Anne Gentle Trimming down what is output so that eventually we'll get working Swagger migrated from WADL. Repo still awaits being pulled into gerrit: https://github.com/russell/fairy-slipper to https://review.openstack.org/#/c/245352/ Nova API docs sprint 12/8 and 12/9 came up with good questions and answers and patches. Also, the Gabbi API test suite has a new release, see http://lists.openstack.org/pipermail/openstack-dev/2015-December/081891.html

Config Ref - Gauvain Pocentek The configuration reference RST migration is almost done, only a few more Block Storage drivers docs to handle. Thanks to all the contributors!

Training labs - Roger Luethi Training-labs merged a KVM provider patch which allows the training cluster to build on top of KVM. The IP address ranges now match the install guides. The Liberty training cluster is being worked on.

Training Guides - Matjaz Pancur Through no fault of Matjaz', this report was erroneously left out of the last newsletter, sorry for the delay: A complete Korean translation of the Upstream training material is officially published at http://docs.openstack.org/ko_KR/upstream-training/ (big thanks to Ian Y. Choi and KATO Tomoyuki)

Hyperviser Tuning Guide - Joe Topjian Finished the first pass of converting etherpad notes to the wiki. I sent an email  to the openstack-operators with a summary of the current state. Hopefully the guide will pick up two or three regular contributors to help things along. I'll continue to work on it 1-2 hours a week as I get time.

Core Team Changes
I would like to offer a warm welcome to Atsushi Sakai as our newest core team member. Welcome to the team :)

We will resume regular reviews in February 2016.

Doc team meeting
We failed to hold the APAC docs meeting this week because I can't read a calendar, and clearly just need a holiday. My apologies!

Next meetings: US: Wednesday 16 December, 14:00 UTC APAC: Will resume in the new year

Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting

--

Happy holidays everyone, and remember to ...

Keep on doc'ing!

Lana

= 4 December 2015 =

Hi everyone,

Slight delay in the newsletter this time around, it's been a busy week! I've been working on the DocImpact changes, reviewing the docs and docs-specs core teams, and catching up with blueprint management and reviews from while I was on leave.

Since we're getting to the pointy end of the year, remember to call out successes using #success in our IRC channel. All successes get logged here: https://wiki.openstack.org/wiki/Successes and it's a great way to show your appreciation for your fellow community members.

Progress towards Mitaka
121 days to go!

139 bugs closed so far for this release.

RST Conversions
 * Arch Guide
 * RST conversion is complete! Well done Shilla and team for getting this done so incredibly quickly :)
 * Config Ref
 * Contact the Config Ref Speciality team: https://wiki.openstack.org/wiki/Documentation/ConfigRef
 * Virtual Machine Image Guide
 * https://blueprints.launchpad.net/openstack-manuals/+spec/image-guide-rst and https://review.openstack.org/#/c/244598/

Reorganisations
 * Arch Guide
 * https://blueprints.launchpad.net/openstack-manuals/+spec/archguide-mitaka-reorg
 * Doc sprint in planning for December 21-22. Contact the Ops Guide speciality team for more info or to get involved.
 * 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
 * This is now well underway, with the first two patches merged. One changes the default bug queue for DocImpact back to the projects' own queue, and the other changes all current projects (with the exception of the six defcore projects) to their own bug queue. There has also been some discussion on the mailing lists about this process change. The next step is to merge the new Jenkins job (https://review.openstack.org/#/c/251301/) which for now will be against Nova only so we can make sure it's working correctly before we roll it out across the board. Thank you to Andreas, Josh Hesketh, and everyone else who has helped get us this far, and to the Nova team who are allowing us to use them as guinea pigs.

Document openstack-doc-tools and reorganise index page
 * Thanks to Brian and Christian for volunteering to take this on!

Horizon UX work
 * Thanks to the people who offered to help out on this! If you're interested but haven't gotten in touch yet, contact Piet Kruithof of the UX team. There is now a blueprint + spec in draft: https://blueprints.launchpad.net/openstack-manuals/+spec/ui-content-guidelines and https://review.openstack.org/#/c/252668/

Speciality Teams
HA Guide - Bogdan Dobrelya Finished IRC meeting schedule poll, finalised the Corosync/pacemaker patch (https://review.openstack.org/235893), participating and tracking progress with the HA for OpenStack instances research (https://etherpad.openstack.org/p/automatic-evacuation) to make it into the HA guide, eventually.

Installation Guide - Christian Berendt Debian install guide nearly completed, testers needed; meeting time for the EU/US meeting will probably change from 13 UTC to 17 UTC; Aodh install instructions nearly finished, ongoing discussion because of missing SUSE packages; Japanese translation of the Liberty install guide published.

Networking Guide - Edgar Magana We are having our first official IRC meeting tomorrow at 1600 UTC. The goal is to find out what we can to complete during the Liberty cycle and have specific tasks assigned. Relevant patches: Create tags for the Networking Guide - WIP (https://review.openstack.org/#/c/251979/)

Security Guide - Nathaniel Dillon No update this week

User Guides - Joseph Robinson The User guide meeting on IRC worked, however attendance was down; the reorganization spec is updated with information from Big Tent Project navigator to define the scope (http://www.openstack.org/software/project-navigator) and information from the published nova-network to neutron migration study.

Ops and Arch Guides - Darren Chan The arch guide RST conversion is completed. We plan on doing a virtual swarm this December. The doodle link was sent out last week and the poll is now closed. The final date for the virtual swarm is: 12/21-12/22.

API Docs - Anne Gentle Working on usage docs for migration, how to build, what gets migrated, how the docs are assembled: https://github.com/russell/fairy-slipper/blob/master/doc/source/usage.rst Responding to spec reviews: https://review.openstack.org/#/c/246660/ Revising patch to bring fairy-slipper into openstack org: https://review.openstack.org/#/c/245352/

Config Ref - Gauvain Pocentek The RST migration is still in progress. The Manila section has been greatly improved in the process, and the Zaqar documentation should land during this cycle as the spec has been approved.

Training labs - Pranav Salunke KVM port is almost done. Planned to merge this by end of this week; Network configuration for the cluster is updated. Now it uses same network addresses as install guides; Welcome berndbausch into our team; Liberty port is in progress. Follow https://etherpad.openstack.org/p/training-labs-liberty for more details; Need to decide meeting time for weekly IRC meetings.

Training Guides - Matjaz Pancur No update this week

Hyperviser Tuning Guide - Joe Topjian Still on schedule. Halfway done with a first-pass cleanup. Should be ready for open contributions within 2 weeks.

Core Team Changes
During last week, I announced some changes to the docs-specs core team. Previously, this core team was a small subset of docs core team members, with an understanding that we would wait for speciality team leads to +1 a spec relevant to their team before approving. Now we have formalised that process by inviting each speciality team lead to the docs-specs core team, so that they can +2A their own specs. Speciality team leads are listed on the wiki here: https://wiki.openstack.org/wiki/Documentation/SpecialityTeams remember to engage them when you create a new spec for approval.

We have also reviewed the current docs core team list for December, and the results of that will be announced shortly. We will not be reviewing the team in January because of the holiday period, and will resume regular reviews in February 2016.

Doc team meeting
We held the APAC docs meeting this week. Big thanks to Joseph for running that while I was away, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-11-25

Next meetings: APAC: Wednesday 9 December, 00:30:00 UTC (CANCELLED) US: Wednesday 16 December, 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

--

Just a note that this will be my penultimate newsletter for 2015.

Keep on doc'ing! Lana

= 20 November 2015 =

Hi everyone,

This week I've been working on catching up with some reviews and bug triage, I've been speaking to O'Reilly about the future of the Ops Guide, and also been working on a range of other things including docs-specs core team review, and the addition of Zaqar docs into the user guides.

Just a quick heads up that there won't be a docs newsletter next week, though, as I'm taking a couple of days off (my Mum is coming to visit!), so I'll see you again around 4 December. For those of you in the United States, I hope you all have a lovely Thanksgiving :)

Progress towards Mitaka
138 days to go!

119 bugs closed so far for this release.

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
 * Determining whether or not we want to do an updated version for O'Reilly in L
 * Config Ref
 * Contact the Config Ref Speciality team: https://wiki.openstack.org/wiki/Documentation/ConfigRef
 * Virtual Machine Image Guide
 * https://blueprints.launchpad.net/openstack-manuals/+spec/image-guide-rst and https://review.openstack.org/#/c/244598/

Reorganisations
 * Arch Guide
 * https://blueprints.launchpad.net/openstack-manuals/+spec/archguide-mitaka-reorg
 * Doc sprint in planning for December. Contact the Ops Guide speciality team for more info or to get involved.
 * 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
 * I've added some examples to the spec, and we're pretty much ready to go now: https://blueprints.launchpad.net/openstack-manuals/+spec/review-docimpact

Document openstack-doc-tools and reorganise index page
 * Thanks to Brian and Christian for volunteering to take this on!

Horizon UX work
 * Thanks to the people who offered to help out on this! If you're interested but haven't gotten in touch yet, contact Piet Kruithof of the UX team.

Speciality Teams
HA Guide - Bogdan Dobrelya Two patches look ready for merge now: https://review.openstack.org/#/c/225418/ and https://review.openstack.org/235893

Installation Guide - Christian Berendt Business as usual. Nothing special to mention this week.

Networking Guide - Edgar Magana Open Reviews: https://review.openstack.org/#/c/239361/ Merged: https://review.openstack.org/#/c/246671/ Very slow progress, hoping to speed up after the USA holidays.

Security Guide - Nathaniel Dillon No update this week

User Guides - Joseph Robinson After a specification update, there is a need to provide a more comprehensive scope: a list of Core features within scope, and include research on the nova-network/ neutron migration study. Contact from Zaqar, Trove, and Murano Liaisons on Admin guide tasks has been helpful, and given the reorganisation direction. A patch on fernet tokens (FAQ format) merged into the Cloud Admin Guide this week.

Ops and Arch Guides - Darren Chan Arch guide migration is close to completion. We are currently planning to reorganize the guide over a two day virtual sprint in mid December.

API Docs - Anne Gentle Review ready for the Mitaka specification of a vision for app dev docs: https://review.openstack.org/#/c/246660/

Config Ref - Gauvain Pocentek The tools are ready, the liberty branch is set up, the RST migration is on! Pick your file, run the tools, and let's review.

Training labs - Pranav Salunke Training-labs has Kilo patch merged! We are currently updating the network configuration and trying to get things as per Matt's feedback/request. We plan to start adding Liberty very soon and also KVM port is on the way.

Training Guides - Matjaz Pancur There is interest in translating Upstream training; we are waiting for https://review.openstack.org/#/c/245615/ to merge to enable it on the repo.

Hyperviser Tuning Guide - Joe Topjian On schedule - working on changing bullet-point notes into rough draft sections.

Doc team meeting
We held the US docs meeting this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-11-18

Next meetings: APAC: Wednesday 25 November, 00:30:00 UTC US: Wednesday 2 December, 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

= 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 the 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!

Progress towards Mitaka
145 days to go!

100 bugs closed so far for this release.

DocImpact
 * I've updated the spec and made contact with Infra to nut out the finer technical details: 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
 * Contact the Config Ref Speciality team: https://wiki.openstack.org/wiki/Documentation/ConfigRef
 * Virtual Machine Image Guide
 * https://blueprints.launchpad.net/openstack-manuals/+spec/image-guide-rst and https://review.openstack.org/#/c/244598/

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

Document openstack-doc-tools and reorganise index page
 * Thanks to Brian and Christian for volunteering to take these on!

Horizon UX work
 * There's an interesting opportunity to improve the wording in Horizon, specifically around LBaaS, and also to develop a set of standards around the language used in the dashboard. If you're interested, let me know and I'll get you in contact with the right people.

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 Our meeting format has changed from hangouts to IRC meetings, with the appropriate changes made to the meetbot script thanks to Brian. The mitaka specification: the priority at the moment is checking in with project docs liaisons to confirm what services are in scope, and then add a short statement to the specification outlining this scope. Responding to Cloud Admin Guide patches. Thanks to Andreas for the link.

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.

Doc team meeting
We held the APAC docs meeting this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-11-11

Next meetings: US: Wednesday 18 November, 14:00 UTC APAC: Wednesday 25 November, 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

--

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
 * https://blueprints.launchpad.net/openstack-manuals/+spec/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

= 三鷹 Summit Edition =

Hi everyone,

Welcome to the Summit edition of the docs newsletter! Docs have had a wonderfully productive week here in Tokyo, and we've now established a plan for Mitaka. This newsletter covers the more important announcements, and the main points we want to hit in the next release.

Karin has kindly written up the summary of the Design Summit sessions here: https://etherpad.openstack.org/p/Mitaka-Docs-Meetup

Mitaka Goals
This is the list at the moment. There are more notes in the docs etherpads, and not everything has blueprints yet.


 * Switch API docs over to swagger http://specs.openstack.org/openstack/docs-specs/specs/liberty/api-site.html (???)
 * Implement new docimpact plan: https://blueprints.launchpad.net/openstack-manuals/+spec/review-docimpact
 * RST Conversions:
 * Arch Guide: https://blueprints.launchpad.net/openstack-manuals/+spec/archguide-mitaka-rst
 * Ops Guide: https://blueprints.launchpad.net/openstack-manuals/+spec/ops-guide-rst (pending O'Reilly conversation)
 * Config Ref
 * Reorganisations:
 * Arch Guide: https://blueprints.launchpad.net/openstack-manuals/+spec/archguide-mitaka-reorg
 * Ops Guide: https://blueprints.launchpad.net/openstack-manuals/+spec/improve-ops-guide
 * User Guides: https://blueprints.launchpad.net/openstack-manuals/+spec/user-guides-reorganised
 * Training
 * Labs: https://blueprints.launchpad.net/openstack-manuals/+spec/training-labs
 * Guides: Upstream University & 'core' component updates, EOL Upstream Wiki page.
 * First App Guide: testing & improvements
 * Reorganise the index page
 * Document the openstack-doc-tools

Speciality Team Changes
More detail on the Speciality Team wiki page: https://wiki.openstack.org/wiki/Documentation/SpecialityTeams


 * Install Guide is now with Christian Berendt
 * HA Guide is now with Bogdan Dobrelya
 * Networking Guide is now with Edgar Magana
 * New Hypervisor Tuning Guide team with Joe Topjian

Keep on doc'ing! Lana

= 9 October 2015 =

Hi everyone,

We're hurtling head first to Liberty, with only about a week left to go. I've been working on Summit preparations, and making sure we're ready to go when the time hits. This week, I'm working on Release Notes, keeping an eye on the final Install Guide testing, and some other housekeeping tasks.

This is my last docs newsletter before the Liberty release, although I'll endeavour to get a special Summit edition out as well. We will pick up regular meetings (and other tasks, like core team reviews) after the Summit.

Progress towards Liberty
5 days to go!

601 bugs closed so far for this release.

The main things that still need to be done before release: Testing, testing, testing: https://wiki.openstack.org/wiki/Documentation/LibertyDocTesting Reviews: https://review.openstack.org/#/q/status:open+project:openstack/openstack-manuals,n,z and https://review.openstack.org/#/q/status:open+project:openstack/api-site,n,z Bug triage: https://bugs.launchpad.net/openstack-manuals/+bugs?search=Search&field.status=New

Release Notes
Can all PTLs and Cross-Project Liaisons please check the Release Notes page, and ensure they've included all the new features for their project here: https://wiki.openstack.org/wiki/ReleaseNotes/Liberty

The best way to do this (I'm told) is to go through the blueprints created for Liberty. I will be editing these during the next few days, so please ensure you're up to date ASAP. Please contact me directly if you have any questions or problems.

Mitaka Summit Prep
Thank you to everyone who provided suggestions for Design Summit sessions. I've now mangled them into a draft schedule, which is available on Sched: http://mitakadesignsummit.sched.org/type/Documentation

Doc team meeting
The US meeting was held this week. The minutes are here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-10-07

The next meetings will be the final meetings before the Liberty release: APAC: Wednesday 14 October, 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

--

東京でお会いしましょう (See you in Tokyo!)

Lana

= 2 October 2015 =

Hi everyone,

Welcome to October, which means: it's nearly release day! I've been brushing up on the release management tasks, and continued my housekeeping duties to make sure we're in shape. The next two weeks will be spent watching the Installation Guide pretty closely, and making sure we get it all tested and ready to ship. If you are looking for something to do this week, please treat Install Guide testing as your main priority from here until 15 October. Also, don't forget to vote in the TC election next week!

Progress towards Liberty
12 days to go

534 bugs closed so far for this release.

The main things that still need to be done as we hurtle towards release: Testing, testing, testing: https://wiki.openstack.org/wiki/Documentation/LibertyDocTesting Reviews: https://review.openstack.org/#/q/status:open+project:openstack/openstack-manuals,n,z and https://review.openstack.org/#/q/status:open+project:openstack/api-site,n,z Bug triage: https://bugs.launchpad.net/openstack-manuals/+bugs?search=Search&field.status=New

Mitaka Summit Prep
Thank you to everyone who provided suggestions for Design Summit sessions. I've now mangled them into a draft schedule, which looks a little like this:

Fishbowls (Thursday PM): - The docs process, plus best practices - Mitaka planning - deliverables for the next release

Workrooms (Thursday AM): - Docs toolchain/infra info session - IA working session - Ops/Arch Guides & User Guides - Doc Contributor Guide: new content addition - API Docs Session

Meetup (Friday AM): - Contributors meetup. No agenda. We can assist with setting up devstack/working through the Install Guide during this session

Once I have access to Cheddar and Sched, I'll get this allocated more accurately. In the meantime, feedback or questions are welcome.

Bug Triage Process
The core team have been noticing a lot of people trying to close bugs that haven't been triaged recently. It is very important that you have someone else confirm your bug before you go ahead and create a patch. Waiting just a little while for triage can save you (and our core team!) a lot of work, and makes sure we don't let wayward changes past the gate. If you're unsure about whether you need to wait or not, or if you're in a hurry to work on a bug, you can always ping one of the core team on IRC or on our mailing list. The core team members are listed here, and we're always happy to help you out with a bug or a patch: https://launchpad.net/~openstack-doc-core

This is even more important than usual as we get closer to the Liberty release, so remember: If it's not triaged, don't fix it!

Doc team meeting
The APAC meeting was held this week. The minutes are here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-09-30

The next meetings will be the final meetings before the Liberty release: US: Wednesday 7 October, 14:00:00 UTC APAC: Wednesday 14 October, 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

--

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

Keep on doc'ing!

Lana

= 25 September 2015 =

Hi everyone,

First of all, thank you to everyone who has suggested sessions for docs at Tokyo. I'll keep the etherpad open for another week or so, just to give everyone a chance, and will start working on a draft schedule next week. I have spent most of this week on bug triage, which is repetitive work, but it's gratifying to see the numbers drop a little!

Progress towards Liberty
19 days to go

534 bugs closed so far for this release.

The main areas of focus we had during Liberty were the RST migration, paying down some of our technical debt, and improving our general communication issues. The RST conversion is well and truly complete, with just a couple of books waiting in the wings to be published. We have made some progress on improving our communication generally, with liaisons now more visible and involved, and some improved processes. Regarding old bugs, during Liberty we spotlighted a total of 24 bugs, exactly half of which have now been closed.

Mitaka Summit Prep
The schedule app for your phone is now available. This is a great tool once you're on the ground at Summit: https://itunes.apple.com/WebObjects/MZStore.woa/wa/viewSoftware?id=987216292&mt=8 (Apple) and https://play.google.com/store/apps/details?id=org.sched.openstacksummitmay2015vancouver (Android)

Docs have been allocated two fishbowls, four workrooms, and a half day meetup, so now is the time to start gathering ideas for what you would like to see us cover. Add your ideas to the etherpad here: https://etherpad.openstack.org/p/Tokyo-DocsSessions I'll create a draft session based on this feedback next week.

Bug Triage Process
The core team have been noticing a lot of people trying to close bugs that haven't been triaged recently. It is very important that you have someone else confirm your bug before you go ahead and create a patch. Waiting just a little while for triage can save you (and our core team!) a lot of work, and makes sure we don't let wayward changes past the gate. If you're unsure about whether you need to wait or not, or if you're in a hurry to work on a bug, you can always ping one of the core team on IRC or on our mailing list. The core team members are listed here, and we're always happy to help you out with a bug or a patch: https://launchpad.net/~openstack-doc-core

This is even more important than usual as we get closer to the Liberty release, so remember: If it's not triaged, don't fix it!

Spotlight Bugs
During Liberty we spotlighted a total of 24 bugs, exactly half of which have now been closed. This is a great effort to clear out some old dusty bugs and pay down some technical debt. Thanks go out to Tom Fifield, Olga Gusarenko, Yusuke Ide, Brian Moss, Deena Cooper, and Alexandra Settle for taking them on! With Liberty and the Summit bearing down on us, though, let's focus back on what needs to be done for release. At Summit, we'll discuss how to expand and improve on this effort in future releases.

Doc team meeting
The US meeting was held this week. The minutes are here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-09-23

The next meetings will be the final meetings before the Liberty release: APAC: Wednesday 30 September, 00:30:00 UTC US: Wednesday 7 October, 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

--

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

Keep on doc'ing!

Lana

= 18 September 2015 =

Hi everyone,

First of all, with PTL candidacy now closed, it appears that I will be continuing to hold the docs reins through to Mitaka. Thank you to all of you who contacted me personally over the last week or so, expressing their support. I'm very honoured to be leading such a great team, and I'm looking forward to continuing to serve you. As always, my door will continue to be open to ideas, comments, and criticism, so please keep telling me what you do and don't like!

We're less than a month away from the Liberty release now, and with the Mitaka PTL question settled, I'll be working on Design Summit session planning over the next few weeks. I've created an etherpad to gather your ideas, more on that in this newsletter. In other news, testing is now well underway on the Install Guide, I've knocked our existing blueprints into order, been doing some thinking about the DocImpact script, and worked with the speciality teams on determining the final work items for Liberty.

Progress towards Liberty
26 days to go

514 bugs closed so far for this release.


 * RST conversion:
 * Done.


 * User Guides information architecture overhaul
 * Underway. Some tasks to be held over to Mitaka.


 * Greater focus on helping out devs with docs in their repo
 * A certain amount of progress has been made here, and some wrinkles sorted out which will improve this process for the future.


 * Improve how we communicate with and support our corporate contributors
 * I'm still trying to come up with great ideas for this, please let me know what you think.


 * 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
 * Great work this week, with two bugs from the last two weeks closed (thanks Deena and Tom!). Three new bugs this week.

Mitaka Summit Prep
The schedule app for your phone is now available. This is a great tool once you're on the ground at Summit: https://itunes.apple.com/WebObjects/MZStore.woa/wa/viewSoftware?id=987216292&mt=8 (Apple) and https://play.google.com/store/apps/details?id=org.sched.openstacksummitmay2015vancouver (Android)

Docs have been allocated two fishbowls, four workrooms, and a half day meetup, so now is the time to start gathering ideas for what you would like to see us cover. Add your ideas to the etherpad here: https://etherpad.openstack.org/p/Tokyo-DocsSessions

Outstanding Specs

 * Third Party Driver Content: This spec has been outstanding for a while, and we've finally reached a consensus on how to move forward. Please take a moment to review the spec here before we go ahead merge it: https://review.openstack.org/#/c/191041/


 * DocImpact: These are my ideas for reducing the noise from the DocImpact script, which is now up for discussion and ideas: https://review.openstack.org/#/c/224420/

Doc team meeting
The APAC meeting was held this week. The minutes are here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-09-16

The next meetings are: US: Wednesday 23 September, 14:00:00 UTC APAC: Wednesday 30 September, 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
Let's show these three that we're never going to give them up, never going to let them down:

https://bugs.launchpad.net/openstack-manuals/+bug/1293328 Review Identity & LDAP integration

https://bugs.launchpad.net/openstack-manuals/+bug/1294726 Update Cloud Administration Guide for OpenDaylight ML2 MechanismDriver

https://bugs.launchpad.net/openstack-manuals/+bug/1300960 Making DB sanity checking be optional for DB migration

--

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

Keep on doc'ing!

Lana

= 11 September 2015 =

Hi everyone,

Things are really starting to heat up now! Summit preparations are well underway, PTL elections just opened, and testing is proceeding apace on the Install Guide. As well as preparing my candidacy for Mitaka Docs PTL, I've been continuing to sort out the outstanding blueprints, and also planning for some announcements in Tokyo. One of the interesting things I learned while compiling a list of Liberty achievements is that we have released fixes for nearly 500 bugs since Kilo was released. What an amazing achievement!

Progress towards Liberty
33 days to go

496 bugs closed so far.


 * RST conversion:
 * Done.


 * User Guides information architecture overhaul
 * This is now well underway.


 * Greater focus on helping out devs with docs in their repo
 * A certain amount of progress has been made here, and some wrinkles sorted out which will improve this process for the future.


 * Improve how we communicate with and support our corporate contributors
 * I'm still trying to come up with great ideas for this, please let me know what you think.


 * 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
 * We've had some solid progress on last week's bugs, with two assigned, and one of those in progress. Three new bugs this week.

Mitaka Summit Prep
The schedule has now been released, congratulations to everyone who had a talk accepted this time around: https://www.openstack.org/summit/tokyo-2015/schedule/

All ATCs should have received their pass by now, so now is the time to be booking your travel and accommodation: https://www.openstack.org/summit/tokyo-2015/tokyo-and-travel/

Docs have been given their design summit session allocation, so start thinking about what you would like to see discussed. I'll send out an etherpad to start planning in the next week or two.

Conventions
A new governance patch has landed which changes the way we capitalise service names (I know almost exactly 50% of you will be happy about this!): https://wiki.openstack.org/wiki/Documentation/Conventions#Service_and_project_names Please be aware of this when editing files, and remember that the 'source of truth' for these things is the projects.yaml file: http://git.openstack.org/cgit/openstack/governance/tree/reference/projects.yaml

Doc team meeting
The US meeting was held this week. The minutes are here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-09-09

The next meetings are: APAC: Wednesday 16 September, 00:30:00 UTC US: Wednesday 23 September, 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
Let's show these three how much we care:

https://bugs.launchpad.net/openstack-manuals/+bug/1284301 Document Neutron SSL-VPN for cloudadmin

https://bugs.launchpad.net/openstack-manuals/+bug/1288044 Add user defined extra capabilities

https://bugs.launchpad.net/openstack-manuals/+bug/1292327 Make cors work better

--

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

Keep on doc'ing!

Lana

= 4 September 2015 =

Hi everyone,

This has been a fairly busy week, with Summit preparations beginning, more newly migrated RST books going live, and testing starting on the Install Guide. I've been spending time on sorting out the Liberty blueprints still outstanding, and also working on some old bugs.

Progress towards Liberty
40 days to go!


 * RST conversion:
 * Is now completed! Well done and a huge thank you to everyone who converted pages, approved reviews, and participated in publishing the new guides. This was a truly phenomenal effort :)


 * User Guides information architecture overhaul
 * Some user analysis has begun, and we have a new blueprint: https://blueprints.launchpad.net/openstack-manuals/+spec/user-guides-reorganised


 * Greater focus on helping out devs with docs in their repo
 * A certain amount of progress has been made here, and some wrinkles sorted out which will improve this process for the future.


 * Improve how we communicate with and support our corporate contributors
 * If you currently work on documentation for a company that would like to improve their upstream commits for documentation, please contact me!


 * 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
 * The last lot of old bugs are still languishing. I'm assuming you all hate them so very much that I've decided to give you three more to pick from. Have at it!

Countdown to Summit
With the Liberty release less than two months away, that means it's nearly Summit time again: https://www.openstack.org/summit/tokyo-2015/

The schedule has now been released, congratulations to everyone who had a talk accepted this time around: https://www.openstack.org/summit/tokyo-2015/schedule/

All ATCs should have received their pass by now, so now is the time to be booking your travel and accommodation: https://www.openstack.org/summit/tokyo-2015/tokyo-and-travel/

Conventions
A new governance patch has landed which changes the way we capitalise service names (I know almost exactly 50% of you will be happy about this!): https://wiki.openstack.org/wiki/Documentation/Conventions#Service_and_project_names Please be aware of this when editing files, and remember that the 'source of truth' for these things is the projects.yaml file: http://git.openstack.org/cgit/openstack/governance/tree/reference/projects.yaml

Docs Tools
openstack-doc-tools 0.30.0 and openstackdocstheme 1.2.1 have been released. openstack-doc-tools allows translation of the Install Guide. openstackdocstheme contains fixes for the inclusion of metatags, removes unused images and javascript files, and fixes the "Docs Home" link.

Doc team meeting
The APAC meeting was not held this week. The minutes from the previous US meeting are here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-08-26

The next meetings are: US: Wednesday 9 September, 14:00:00 UTC APAC: Wednesday 16 September, 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
Let's give these three a little love:

https://bugs.launchpad.net/openstack-manuals/+bug/1280092 end user guide lacks doc on admin password injection

https://bugs.launchpad.net/openstack-manuals/+bug/1282765 Chapter 6. Block Storage in OpenStack Cloud Administrator Guide

https://bugs.launchpad.net/openstack-manuals/+bug/1284215 Driver for IBM SONAS and Storwize V7000 Unified

--

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

Keep on doc'ing!

Lana

= 21 August 2015 =

Hi everyone,

First of all, apologies for missing last week's newsletter: I got so caught up in the documentation swarm happening here in Brisbane that it totally slipped my mind! To make up for it, have this week's newsletter a day early :) In swarm news, the two days ran extremely smoothly, much to the credit of Suyog, Brian, and Alex who did the heavy lifting of preparation and organisation. While we focused largely on copy editing, we also had a lot of great discussion about the overall architecture of the book, and now have a draft plan ready for Mitaka, which Darren is driving with the Ops/Arch Guide speciality team.

While last week was all about the docs swarm, this week has been doing the final cleanup on our newly converted RST books. The Security Guide is now up, and the Cloud Admin and HA Guides aren't far behind. We're also about to start testing the Install Guide, now that its conversion is complete. Well done to all the people who have helped out on these efforts, great job!

Progress towards Liberty
55 days to go!


 * RST conversion:
 * Install Guide: Conversion is done, testing to begin soon.
 * Cloud Admin Guide: is complete! The new version will be available on docs.openstack.org very soon.
 * HA Guide: is also done, and will available on the site soon.
 * Security Guide: is complete, and live: http://docs.openstack.org/security-guide/


 * User Guides information architecture overhaul
 * Some user analysis has begun, with a new blueprint to land soon.


 * Greater focus on helping out devs with docs in their repo
 * Work has picked up on the Ironic docs again.


 * Improve how we communicate with and support our corporate contributors
 * If you currently work on documentation for a company that would like to improve their upstream commits for documentation, please contact me!


 * 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
 * Sadly, no action on the spotlight bugs again this week. I'll keep the current three bugs for this week, to give everyone a little more time.

RST Migration
That's it! We're done!

Do you have ideas for which book should be next? Have a think on it, and we'll discuss this at Summit.

Training Guides
I'm happy to announce that the Training Labs are now in their own repo, and are considered a documentation speciality team. Well done to Pranav, Matjaz, Sayali, and Roger for driving this effort.

Countdown to Summit
With the Liberty release less than two months away, that means it's nearly Summit time again: https://www.openstack.org/summit/tokyo-2015/

Here's a few things you might want to be thinking about:
 * Do you need a visa to visit Japan? If so, you need to be organising this NOW: https://www.openstack.org/summit/tokyo-2015/tokyo-and-travel/#visa
 * Do you have an ATC pass? If you haven't received your pass yet, and you're an ATC, please contact me so I can chase this up for you. Remember to use your ATC discount code before 31 August to make sure you get the full price discounted.

Doc team meeting
The APAC meeting was held this week. Read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-08-19

The next meetings are: US: Wednesday 26 August, 14:00:00 UTC APAC: Wednesday 2 September, 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
Let's give these three a little more love:

https://bugs.launchpad.net/openstack-manuals/+bug/1257018 VPNaaS isn't documented in cloud admin

https://bugs.launchpad.net/openstack-manuals/+bug/1257656 VMware: add support for VM diagnostics

https://bugs.launchpad.net/openstack-manuals/+bug/1261969 Document nova server package

--

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

Keep on doc'ing!

Lana

= 7 August 2015 =

Hi everyone,

Welcome to August! Today we can finally announce that the Cloud Admin Guide is now completely converted to RST! I have been doing a fair bit of 'behind the scenes' work this week, focusing mainly on Training Guides and our docs licensing. We also welcome another new core team member this week, and for those of you in the APAC region, get ready for the Docs Swarm in Brisbane, where we'll be working on restructuring the Architecture Design Guide.

Progress towards Liberty
68 days to go!


 * RST conversion:
 * Install Guide: Conversion is nearly done, sign up here: https://wiki.openstack.org/wiki/Documentation/Migrate#Installation_Guide_Migration
 * Cloud Admin Guide: is complete! The new version will be available on docs.openstack.org very soon.
 * HA Guide: is also nearly done. Get in touch with Meg or Matt: https://wiki.openstack.org/wiki/Documentation/HA_Guide_Update
 * Security Guide: Conversion is now underway, sign up here: https://etherpad.openstack.org/p/sec-guide-rst


 * 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 stalled on the Ironic docs, we need to pick this up again. Contact me if you want to know more, or are willing to help out.


 * Improve how we communicate with and support our corporate contributors
 * I have been brainstorming ideas with Foundation, watch this space!


 * 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
 * Sadly, no action on the spotlight bugs this week. Perhaps we're all worn out from the RST conversions? I'll keep the current three bugs for this week, to give everyone a little more time.

RST Migration
With the Cloud Admin Guide complete, we are now working on the Install 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 
 * Sign up here: https://wiki.openstack.org/wiki/Documentation/Migrate#Installation_Guide_Migration


 * HA Guide
 * Contact Meg McRoberts  or Matt Griffin 
 * Blueprint: https://blueprints.launchpad.net/openstack-manuals/+spec/improve-ha-guide


 * Security Guide
 * Contact Nathaniel Dillon 
 * Info: https://etherpad.openstack.org/p/sec-guide-rst

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.

Training Guides
I've been working with the Training Guides group and the docs core team to determine the best way to move forward with the Training Guides project. At this stage, we're planning on breaking the project up into a few distinct parts, and bringing Training Guides back into the documentation group as a speciality team. If you have any opinions or ideas on this, feel free to contact me so I can make sure we're considering all the options.

APAC Docs Swarm
We're less than a week away from the APAC doc swarm! This time we'll be working on the Architecture Design Guide. It's to be held at the Red Hat office in Brisbane, on 13-14 August. Check out http://openstack-swarm.rhcloud.com/ for all the info and to RSVP.

Core Team Changes
This month, we welcome KATO Tomoyuki on to our docs core team. Thanks for all your hard work Tomoyuki-san, and welcome to the team!

Doc team meeting
The APAC meeting was held this week. Read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-08-05

The next meetings are: US: Wednesday 12 August, 14:00:00 UTC APAC: Wednesday 19 August, 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
Let's give these three a little more oxygen:

https://bugs.launchpad.net/openstack-manuals/+bug/1257018 VPNaaS isn't documented in cloud admin

https://bugs.launchpad.net/openstack-manuals/+bug/1257656 VMware: add support for VM diagnostics

https://bugs.launchpad.net/openstack-manuals/+bug/1261969 Document nova server package

--

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

Keep on doc'ing!

Lana

= 31 July 2015 =

Hi everyone,

This week, like last, was all about the RST conversion. With just a 48 hour long sprint, the Install Guide is almost complete! A hearty congratulations to everyone who contributed. One of the interesting things about doing all these conversions is the amount of conversation it has started about our conventions, and I'm pleased to see that we're really starting to get a feel for how RST can work for us, and what we can demand of it. It's also great to see some related changes to the sphinx theme that handles how we display our shiny RST books.

Progress towards Liberty
75 days to go!


 * RST conversion:
 * Install Guide: Conversion is nearly done, sign up here: https://wiki.openstack.org/wiki/Documentation/Migrate#Installation_Guide_Migration
 * Cloud Admin Guide: is nearly done. Sign up here: https://wiki.openstack.org/wiki/Documentation/Migrate#Cloud_Admin_Guide_Migration
 * HA Guide: is also nearly done. Get in touch with Meg or Matt: https://wiki.openstack.org/wiki/Documentation/HA_Guide_Update
 * Security Guide: Conversion is now underway, sign up here: https://etherpad.openstack.org/p/sec-guide-rst


 * 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 stalled on the Ironic docs, we need to pick this up again. Contact me if you want to know more, or are willing to help out.


 * Improve how we communicate with and support our corporate contributors
 * I have been brainstorming ideas with Foundation, watch this space!


 * 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 Brian for picking up one of the spotlight bugs from last week. Three new bugs to look at this week.

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
 * Sign up here: https://wiki.openstack.org/wiki/Documentation/Migrate#Installation_Guide_Migration


 * Cloud Admin Guide:
 * Contact Brian Moss & Joseph Robinson
 * Sign up to help out here: https://wiki.openstack.org/wiki/Documentation/Migrate#Cloud_Admin_Guide_Migration


 * HA Guide
 * Contact Meg McRoberts or Matt Griffin
 * Blueprint: https://blueprints.launchpad.net/openstack-manuals/+spec/improve-ha-guide


 * Security Guide
 * Contact Nathaniel Dillon
 * Info: https://etherpad.openstack.org/p/sec-guide-rst

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.

Docs Tools
Thanks to Dave for picking up a bug this week and adding a navigation bar to the sidepane of the docs theme for our RST books. We should be releasing an updated docs theme shortly so you can play with this new functionality. In the meantime, if you have suggestions for the docs theme, raise the issue on the docs mailing list, or go right ahead and create a bug for it.

APAC Docs Swarm
The APAC team have been working on holding another doc swarm, this time working on the Architecture Design Guide. It's to be held at the Red Hat office in Brisbane, on 13-14 August. Check out http://openstack-swarm.rhcloud.com/ for all the info.

Doc team meeting
The US meeting got cancelled this week.

The next meetings are: APAC: Wednesday 5 August, 00:30:00 UTC US: Wednesday 12 August, 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
Three new spotlight bugs for you to sink your teeth into:

https://bugs.launchpad.net/openstack-manuals/+bug/1257018 VPNaaS isn't documented in cloud admin

https://bugs.launchpad.net/openstack-manuals/+bug/1257656 VMware: add support for VM diagnostics

https://bugs.launchpad.net/openstack-manuals/+bug/1261969 Document nova server package

--

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

Keep on doc'ing!

Lana

= 24 July 2015 =

Hi everyone,

Wow! What a great week for RST conversion patches! As I write this, there are only a handful of outstanding sections on the Cloud Admin and HA Guides, and well over 40 sections have now been converted on the Install Guide, with the conversion sprint running for another twelve hours or so. Thank you to everyone who has taken the time to grab a section and do a conversion, and to all those people who have given their +1 to a patch. I can't wait to see all our shiny new books up on docs.openstack.org :)

Progress towards Liberty

 * RST conversion:
 * Install Guide: Conversion is now underway, sign up here: https://wiki.openstack.org/wiki/Documentation/Migrate#Installation_Guide_Migration
 * Cloud Admin Guide: is nearly done. Sign up here: https://wiki.openstack.org/wiki/Documentation/Migrate#Cloud_Admin_Guide_Migration
 * HA Guide: is also nearly done. Get in touch with Meg or Matt: https://wiki.openstack.org/wiki/Documentation/HA_Guide_Update
 * Security Guide: Conversion is now underway, sign up here: https://etherpad.openstack.org/p/sec-guide-rst


 * 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 stalled on the Ironic docs, we need to pick this up again. Contact me if you want to know more, or are willing to help out.


 * Improve how we communicate with and support our corporate contributors
 * I have been brainstorming ideas with Foundation, watch this space!


 * 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
 * Sadly, no progress on the spotlight bugs from last week. I'll hold them over for another week, so now is your chance to jump in and grab them!

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
 * Sign up here: https://wiki.openstack.org/wiki/Documentation/Migrate#Installation_Guide_Migration
 * The sprint on this book has been a major success, and there's still about twelve hours left until it wraps up at 1500 UTC (24 July). Info and sign up here: https://wiki.openstack.org/wiki/VirtualSprints#Installation_guide_conversion_from_DocBook_to_RST


 * Cloud Admin Guide:
 * Contact Brian Moss & Joseph Robinson
 * Sign up to help out here: https://wiki.openstack.org/wiki/Documentation/Migrate#Cloud_Admin_Guide_Migration


 * HA Guide
 * Contact Meg McRoberts or Matt Griffin
 * Blueprint: https://blueprints.launchpad.net/openstack-manuals/+spec/improve-ha-guide


 * Security Guide
 * Contact Nathaniel Dillon
 * Info: https://etherpad.openstack.org/p/sec-guide-rst

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.

HA Guide Works
With the RST conversion on the HA Guide wrapping up, the HA Guide speciality team are looking for people to help out with the reorganisation and writing the new content. They have quite a few bugs to get through, and they need your help! Contact Matt Griffin, or any other member of the HA Guide Speciality Team, or join their weekly IRC meeting. Details here: https://wiki.openstack.org/wiki/Documentation/HA_Guide_Update

Docs Tools
While they're not strictly docs tools, I wanted to mention review dashboards here today. Did you know that we maintain a list of custom OpenStack review dashboards for you to use? They're customised to show only the reviews you care about, which can save you a lot of time and needless clicking. All you need to do is pick the dashboard you want to use, copy the URL, and save it to your bookmarks. Anne has just updated the Docs Review Inbox dashboard to include DocImpact reviews, so it's worth checking out: http://ghostcloud.net/openstack_gerrit_dashboards/dashboard_doc-program.html You can see the full list here: http://ghostcloud.net/openstack_gerrit_dashboards/

APAC Docs Swarm
The APAC team have been working on holding another doc swarm, this time working on the Architecture Design Guide. It's to be held at the Red Hat office in Brisbane, on 13-14 August. Check out http://openstack-swarm.rhcloud.com/ for all the info.

Doc team meeting
The APAC docs meeting was held this week, catch up on the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-07-22

The next meetings are: US: Wednesday 29 July, 14:00:00 UTC APAC: Wednesday 5 August, 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
Giving these three poor old bugs some extra oxygen:

https://bugs.launchpad.net/openstack-manuals/+bug/1241116 Using policies for protected properties

https://bugs.launchpad.net/openstack-manuals/+bug/1241179 Add notifications for groups and roles

https://bugs.launchpad.net/openstack-manuals/+bug/1251060 Xenapi: Allow windows builds with xentools 6.1 and 6.2

--

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

Keep on doc'ing!

Lana

= 17 July 2015 =

Hi everyone,

I'm very pleased to announce that we finally have a name for our M release: Mitaka (三鷹)! Accordingly, the Tokyo Summit for the Mitaka release is only just over 100 days away. CFP closed a couple of days ago, and I've noticed that the first round of ATC discount codes have gone out. If you haven't got yours yet, then keep patching Liberty and sit tight. The discount codes will come out in stages after every snapshot. This week, we've had some great discussions about networking scenarios in the Install Guide, and the best way to include RST files in our newly converted books. We also have both the HA Guide and the Cloud Admin Guide conversions in their final stages, and the Install Guide conversion sprint coming up. Very exciting!

Progress towards Liberty

 * RST conversion:
 * Install Guide: Conversion is now underway, sign up here: https://wiki.openstack.org/wiki/Documentation/Migrate#Installation_Guide_Migration
 * Cloud Admin Guide: is nearly done. Sign up here: https://wiki.openstack.org/wiki/Documentation/Migrate#Cloud_Admin_Guide_Migration
 * HA Guide: is also nearly done. Get in touch with Meg or Matt: https://wiki.openstack.org/wiki/Documentation/HA_Guide_Update
 * Security Guide: Spec has merged. Planning is happening here: https://etherpad.openstack.org/p/sec-guide-rst


 * 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 stalled on the Ironic docs, we need to pick this up again. Contact me if you want to know more, or are willing to help out.


 * Improve how we communicate with and support our corporate contributors
 * I have been brainstorming ideas with Foundation, watch this space!


 * 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
 * A small amount of progress on the old bugs we held over from last week. New ones to check out in this newsletter!

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
 * Sign up here: https://wiki.openstack.org/wiki/Documentation/Migrate#Installation_Guide_Migration
 * There's a sprint happening on this book later next week. Info and sign up here: https://wiki.openstack.org/wiki/VirtualSprints#Installation_guide_conversion_from_DocBook_to_RST


 * Cloud Admin Guide:
 * Contact Brian Moss & Joseph Robinson
 * Sign up to help out here: https://wiki.openstack.org/wiki/Documentation/Migrate#Cloud_Admin_Guide_Migration


 * HA Guide
 * Contact Meg McRoberts or Matt Griffin
 * Blueprint: https://blueprints.launchpad.net/openstack-manuals/+spec/improve-ha-guide


 * Security Guide
 * Contact Nathaniel Dillon
 * Bug: https://bugs.launchpad.net/openstack-manuals/+bug/1463111
 * Info: https://etherpad.openstack.org/p/sec-guide-rst

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.

Install Guide RST Conversion Sprint
In order to kick off the RST conversion of the Install Guide, the speciality team have decided to run a virtual conversion sprint over two days on July 22-24. For more information, see the https://wiki.openstack.org/wiki/VirtualSprints#Installation_guide_conversion_from_DocBook_to_RST wiki page, and the https://etherpad.openstack.org/p/installguide-rst-virtual-sprint etherpad.

HA Guide Works
With the RST conversion on the HA Guide wrapping up, the HA Guide speciality team are looking for people to help out with the reorganisation and writing the new content. They have quite a few bugs to get through, and they need your help! Contact Matt Griffin, or any other member of the HA Guide Speciality Team, or join their weekly IRC meeting. Details here: https://wiki.openstack.org/wiki/Documentation/HA_Guide_Update

Docs Tools
Last week, we released openstackdocstheme 1.1.0, see http://lists.openstack.org/pipermail/openstack-announce/2015-June/000392.html. The main new features in this release are improvements for bug reporting, variable lists like the glossary are now indented, and next/prev links are now icons on the upper right part of the page.

Additionally, the stable/icehouse branch of openstack-manuals has been EOLed, no further updates will be done from it. For more information, see http://lists.openstack.org/pipermail/openstack-infra/2015-July/002888.html

Doc team meeting
The next meetings are:

APAC: Wednesday 22 July, 00:30:00 UTC

US: Wednesday 29 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
We've now got people assigned to work on last week's old bugs, which is great! Here are three more rusty old bugs that could use some love:

https://bugs.launchpad.net/openstack-manuals/+bug/1241116 Using policies for protected properties

https://bugs.launchpad.net/openstack-manuals/+bug/1241179 Add notifications for groups and roles

https://bugs.launchpad.net/openstack-manuals/+bug/1251060 Xenapi: Allow windows builds with xentools 6.1 and 6.2

--

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

Keep on doc'ing!

Lana

= 10 July 2015 =

Hi everyone,

First of all, apologies for my absence over the past couple of weeks. I took some time off to spend with my daughter while she was on school holidays, and then got ill! It never rains but it pours ;) While I was out, our M release was named, and then unnamed, and we're now waiting for a new name. We also had a great discussion about which networking scenario is the best fit for our new-and-improved Installation Guide, and planned a sprint to get the RST conversion for that book happening. More on that in this newsletter.

Progress towards Liberty

 * RST conversion:
 * Install Guide: Conversion is now underway, sign up here: https://wiki.openstack.org/wiki/Documentation/Migrate#Installation_Guide_Migration
 * Cloud Admin Guide: is nearly done. 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
 * I have been brainstorming ideas with Foundation, watch this space!


 * 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
 * Sadly, no progress this week.

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
 * Sign up here: https://wiki.openstack.org/wiki/Documentation/Migrate#Installation_Guide_Migration
 * There's a sprint happening on this book later this month. Info and sign up here: https://wiki.openstack.org/wiki/VirtualSprints#Installation_guide_conversion_from_DocBook_to_RST


 * Cloud Admin Guide:
 * Contact Brian Moss & Joseph Robinson
 * Sign up to help out here: https://wiki.openstack.org/wiki/Documentation/Migrate#Cloud_Admin_Guide_Migration


 * HA Guide
 * Contact Meg McRoberts or Matt Griffin
 * Blueprint: https://blueprints.launchpad.net/openstack-manuals/+spec/improve-ha-guide


 * Security Guide
 * Contact Nathaniel Dillon
 * Bug: https://bugs.launchpad.net/openstack-manuals/+bug/1463111
 * Spec: https://review.openstack.org/#/c/196165/

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.

Install Guide RST Conversion Sprint
In order to kick off the RST conversion of the Install Guide, the speciality team have decided to run a virtual conversion sprint over two days on July 22-24. For more information, see the https://wiki.openstack.org/wiki/VirtualSprints#Installation_guide_conversion_from_DocBook_to_RST wiki page, and the https://etherpad.openstack.org/p/installguide-rst-virtual-sprint etherpad.

New core team
The core team have just completed our review for July, and would like to welcome two new core contributors: Alexandra Settle, and Olena Logvinova. Congratulations to you both :)

Doc team meeting
The APAC meeting was cancelled this week, our next meetings are:

US: Wednesday 15 July, 14:00:00 UTC (note that this has NOT changed with daylight savings time) APAC: Wednesday 22 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
Sadly, even with an extra week, our three spotlight bugs remain unloved. I'm going to keep them here for another week, so now is your chance to swoop in and make a difference!

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

--

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

Keep on doc'ing!

Lana

= 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:


 * Install Guide:
 * Contact Karin Levenstein
 * Sign up here: https://wiki.openstack.org/wiki/Documentation/Migrate#Installation_Guide_Migration


 * Cloud Admin Guide:
 * Contact Brian Moss & Joseph Robinson
 * Sign up to help out here: https://wiki.openstack.org/wiki/Documentation/Migrate#Cloud_Admin_Guide_Migration


 * HA Guide
 * Contact Meg McRoberts or Matt Griffin
 * Blueprint: https://blueprints.launchpad.net/openstack-manuals/+spec/improve-ha-guide


 * Security Guide
 * Contact Nathaniel Dillon
 * 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.

Docs Tools
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!

Documentation Standards
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 :)

Docs Liaisons
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:

https://wiki.openstack.org/wiki/CrossProjectLiaisons#Documentation

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-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

--

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

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:
 * Contact Karin Levenstein
 * 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 & Joseph Robinson
 * 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 or Matt Griffin
 * Blueprint: https://blueprints.launchpad.net/openstack-manuals/+spec/improve-ha-guide


 * Security Guide
 * Contact Nathaniel Dillon
 * 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.

Docs Tools
Andreas will shortly be updating openstack-docs-tools to 0.29.

Docs Liaisons
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!

https://wiki.openstack.org/wiki/CrossProjectLiaisons#Documentation

i18n Team
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.

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-17

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

--

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

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
 * 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 & Joseph Robinson
 * 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 or Matt Griffin
 * Blueprint: https://blueprints.launchpad.net/openstack-manuals/+spec/improve-ha-guide


 * Security Guide
 * Contact Nathaniel Dillon
 * 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: []
 * 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
 * Blueprint: https://blueprints.launchpad.net/openstack-manuals/+spec/installguide-liberty
 * Spec WIP: https://review.openstack.org/#/c/183138/


 * Cloud Admin Guide:
 * Contact Brian Moss & Joseph Robinson
 * 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 or Matt Griffin
 * 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
 * Blueprint: https://blueprints.launchpad.net/openstack-manuals/+spec/installguide-liberty
 * Spec WIP: https://review.openstack.org/#/c/183138/


 * Cloud Admin Guide:
 * Contact Brian Moss & Joseph Robinson
 * 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 or Matt Griffin
 * 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