Jump to: navigation, search

Difference between revisions of "Documentation/WhatsUpDoc"

(1 December 2016)
Line 19: Line 19:
 
You can see older newsletters here: [[Documentation/WhatsUpDoc_Archive]]
 
You can see older newsletters here: [[Documentation/WhatsUpDoc_Archive]]
  
= 1 December 2016 =
+
= 13 January 2017 =
  
 
Hi everyone,
 
Hi everyone,
  
The end of the year is nearly upon us already, and this will be my last newsletter for 2016, before I disappear for the holidays on the 16th. I've had yet another wonderful year with all you lovely OpenStack people, and I wish all of you and your families a happy and safe holiday, wherever and however you celebrate it. Here in Australia, the temperature is starting to soar, so I'm off on another cruise, followed by a few lazy days by the pool with family and friends. I'll be back in the office early in the new year, and ready to kick Ocata out of the door!
+
Welcome to 2017. I hope you all had a chance to rest up a little before we hurtle straight into another release, as Ocata is now only 40 days away! I'll be in contact with our lovely release managers Brian and Mariia over the next week or so to kick off release management tasks. We will need people to test the Installation Guide again, too, so if you're interested in helping out there, please let me know.
  
As many of you already know, I'm not planning on running for Pike PTL. If you're interested in running for PTL (for Pike or any future release), and would like a crash course in PTLing, please let me know and I can share whatever meagre wisdom I've gleaned before self nominations open in mid-January.
+
As many of you already know, I'm not planning on running for Pike PTL. PTL nominations open in the week of 23 January, and I'll be working with Alex and Kato-san who have both expressed interest in taking on this role. If you're interested in running for PTL (for Pike or any future release), and would like a crash course in PTLing, please let me know and I can share whatever meagre wisdom I've gleaned.
  
 
== Progress towards Ocata ==
 
== Progress towards Ocata ==
  
82 days to go!
+
40 days to go!
  
Closed 106 bugs so far.
+
Closed 149 bugs so far.
  
 
Release tasks are being tracked here: https://wiki.openstack.org/wiki/Documentation/OcataDeliverables
 
Release tasks are being tracked here: https://wiki.openstack.org/wiki/Documentation/OcataDeliverables
Line 40: Line 40:
 
Purchase tickets here: https://pikeptg.eventbrite.com/  
 
Purchase tickets here: https://pikeptg.eventbrite.com/  
  
Docs is a horizontal project, so our sessions will run across the Monday and Tuesday of the event.
+
Docs is a horizontal project, so our sessions will run across the Monday and Tuesday of the event. We will be combining the docs event with i18n, so translators and docs people will all be in the room together.
  
 
The incoming PTL will be responsible for planning and running sessions at the Atlanta PTG.
 
The incoming PTL will be responsible for planning and running sessions at the Atlanta PTG.
 +
 +
Also, a quick note that the CFP and ticket sales for *Boston* in May are now open: https://www.openstack.org/summit/boston-2017/call-for-presentations/
  
 
== Speciality Team Reports ==
 
== Speciality Team Reports ==
  
 
* API: Anne Gentle
 
* API: Anne Gentle
The App Dev Support WG is working on a survey to determine which content areas to invest in for content on http://www.openstack.org/appdev (http://lists.openstack.org/pipermail/user-committee/2016-November/001469.html)
+
Fairy-slipper is being retired. It was a good tool, served its purpose, and can now traipse into the sunset, thanks to AJaeger and stevemar for the help with the patches. Be sure to follow the service catalog naming conventions work going on in the API WG. And there's also a new EC2 API reference: http://developer.openstack.org/api-ref/ec2-api/  
  
 
* Configuration Reference and CLI Reference: Tomoyuki Kato
 
* Configuration Reference and CLI Reference: Tomoyuki Kato
We try to recreating the single page view for the "openstack" command. I'd like to generate the reference from source code automatically. However, python-openstackclient has many plug-ins. It is difficulty, but worth to tackle it. We need your help!
+
Config Reference: Updated a few plug-ins. CLI reference: Updated a few command references and removed unsupported Block Storage API v1 and Image API v1.
  
 
* High Availability Guide: Andrew Beekhof
 
* High Availability Guide: Andrew Beekhof
No formal report, but Alex Settle has been doing a lot of work on this guide recently, cleaning up, and raising bugs for some of the TODO items. We need to consider if the HA guide is an ongoing concern. Ben Silverman is wondering if we can fold the content into the Ops/Arch Guides. This will be raised on the mailing list for more conversation.
+
No report this week
  
 
* Hypervisor Tuning Guide: Joe Topjian
 
* Hypervisor Tuning Guide: Joe Topjian
Line 59: Line 61:
  
 
* Installation guides: Lana Brindley
 
* Installation guides: Lana Brindley
We've heard back from Foundation on design resources, I'm going to reply to  that email today and hopefully start drafting the new design next week. I've also got Piet from the UX team  on board to help. Anyone who wants to be involved with that, please contact me.
+
Testing for Ocata will be opening soon. Also, we need a web dev for the landing page, if you know of anyone, please get me in touch.  
  
 
* Networking Guide: John Davidge
 
* Networking Guide: John Davidge
Line 65: Line 67:
  
 
* Operations and Architecture Design guides: Darren Chan
 
