Jump to: navigation, search

Documentation/WhatsUpDoc

< Documentation
Revision as of 05:06, 18 November 2016 by Loquacity (talk | contribs) (→‎18 November 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

Content Sources

Speciality team reports are gathered here: https://etherpad.openstack.org/p/Speciality_Team_Reports

  • Your
  • Content
  • Here

Looking for older editions?

You can see older newsletters here: Documentation/WhatsUpDoc_Archive

18 November 2016

Hi everyone,

Welcome to Ocata! It was great to catch up with many of you in Barcelona, and always refreshing to see the energy around our little project and catch that enthusiasm all over again :) Of course, Ocata is a *very* short cycle, so we've deliberately cut down our deliverables list to ensure we can squeeze it all in. We have two main priorities this release: tidying up the new Install Guides index page, and a little bit of navel gazing in terms of social structures and procedures. More on that in this newsletter!

Progress towards Ocata

96 days to go!

Closed 77 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.

Specs on review

  • Ops/Arch Guides:

https://review.openstack.org/#/c/392372/ [arch-design] Revise the Architecture Design Guide https://review.openstack.org/#/c/394261/ [ops-guide] Add project upgrade notes https://review.openstack.org/#/c/391786/ Proposed use case form

  • Training Labs:

https://review.openstack.org/#/c/391548/ training-labs: Rewrite training-labs in python

Speciality Team Reports

We've made some structural changes to how Speciality Teams and our regular docs meeting work. Speciality teams will now meet no more than once monthly (most on an 'as needed' basis), and participants are instead encouraged to attend the main docs meeting to discuss work and report on progress. This is aiming to keep all the information about the work we're doing a little more centralised, and give newcomers a way to find out where they can best help. It also gives us a chance to find out where we can help each other, without going to a dozen meetings!

  • API: Anne Gentle

Karen Bradshaw has been working on updates to the openstackdocstheme that would fix this bug: https://launchpad.net/bugs/1583623. The review is up at https://review.openstack.org/#/c/393890/ and getting input from the affected teams who have recognized the need because of errors building when you have multiple API versions with very similar calls, so you end up with identical headings. Launchpad bug 1583623 in openstack-doc-tools "os-api-ref: duplicate labels for selectors" [Low,In progress] - Assigned to Karen Bradshaw (kbhawkey) I've had a couple of inquiries on IRC about "where did the draft/swagger files go?" but to meet their stated end goals, those particular files wouldn't have worked any way due to inaccuracies in the content and incomplete content. See the 100 api-ref doc patches up for review at: https://review.openstack.org/#/q/status:open+file:api-ref.

  • Configuration Reference and CLI Reference: Tomoyuki Kato

No report this week

  • High Availability Guide: Andrew Beekhof

No report this week

  • Hypervisor Tuning Guide: Joe Topjian

No report this week

  • Installation guides: Lana Brindley

No major updates to the guides themselves, but we are planning updates to the landing page. We're also working on getting our first deployment guide landed there, with OpenStack Ansible. I've requested design resources from foundation, but haven't heard back yet, so if you have ideas/suggestions (or design skillz!) then please let me know.

  • Networking Guide: John Davidge

A couple of new articles are close to merging: https://review.openstack.org/#/c/361776/ - VLAN Trunking and https://review.openstack.org/#/c/356013/ - Routed Provider Networks. Need to decide how best to track the work that's going on for https://blueprints.launchpad.net/openstack-manuals/+spec/use-openstack-command. Probably a google spreadsheet or etherpad with a list of all the network guide pages to be converted, and the person working on it would be best. That way we can hopefully avoid duplicating efforts.

  • Operations and Architecture Design guides: Darren Chan

We're slowly making progress with the arch guide, and have cloudnull onboard to help. So the focus is completing the design chapter and migrating stuff from the ops guide.

  • Security Guide: Nathaniel Dillon

No update this week.

  • Training Guides: Matjaz Pancur

We changed our IRC meeting to every two weeks (on even weeks) on Tuesday at 1300 UTC in #openstack-meeting-3. There will be an article published about BCN Upstream training in OpenStack's Superuser magazine. BCN Upstream training retrospective https://etherpad.openstack.org/p/upstream-training-barcelona-retrospective

  • Training labs: Pranav Salunke, Roger Luethi

We have the python port already under review, the spec is not done yet, but we hope to get them merged soonish and in the right order :)

User guides: Joseph Robinson

  • This the current work on converting the legacy commands to OS commands: https://wiki.openstack.org/wiki/Documentation/ReorganizeUserGuides#Ocata_Tasks. Thanks to csatari and visnyei and allen, there's progress happening. I need to finish adding the files affected to the checklist, and then also start making changes. Apart from that, keeping track of any admin or user guide bugs is also a task.

Doc team meeting

We have re-started the docs team meetings, with a new cadence. Our first meeting was held today, with much success. Thank you to everyone who participated, either directly in IRC, or by making sure you sent me your updates ahead of schedule.

Our next meeting will be on Thursday 1 December 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#18_November_2016

Retrieved from "https://wiki.openstack.org/w/index.php?title=Documentation/WhatsUpDoc&oldid=141607"