Jump to: navigation, search

Difference between revisions of "Documentation/WhatsUpDoc"

(Speciality Teams)
(Core Team Changes)
Line 101: Line 101:
 
== Core Team Changes ==
 
== Core Team Changes ==
  
During last week, I announced some changes to the docs-specs core team. Previously, this core team was a small subset of docs core team members, with an understanding that we would wait for speciality team leads to +1 a spec relevant to their team before approving. Now we have formalised that process by inviting each speciality team lead to the docs-specs core team, so that they can +2A their own specs. Speciality team leads are listed on the wiki here: https://wiki.openstack.org/wiki/Documentation/SpecialityTeams remember to engage them when you create a new spec for approval.
+
I would like to offer a warm welcome to Atsushi Sakai as our newest core team member. Welcome to the team :)
  
We have also reviewed the current docs core team list for December, and the results of that will be announced shortly. We will not be reviewing the team in January because of the holiday period, and will resume regular reviews in February 2016.  
+
We will resume regular reviews in February 2016.
  
 
== Doc team meeting ==
 
== Doc team meeting ==

Revision as of 02:59, 11 December 2015

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

11 December 2015

Hi everyone,

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

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

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

Progress towards Mitaka

117 days to go!

150 bugs closed so far for this release.

RST Conversions

  • Arch Guide
    • RST conversion is complete! Well done Shilla and team for getting this done so incredibly quickly :)
  • Config Ref
  • Virtual Machine Image Guide
    • Is complete! Well done Tomoyuki-san :)

Reorganisations

DocImpact

  • Waiting to merge the patch for the new Jenkins job: https://review.openstack.org/#/c/251301/ which for now will be against Nova only so we can make sure it's working correctly before we roll it out across the board.

Document openstack-doc-tools and reorganise index page

  • Thanks to Brian and Christian for volunteering to take this on!

Horizon UX work

Speciality Teams

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

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

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

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

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

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

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

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

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

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

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

Core Team Changes

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

We will resume regular reviews in February 2016.

Doc team meeting

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

Next meetings: APAC: Wednesday 9 December, 00:30:00 UTC (CANCELLED) US: Wednesday 16 December, 14:00 UTC

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

--

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

Keep on doc'ing! Lana

4 December 2015

Hi everyone,

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

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

Progress towards Mitaka

121 days to go!

139 bugs closed so far for this release.

RST Conversions

Reorganisations

DocImpact

  • This is now well underway, with the first two patches merged. One changes the default bug queue for DocImpact back to the projects' own queue, and the other changes all current projects (with the exception of the six defcore projects) to their own bug queue. There has also been some discussion on the mailing lists about this process change. The next step is to merge the new Jenkins job (https://review.openstack.org/#/c/251301/) which for now will be against Nova only so we can make sure it's working correctly before we roll it out across the board. Thank you to Andreas, Josh Hesketh, and everyone else who has helped get us this far, and to the Nova team who are allowing us to use them as guinea pigs.

Document openstack-doc-tools and reorganise index page

  • Thanks to Brian and Christian for volunteering to take this on!

Horizon UX work

Speciality Teams

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

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

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

Security Guide - Nathaniel Dillon No update this week

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

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

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

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

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

Training Guides - Matjaz Pancur No update this week

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

Core Team Changes

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

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

Doc team meeting

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

Next meetings: APAC: Wednesday 9 December, 00:30:00 UTC (CANCELLED) US: Wednesday 16 December, 14:00 UTC

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

--

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

Keep on doc'ing! Lana