Jump to: navigation, search

Difference between revisions of "Documentation/WhatsUpDoc"

(15 January 2016)
Line 20: Line 20:
 
Hi everyone,
 
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.
+
Welcome to 2016! A short newsletter this week as I get my feet back under me after my vacation. I hope you all had a wonderful holiday period, and got some well-earned down time. I'm looking forward to working hard with you all over the next few months to get Mitaka out into the wild :)
 
 
I would like to take a moment to acknowledge the incredible work of the entire documentation team, especially the core team who have worked all year to keep on top of reviews, the speciality team leads who motivate and inspire their teams each and every day, and every single documentation contributor and reviewer: without you all doing your little bit, we wouldn't have had the success we have had. Thank you also to our crew of support people: from infra and release management, to our subject matter experts and the wonderful people on the TC and at Foundation. Thanks for helping us be the best we can be. I would also like to make special mention of Andreas Jaeger and Anne Gentle, who both continue to hold my hand daily and make sure I don't make too much of a fool of myself in public. Your support and encouragement have been invaluable.
 
 
 
While we're on the goodwill wagon: if there's someone (or something!) you would like to call out for a special mention, you can do so using #success in our IRC channel. All successes get logged here: https://wiki.openstack.org/wiki/Successes and it's a great way to show your appreciation for your fellow community members.
 
  
 
== Progress towards Mitaka ==
 
== Progress towards Mitaka ==
  
117 days to go!
+
82 days to go!
  
150 bugs closed so far for this release.
+
324 bugs closed so far for this release.
  
 
RST Conversions
 
RST Conversions
* Arch Guide
+
* All RST conversions are now complete! Well done to all the contributors and reviewers who made this happen so quickly this time around. We are now, with only a couple of exceptions, completely converted. Great job :)  
** RST conversion is complete! Well done Shilla and team for getting this done so incredibly quickly :)
 
* Config Ref
 
** Is underway: contact the Config Ref Speciality team: https://wiki.openstack.org/wiki/Documentation/ConfigRef
 
* Virtual Machine Image Guide
 
** Is complete! Well done Tomoyuki-san :)
 
  
 
Reorganisations
 
Reorganisations
 
* Arch Guide
 
* Arch Guide
 
** https://blueprints.launchpad.net/openstack-manuals/+spec/archguide-mitaka-reorg
 
** https://blueprints.launchpad.net/openstack-manuals/+spec/archguide-mitaka-reorg
** Doc sprint planned for December 21-22. Contact the Ops Guide speciality team for more info or to get  involved.
 
 
** Contact the Ops Guide Speciality team: https://wiki.openstack.org/wiki/Documentation/OpsGuide
 
** Contact the Ops Guide Speciality team: https://wiki.openstack.org/wiki/Documentation/OpsGuide
 
* User Guides
 
* User Guides
Line 50: Line 40:
  
 
DocImpact
 
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.
+
* After some discussion on the dev list, we're adjusting our approach to this problem. Stay tuned for more.
 
 
Document openstack-doc-tools and reorganise index page
 
* Thanks to Brian and Christian for volunteering to take this on!
 
 
 
Horizon UX work
 
* Thanks to the people who offered to help out on this! If you're interested but haven't gotten in touch yet, contact Piet Kruithof of the UX team. There is now a blueprint + spec in draft: https://blueprints.launchpad.net/openstack-manuals/+spec/ui-content-guidelines and https://review.openstack.org/#/c/252668/
 
  
 
== Speciality Teams ==
 
== Speciality Teams ==
  
'''HA Guide - Bogdan Dobrelya'''
+
No updates this week, as I'm totally disorganised. Next week for sure!
The change to shift IRC meeting was not accepted. Going to create a new poll this time with correct options suggested by Tony Breeds. No more updates.
 
 
 
'''Installation Guide - Christian Berendt'''
 
We require Debian Install Guide testers. Please contact Christian if you're interested.
 
 
 
'''Networking Guide - Edgar Magana'''
 
