Jump to: navigation, search

Difference between revisions of "Documentation/WhatsUpDoc"

(Your suggestions for content)
m
 
(148 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)
 
* i18n List <openstack-i18n@lists.openstack.org>
 
* i18n List <openstack-i18n@lists.openstack.org>
  
==== Your suggestions for content ====
+
==== Content Sources ====
* Your
 
* Content
 
* Here
 
* The operations-guide repository is now frozen. The content is converted to RST and now part of the openstack-manuals repository. Last cleanup edits are ongoing before the RST version gets published.
 
* The api reference content is moving from api-site to project specific repositories and is now (double check!) frozen. Documentation on how to migrate is available at XXX.
 
* The docs toolchain is removing DocBook XML support, see spec https://review.openstack.org/311698 for details.
 
*  Mobile apps are now available. Don’t delay - download and build your personal schedule now for the best performance!  iOS / Apple: https://itunes.apple.com/us/app/openstack-foundation-summit/id1071261846?mt=8 and Google Play / Android: https://play.google.com/store/apps/details?id=org.openstack.android.summit
 
  
==== Looking for older editions? ====
+
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.
You can see older newsletters here: [[Documentation/WhatsUpDoc_Archive]]
 
  
= 1 April 2016 =
+
If you have something that you would like to add to the next newsletter, please add it here:
  
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.
+
==== Looking for older editions? ====
 
+
You can see older newsletters here: [[Documentation/WhatsUpDoc_Archive]]
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!
+
= 7 April 2017 =
  
Docs Testing
+
Team,
* Volunteers required!
 
* https://wiki.openstack.org/wiki/Documentation/MitakaDocTesting
 
  
Release Managers:
+
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/
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 ==
+
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.
  
* Speaker acceptances have now gone out, and the schedule is available: https://www.openstack.org/summit/austin-2016/summit-schedule/#day=2016-04-24
+
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!
* 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.
+
Next week, I will be looking after the bug triage liaison role!
* I have requested workrooms and fishbowls for the Austin Design Summit. I'll let you know when we get our allocation.
+
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
* 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 ==
+
== The Road to the Summit in Boston ==
  
'''HA Guide - Bogdan Dobrelya'''
+
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.
No update this week.
+
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
  
'''Installation Guide - Matt Kassawara'''
+
== Speciality Team Reports ==
No update this week.
 
  
'''Networking Guide - Edgar Magana'''
+
* 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
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
+
* 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.
'''Security Guide - Nathaniel Dillon'''
+
* Hypervisor Tuning Guide - Blair Bethwaite: N/A
No update this week.
+
* 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.
'''User Guides - Joseph Robinson'''
+
* 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.
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.
+
* Training Guides - Matjaz Pancur: N/A
 
+
* Training labs - Roger Luethi: We released the Ocata version of training-labs this week.
'''Ops and Arch Guides - Shilla Saebi'''
+
* 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.
No update this week.
+
* 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
 
 
'''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 ==
 
== 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-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
 
  
 
--
 
--
 +
 +
Have a great week :)
 +
 +
Alex
  
Keep on doc'ing!
+
IRC: asettle
 +
Twitter: dewsday
  
Lana
+
= 27 March 2017 =
  
https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#11_March_2016
+
Team team team team team,
  
= 4 March 2016 =
+
Well the last month has just FLOWN by since the PTG. We've got plenty going on in the docs team...
  
Hi everyone,
+
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/
  
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.
+
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.
  
== Progress towards Mitaka ==
+
Also, thank you to our Ocata release managers, Maria Zlatkova and Brian Moss for cutting the branch! Pike is well and truly underway now.
  
33 days to go!
+
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!
  
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
+
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
  
Docs Testing
+
== The Road to the Summit in Boston ==
* Volunteers required!
 
* https://wiki.openstack.org/wiki/Documentation/MitakaDocTesting
 
  
API Docs
+
* Schedule has been released: https://www.openstack.org/summit/boston-2017/summit-schedule/
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!
+
* 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
  
Release Managers:
+
== Speciality Team Reports ==
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 ==
+
* 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
* The final round of ATC passes have now gone out.
+
* 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!
* I have requested workrooms and fishbowls for the Austin Design Summit. I'll let you know when we get our allocation.
+
* Hypervisor Tuning Guide - Blair Bethwaite: N/A
* 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
+
* 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
== Core Team reviews ==
+
* 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.
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
+
* 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.
== Speciality Teams ==
+
* 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
'''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 ==
 
== 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, 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
 
  
 
--
 
--
 +
 +
Have a great week :)
 +
 +
Alex
  
Keep on doc'ing!
+
IRC: asettle
 
+
Twitter: dewsday
Lana
 
 
 
https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#4_March_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