Jump to: navigation, search

Difference between revisions of "Documentation/WhatsUpDoc"

(7 October 2016)
m
 
(27 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
= Documentation Newsletters =
 
= Documentation Newsletters =
This is where I draft the 'What's Up, Doc?' documentation newsletters. The newsletter is distributed every Friday (ish), to the openstack-docs mailing list. If you want to be added to the distribution list, or have content to add, please edit these sections:
+
This is where I draft the 'What's Up, Doc?' documentation newsletters. The newsletter is distributed every second Friday (ish), to the openstack-docs mailing list. If you want to be added to the distribution list, or have content to add, please edit these sections:
  
 
==== Distribution List ====
 
==== Distribution List ====
* OpenStack Docs Mailing List <Openstack-docs@lists.openstack.org>
 
 
* OpenStack Development Mailing List <openstack-dev@lists.openstack.org>
 
* OpenStack Development Mailing List <openstack-dev@lists.openstack.org>
 
* Docs liaisons (from https://wiki.openstack.org/wiki/CrossProjectLiaisons#Documentation)
 
* Docs liaisons (from https://wiki.openstack.org/wiki/CrossProjectLiaisons#Documentation)
Line 10: Line 9:
 
==== Content Sources ====
 
==== Content Sources ====
  
Speciality team reports are gathered here: https://etherpad.openstack.org/p/Speciality_Team_Reports
+
Speciality team reports are gathered in the docs meeting every two weeks. If you are a speciality team leader and can't attend the  meeting, please either send a proxy to the meeting, or email your report to the meeting chair ahead of time.
 +
 
 +
If you have something that you would like to add to the next newsletter, please add it here:
  
* Your
 
* Content
 
* Here
 
 
*  
 
*  
  
Line 20: Line 18:
 
You can see older newsletters here: [[Documentation/WhatsUpDoc_Archive]]
 
You can see older newsletters here: [[Documentation/WhatsUpDoc_Archive]]
  
= 7 October 2016 =
+
= 7 April 2017 =
 
 
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.
+
Team,
* 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
+
This week I have still been working on drafting a governance tag for our guides called "docs:follows-policy". I have been working with Doug Hellmann (dhellmann) in the last week to change to draft dramatically, so it would be good for docs people to review again. We are trying to make this a more broad tag now, so it can be applied for other guides too. To review: https://review.openstack.org/#/c/445536/ I am also in the process of documenting guidelines in our Contribution Guide - which would also benefit from doc reviews: https://review.openstack.org/#/c/453642/
  
== Core Team Review ==
+
Would like to call out and thank John Davidge for his awesome work with the Networking Guide and neutron-related patches. He's been providing valuable guidance, and reviews, and it has been greatly appreciated by myself and the team.
  
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.
+
Lana Brindley has done an awesome job for the last two weeks in keeping our bug list under control. We are down to an amazing 102 bugs in queue, and 82 bugs closed this cycle already!
 +
Next week, I will be looking after the bug triage liaison role!
 +
If you're sitting there thinking "bugs are for me, I really love triaging bugs!" well, you're in luck! We have one spot open for the rest of the cycle (14 Aug - 28 Aug): https://wiki.openstack.org/wiki/Documentation/SpecialityTeams#Bug_Triage_Team
  
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.
+
== The Road to the Summit in Boston ==
  
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!
+
Keep an eye out for the docs and I18n have a project onboarding room at the summit. Melvin Hillsman (mrhillsman) of the User Committee submitted a forum topic for the Ops Guide to get operator feedback.
 
+
David Flanders from the Foundation has also proposed a forum topic for developer.openstack.org (which currently houses our API, SDK, and other dev stuff). We'll be discussing major changes to that and would like to see some feedback from people here. Any questions on that, shoot it my way. My main objective for this forum topic is to reduce our current technical debt that lives on this site.
I thank you both for your commitment to being core team members, and for all your contributions. We are better because of your effort.
+
For more information on forum topics: https://wiki.openstack.org/wiki/Forum
 +
Schedule has been released: https://www.openstack.org/summit/boston-2017/summit-schedul
  
 
== Speciality Team Reports ==
 
== Speciality Team Reports ==
  
'''HA Guide: Andrew Beekhof'''
+
* API - Anne Gentle: API versioning in relation to release versioning is currently manually compiled for the 40-ish API services, so ideas on how to automate and surface that info welcomed. More info: http://lists.openstack.org/pipermail/openstack-dev/2017-March/114690.html
Organizing a HA meetup at summit
+
* Configuration Reference and CLI Reference - Tomoyuki Kato: N/A
Intention is get an update plan finalized shortly
+
* High Availability Guide - Ianeta Hutchinson: We are continuing to collaborate with OS DevOps team. See the tag ha-guide-draft for bugs opened to fill content for the new guide.
 
+
* Hypervisor Tuning Guide - Blair Bethwaite: N/A
'''Install Tutorials: Lana Brindley'''
+
* Installation guides - Lana Brindley: We have now branched, so please remember to backport if you have edits to the Ocata guide now. Big thanks to all the testers who have been working hard over the past month or two (that Nova cells bug was *tough*!), and to Brian and Mariia for doing the heavy lifting. Noticed a bunch links to draft versions of the guide in Newton/Ocata branches, backports for that have been merged, and the Contributor Guide updated so we don't miss it in the future (https://docs.openstack.org/contributor guide/release/taskdetail.html#update-links-in-all-books).
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 - John Davidge: More patches landed in the last couple of weeks dealing with the move to OSC, and more are still in flight. Progress also continues on RFC 5737 compliance. Thanks to all contributors for their work.
 
+
* Operations and Architecture Design guides - Darren Chan: Arch Guide: edited architecture considerations content and cleaned up the index page structure which was applied across OS manuals. Some ops-related content was moved to the Ops Guide. Our current focus is improving the storage design content and networking design content.
'''Networking Guide: Edgar Magana'''
+
* Training Guides - Matjaz Pancur: N/A
No report this week.
+
* Training labs - Roger Luethi: We released the Ocata version of training-labs this week.
 
+
* User guides - Joseph Robinson: For the user guides - the spec on migrating the Admin Guide content this week moved closer to merging. I started preparing the work items for action on the User Guides tasks wiki page.
'''Security Guide: Nathaniel Dillon'''
+
* Theme and Tools - Brian Moss: Anne has a spec up for theme consolidation, please check it out: https://review.openstack.org/#/c/454346/, Brian has fixed up the sitemap tool tests, reviews welcome: https://review.openstack.org/#/c/453976/. 41 open bugs, 13 closed in Pike
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 ==
 
== Doc team meeting ==
 +
 +
Our next meeting will be on Thursday, 20 April at 2100 UTC in #openstack-meeting-alt.
 +
For more meeting details, including minutes and the agenda: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting
 +
The meeting chair will be me!
  
Next meetings:
+
Big thanks to Joseph for stepping up in the last 2 meetings and hosting in my absence! Really appreciated it :)
 
 
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
 
  
 
--
 
--
 +
 +
Have a great week :)
 +
 +
Alex
  
Keep on doc'ing!
+
IRC: asettle
 
+
Twitter: dewsday
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.
+
= 27 March 2017 =
  
== Progress towards Newton ==
+
Team team team team team,
  
33 days to go!
+
Well the last month has just FLOWN by since the PTG. We've got plenty going on in the docs team...
  
Bugs closed so far: 407
+
This week I have been helping out the security team with the Security Guide. We've been working on some cursory edits, and removal of content. A few patches have already made it through - thanks to the OSIC security team for tackling some of the outstanding bugs. There'll be more edits coming from me in the next few weeks. To see our planning: https://etherpad.openstack.org/p/sec-guide-pike
 +
I am also in the process of drafting a governance tag for our install guides. Would be great for everyone to review and understand what the process will involve: https://review.openstack.org/#/c/445536/
  
Release managers: Olena Logvinova and Alexandra Settle
+
Shoutout and big thanks to Brian Moss and the nova team who worked together tirelessly to document Nova v2 Cells and Placement API - which was a massive blocker for our Installation Guide.
  
Install Guide testing is being tracked here: https://wiki.openstack.org/wiki/Documentation/NewtonDocTesting
+
Also, thank you to our Ocata release managers, Maria Zlatkova and Brian Moss for cutting the branch! Pike is well and truly underway now.
  
== The Road to Barcelona ==
+
Ianeta Hutchinson has done an awesome job for the last two weeks in keeping our bug list under control. We are down to an amazing 104 bugs in queue, and 59 bugs closed this cycle already!
  
* 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.
+
Next week, we have Lana who will be looking after the bug triage liaison role!  
* Talk acceptances have gone out, congratulations to everyone who got something accepted!  
+
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
* 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 ==
+
== The Road to the Summit in Boston ==
  
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.
+
* Schedule has been released: https://www.openstack.org/summit/boston-2017/summit-schedule/
 +
* Docs and I18n have a project onboarding room at the summit, keep an eye out on the dev ML for more information. Kendall will inform us when the time comes. Anyone around to help me with that? http://lists.openstack.org/pipermail/openstack-dev/2017-March/114149.html
 +
* Docs project update will be delivered by me (asettle) on Mon 8 , 3:40pm-4:20pm. https://www.openstack.org/summit/boston-2017/summit-schedule/global-search?t=Alexandra+Settle
  
 
== Speciality Team Reports ==
 
== Speciality Team Reports ==
  
'''HA Guide: Andrew Beekhof'''
+
* API - Anne Gentle: There's still a lot of discussion on https://review.openstack.org/#/c/421846/ which is about API change guidelines. Take a look and join in on the review. Also on the openstack-dev list, there's a thread about the future of the app catalog, which is relevant to the app developer audience so I include it here: http://lists.openstack.org/pipermail/openstack dev/2017-March/113362.html Also related to the app dev audience is the wrapping up of the App Ecosystem working group: http://lists.openstack.org/pipermail/user-committee/2017-March/001825.html
No report this week.
+
* Configuration Reference and CLI Reference - Tomoyuki Kato: N/A
 
+
* High Availability Guide - Ianeta Hutchinson: At the Atlanta PTG, the documentation team outlined a new table of contents that is now upstream as a draft here: https://github.com/openstack/openstack-manuals/tree/master/doc/ha-guide-draft. A blocker to progress in the past had been a lack of SME’s for the topic of high availability but that is no longer the case \o/. The OSIC DevOps team has an “adopt-a-guide” project in which they are collaborating with the OpenStack docs community and OSIC Docs team to apply the new ToC and validate all content for the guide. The progress of this collaboration is being tracked here <https://docs.google.com/spreadsheets/d/1hw4axU2IbLlsjKpz9_EGlKQt0S6siViik7ETjNg_MgI/edit?usp=sharing> We are calling for more contributors both as SME's and tech writers. Ping iphutch if interested!
'''Install Tutorials: Lana Brindley'''
+
* Hypervisor Tuning Guide - Blair Bethwaite: N/A
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.
+
* Installation guides - Lana Brindley: Cells bug is closer to being fixed, and we are closer to a complete test install (https://wiki.openstack.org/wiki/Documentation/NewtonDocTesting look at all that green!). We're planning to branch Ocata by the end of this week.
 
+
* Networking Guide - John Davidge: N/A
'''Networking Guide: Edgar Magana'''
+
* Operations and Architecture Design guides - Darren Chan: Arch Design Guide: Minor IA and general cleanup of the storage, compute, and networking sections in the Design chapter. Currently updating gaps in storage design content. Ops Guide: Removed cloud architecture content (migrated to the Arch Design Guide).
No report this week.
+
* Security Guide - Nathaniel Dillon: Edits from Alex going through, and patches from the OSIC DevOps team. See above for more info.
 
+
* Training Guides - Matjaz Pancur: For Training guides related topics: a new brand for activities around OpenStack Upstream University/Training. It is now known as OpenStack Upstream Institute (https://wiki.openstack.org/wiki/OpenStack_Upstream_Institute)
'''Security Guide: Nathaniel Dillon'''
+
* Training labs - Roger Luethi: We are currently testing our automated version of the Ocata install-guide. We had a problem with Ubuntu's new ISO image (16.04.2 LTS) which is now resolved.
No report this week.
+
* User guides - Joseph Robinson: Several other Legacy commands were converted to OS commands this week. Reviewed the Admin Guide spec.
 
+
* Theme and Tools - Brian Moss: I'd like to do an openstackdocstheme release soon, as we've got some items (PDF styling, search page JS fix, image centering) that would be good to have in production. Any concerns or last minute items to merge please let me know. We've had some issues come up with the auto-generation scripts. Some have been fixed already (thanks Kato and Christian!), and we're investigating others. If you notice anything amiss or would like to help out, please let me know. 46 open bugs, 8 closed in Pike
'''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 ==
 
== Doc team meeting ==
 
+
Next meetings:
+
Our next meeting will be on Thursday, 7 April at 2100 UTC in #openstack-meeting-alt.
 
+
For more meeting details, including minutes and the agenda: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting
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
 
  
 
--
 
--
 +
 +
Have a great week :)
 +
 +
Alex
  
Keep on doc'ing!
+
IRC: asettle
 
+
Twitter: dewsday
Lana
 
 
 
https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#2_September_2016
 

Latest revision as of 17:37, 30 November 2017

Documentation Newsletters

This is where I draft the 'What's Up, Doc?' documentation newsletters. The newsletter is distributed every second Friday (ish), to the openstack-docs mailing list. If you want to be added to the distribution list, or have content to add, please edit these sections:

Distribution List

Content Sources

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

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

Looking for older editions?

You can see older newsletters here: Documentation/WhatsUpDoc_Archive

7 April 2017

Team,

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

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

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

The Road to the Summit in Boston

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

Speciality Team Reports

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

Doc team meeting

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

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

--

Have a great week :)

Alex

IRC: asettle Twitter: dewsday

27 March 2017

Team team team team team,

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

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

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

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

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

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

The Road to the Summit in Boston

Speciality Team Reports

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

Doc team meeting

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

--

Have a great week :)

Alex

IRC: asettle Twitter: dewsday