The networking guide had its first official IRC meeting: https://wiki.openstack.org/wiki/Documentation/NetworkingGuideMeetings We are restructuring a little bit the wikis for better engagement with new contributors; Versioning spec for networking guide has been merged: https://review.openstack.org/#/c/253283/ Working of the remaining actions items from the meeting: http://eavesdrop.openstack.org/meetings/networking_guide/2015/networking_guide.2015-12-03-16.00.txt We have proposed a time and date for an IRC meeting covering APAC time zone: https://review.openstack.org/#/c/254999/
 
 
 
'''Security Guide - Nathaniel Dillon'''
 
Planning for a bug sprint and general triage/cleanup.
 
 
 
'''User Guides - Joseph Robinson'''
 
The User Guide Reorganization Spec merged this week, and the final User Guide meeting for 2016 has been rescheduled to next Thursday December 16 at 23:30 UTC, and the plan is to discuss work items. A patch for the User Guide Dashboard has begun using the blueprint implementation as a start to the reorg.
 
 
 
'''Ops and Arch Guides - Shilla Saebi'''
 
Regarding this spec - https://review.openstack.org/#/c/227660/, we decided we are going to hold off until the N-release; Architecture Guide Swarm - Asking for everyone who wants to help to please use the https://etherpad.openstack.org/p/arch-guide-reorg to document potential changes; The arch guide RST conversion is complete; For the swarm, everyone works in their timezone. They will then submit patches and allocate team members in the other timezones to review; The final dates for the arch guide virtual swarm is: 12/21-12/22.
 
 
 
'''API Docs - Anne Gentle'''
 
Trimming down what is output so that eventually we'll get working Swagger migrated from WADL. Repo still awaits being pulled into gerrit: https://github.com/russell/fairy-slipper to
 
https://review.openstack.org/#/c/245352/ Nova API docs sprint 12/8 and 12/9 came up with good questions and answers and patches. Also, the Gabbi API test suite has a new release, see http://lists.openstack.org/pipermail/openstack-dev/2015-December/081891.html
 
 
 
'''Config Ref - Gauvain Pocentek'''
 
The configuration reference RST migration is almost done, only a few more Block Storage drivers docs to handle. Thanks to all the contributors!  
 
 
 
'''Training labs - Roger Luethi'''
 
Training-labs merged a KVM provider patch which allows the training cluster to build on top of KVM. The IP address ranges now match the install guides. The Liberty training cluster is being worked on.
 
 
 
'''Training Guides - Matjaz Pancur'''
 
Through no fault of Matjaz', this report was erroneously left out of the last newsletter, sorry for the delay:
 
A complete Korean translation of the Upstream training material is officially published at http://docs.openstack.org/ko_KR/upstream-training/ (big thanks to Ian Y. Choi and KATO Tomoyuki)
 
 
 
'''Hyperviser Tuning Guide - Joe Topjian'''
 
Finished the first pass of converting etherpad notes to the wiki. I sent an email <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 ==
 
== Core Team Changes ==
Line 103: Line 54:
 
== Doc team meeting ==
 
== Doc team meeting ==
  
We failed to hold the APAC docs meeting this week because I can't read a calendar, and clearly just need a holiday. My apologies!
+
There's been some confusion over the meeting schedule, but as far as I can tell, these are the next meeting dates:
  
 
Next meetings:
 
Next meetings:
US: Wednesday 16 December, 14:00 UTC
+
US: Wednesday 20 January, 14:00 UTC
APAC: Will resume in the new year
+
APAC: Wednesday 27 January, 00:30 UTC
  
 
Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting
 
Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting
  
 
--
 
--
 
Happy holidays everyone, and remember to ...
 
  
 
Keep on doc'ing!
 
Keep on doc'ing!
  
 
Lana
 
Lana

Revision as of 04:08, 15 January 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

  • Your
  • Content
  • Here

Looking for older editions?

You can see older newsletters here: Documentation/WhatsUpDoc_Archive

15 January 2016

Hi everyone,

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

Progress towards Mitaka

82 days to go!

324 bugs closed so far for this release.

RST Conversions

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

Reorganisations

DocImpact

  • After some discussion on the dev list, we're adjusting our approach to this problem. Stay tuned for more.

Speciality Teams

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

Core Team Changes

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

We will resume regular reviews in February 2016.

Doc team meeting

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

Next meetings: US: Wednesday 20 January, 14:00 UTC APAC: Wednesday 27 January, 00:30 UTC

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

--

Keep on doc'ing!

Lana