Jump to: navigation, search

Documentation/WhatsUpDoc

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

4 March 2016

Hi everyone,

This week I've been working on code reviews and closing some of our oldest bugs from the bug queue. I've also updated the docs-specs core team list to reflect some recent changes to the Speciality Team leads, and doing some general prep work for the Mitaka release. We are now well and truly ready to start testing the Install Guide. If you need help getting started, please contact Matt Kassawara, or any of your friendly core team members :)

Progress towards Mitaka

40 days to go!

445 bugs closed so far for this release. There is a global bug smash event coming up March 7-9 to try and hit as many Mitaka bugs as possible. You can join an in-person group near you, or participate remotely. There are still plenty of docs bugs that can be attended to. Details here: https://etherpad.openstack.org/p/OpenStack-Bug-Smash-Mitaka

Docs Testing

RST Conversions

  • All planned RST conversions are now complete!

Reorganisations

DocImpact

  • Is now complete

The Road to Austin

Speciality Teams

HA Guide - Bogdan Dobrelya No update this week.

Installation Guide - Matt Kassawara Continue updating the guide for Mitaka using primarily RDO milestone 3 packages. Review patch that adds manila to the guide. Review patch that adds magnum to the guide.

Networking Guide - Edgar Magana No update this week.

Security Guide - Nathaniel Dillon No update this week.

User Guides - Joseph Robinson Team successfully moved across dashboard content from the Admin User Guide to the Cloud Admin guide. Team is preparing to move the command line content, and then continue to edit the Cloud Admin guide over the next week.

Ops and Arch Guides - Shilla Saebi The work items for the Architecture Design Guide have been converted to bugs: https://bugs.launchpad.net/openstack-manuals/+bugs?field.tag=arch-guide We need people to confirm the bugs, so we can start working on them. 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. Architecture guide reorganization is underway. We have a drafts repo in openstack-manuals, feel free to ping Shilla or Darren Chan if you are interested in helping out. Considering doing a swarm or work session at the summit in Austin for the Arch guide

API Docs - Anne Gentle Check for API migration bugs: https://bugs.launchpad.net/openstack-api-site/+bugs?field.tag=migration There are five bugs remaining. Look at the infra spec if you're interested in how we'll build docs with Swagger files. https://review.openstack.org/#/c/276484/ I'm investigating using this tool so that we replace flat HTML files built from WADL with flat HTML files built from Swagger. https://github.com/nknapp/bootprint-openapi

Config Ref - Gauvain Pocentek No update this week.

Training labs - Pranav Salunke, Roger Luethi Continued fixes to KVM backend and the library functions. Working on creating a webpage for training-labs. https://review.openstack.org/#/c/281713/ https://review.openstack.org/#/c/281721/ https://review.openstack.org/#/c/281367/ Hosting an additional meeting to get our new member on-board and some general discussion.

Training Guides - Matjaz Pancur No update this week.

Hypervisor Tuning Guide - Joe Topjian No update this week.

UX/UI Docs Guidelines - Linette Williams Reviews continue for proposed panels in Invision. Enhancement in UI content guidelines complete for text and icon formatting recommendations (http://docs.openstack.org/contributor-guide/ui-text-guidelines.html).

Doc team meeting

Next meetings:

The APAC meeting attempted to be held this week, but failed to meet quorum.

Next meetings: US: Wednesday 2 March, 19:00 UTC ***Note the new time!*** APAC: Wednesday 9 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#4_March_2016