Jump to: navigation, search

Difference between revisions of "Documentation/WhatsUpDoc"

(Your suggestions for content)
Line 19: Line 19:
 
==== Looking for older editions? ====
 
==== Looking for older editions? ====
 
You can see older newsletters here: [[Documentation/WhatsUpDoc_Archive]]
 
You can see older newsletters here: [[Documentation/WhatsUpDoc_Archive]]
 
= 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
 

Revision as of 04:43, 6 May 2016

Documentation Newsletters

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

Distribution List

Your suggestions for content

Looking for older editions?

You can see older newsletters here: Documentation/WhatsUpDoc_Archive