* Operations and Architecture Design guides: Darren Chan
For the Arch guide, patches for networking and compute content were merged, thanks to Ben and Shaun. For the Ops Guide, there is patch up to update the upgrades chapter and include links to the project upgrade notes: https://review.openstack.org/#/c/404528/
+
Ben Silverman has spent some time refining the Compute content in the Arch Guide draft. Thanks Ben! We are also looking for more SMEs to help with the Arch Guide. So if you're interested, contact asettle or me.
  
 
* Security Guide: Nathaniel Dillon
 
* Security Guide: Nathaniel Dillon
Line 71: Line 73:
  
 
* Training Guides: Matjaz Pancur
 
* Training Guides: Matjaz Pancur
BCN Upstream training article in the Superuser magazine: http://superuser.openstack.org/articles/openstack-upstream-training-revamp/ - actively looking for contributors to join the Upstream training, please see http://lists.openstack.org/pipermail/openstack-docs/2016-November/009382.html - cleaned test entries in the Launchpad bug queue and the Sandbox repository (left from the Barcelona Upstream training) - updated Training guides README.rst
+
No update this week.
  
 
* Training labs: Pranav Salunke, Roger Luethi
 
* Training labs: Pranav Salunke, Roger Luethi
Line 77: Line 79:
  
 
* User guides: Joseph Robinson
 
* User guides: Joseph Robinson
The legacy command conversion continues at a good pace. I have some more updates to patch today. The only obstacle I have run into is generating new output to match the OpenStack command client. Otherwise, contributors have been adding to the table, and there's been steady patching completed. Just a reminder to update the table if making a change: https://wiki.openstack.org/wiki/Documentation/ReorganizeUserGuides
+
The command conversions have happened at a good pace, the User Guide appears to be mostly complete, with the condition that the trove and manila teams do not have OpenStack commands yet. I have started checking through the Admin Guide files. I suspect there is more to convert, but it should be ready for Ocata.
  
 
== Doc team meeting ==
 
== Doc team meeting ==
  
Our next meeting will be on Thursday 16 December at 2100 UTC in #openstack-meeting-alt
+
Our next meeting will be on Thursday 27 January at 2100 UTC in #openstack-meeting-alt
  
 
For more meeting details, including minutes and the agenda: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting
 
For more meeting details, including minutes and the agenda: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting
Line 91: Line 93:
 
Lana
 
Lana
  
https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#1_December_2016
+
https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#13_January_2017

Revision as of 23:51, 12 January 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

13 January 2017

Hi everyone,

Welcome to 2017. I hope you all had a chance to rest up a little before we hurtle straight into another release, as Ocata is now only 40 days away! I'll be in contact with our lovely release managers Brian and Mariia over the next week or so to kick off release management tasks. We will need people to test the Installation Guide again, too, so if you're interested in helping out there, please let me know.

As many of you already know, I'm not planning on running for Pike PTL. PTL nominations open in the week of 23 January, and I'll be working with Alex and Kato-san who have both expressed interest in taking on this role. If you're interested in running for PTL (for Pike or any future release), and would like a crash course in PTLing, please let me know and I can share whatever meagre wisdom I've gleaned.

Progress towards Ocata

40 days to go!

Closed 149 bugs so far.

Release tasks are being tracked here: https://wiki.openstack.org/wiki/Documentation/OcataDeliverables

The Road to PTG in Atlanta

Event info is available here: http://www.openstack.org/ptg Purchase tickets here: https://pikeptg.eventbrite.com/

Docs is a horizontal project, so our sessions will run across the Monday and Tuesday of the event. We will be combining the docs event with i18n, so translators and docs people will all be in the room together.

The incoming PTL will be responsible for planning and running sessions at the Atlanta PTG.

Also, a quick note that the CFP and ticket sales for *Boston* in May are now open: https://www.openstack.org/summit/boston-2017/call-for-presentations/

Speciality Team Reports

  • API: Anne Gentle

Fairy-slipper is being retired. It was a good tool, served its purpose, and can now traipse into the sunset, thanks to AJaeger and stevemar for the help with the patches. Be sure to follow the service catalog naming conventions work going on in the API WG. And there's also a new EC2 API reference: http://developer.openstack.org/api-ref/ec2-api/

  • Configuration Reference and CLI Reference: Tomoyuki Kato

Config Reference: Updated a few plug-ins. CLI reference: Updated a few command references and removed unsupported Block Storage API v1 and Image API v1.

  • High Availability Guide: Andrew Beekhof

No report this week

  • Hypervisor Tuning Guide: Joe Topjian

No report this week

  • Installation guides: Lana Brindley

Testing for Ocata will be opening soon. Also, we need a web dev for the landing page, if you know of anyone, please get me in touch.

  • Networking Guide: John Davidge

No update this week.

  • Operations and Architecture Design guides: Darren Chan

Ben Silverman has spent some time refining the Compute content in the Arch Guide draft. Thanks Ben! We are also looking for more SMEs to help with the Arch Guide. So if you're interested, contact asettle or me.

  • Security Guide: Nathaniel Dillon

No update this week.

  • Training Guides: Matjaz Pancur

No update this week.

  • Training labs: Pranav Salunke, Roger Luethi

No update this week.

  • User guides: Joseph Robinson

The command conversions have happened at a good pace, the User Guide appears to be mostly complete, with the condition that the trove and manila teams do not have OpenStack commands yet. I have started checking through the Admin Guide files. I suspect there is more to convert, but it should be ready for Ocata.

Doc team meeting

Our next meeting will be on Thursday 27 January at 2100 UTC in #openstack-meeting-alt

For more meeting details, including minutes and the agenda: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting

--

Keep on doc'ing!

Lana

https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#13_January_2017