Jump to: navigation, search

Documentation/WhatsUpDoc

< Documentation
Revision as of 03:57, 19 February 2016 by Loquacity (talk | contribs) (Speciality Teams)

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
  • Core reviewer responsibilities

Looking for older editions?

You can see older newsletters here: Documentation/WhatsUpDoc_Archive

19 February 2016

Hi everyone,

This week I've been focusing on general housekeeping duties as we prepare to rush headlong into the release. I've cleaned up the blueprints list, and also been burning through the oldest bugs in our queue. I'm very pleased to report that the overall number of bugs has reduced dramatically in the past month or two, and the number of untriaged bugs is holding steady at a much lower rate than previously. I think this probably has a lot to do with the DocImpact changes we made at the beginning of the year, so it's very gratifying to see some solid improvement starting to filter through. In other news, thanks to all those people who helped us with locating pre-release packages for the Install Guide. Please feel free to begin testing! The more people we have testing, the better and more accurate our docs will be, which helps everyone.

Progress towards Mitaka

47 days to go!

417 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

  • ATC passes are going out now, so keep an eye on your inbox for your discount code if you haven't received yours yet.
  • Talk voting is now closed
  • You should be starting to think about booking travel and accommodation soon! If you need a visa to travel to the United States, there's more info here: https://www.openstack.org/summit/austin-2016/austin-and-travel/#visa

Speciality Teams

HA Guide - Bogdan Dobrelya No update this week.

Installation Guide - Matt Kassawara Testing Mitaka milestone 3 using RDO packages and submitting patches for review. Lead of the install guide changed from Christian Berendt to Matt Kassawara.

Networking Guide - Edgar Magana No update this week.

Security Guide - Nathaniel Dillon No update this week.

User Guides - Joseph Robinson The new User Guide team meetings are a success. We now have more contributors, and are disucssing doc editing, new content, and Information Architecture of the User Guides.

Ops and Arch Guides - Shilla Saebi 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. Operations guide RST migration pending - conversations still happening to see which route we'll take. Still deciding if the ops guide should have another revision or edition, see ML e-mails. Call for volunteers email went out to the ops and docs ML from Devon Boatwright. We are looking for help! There is a global OpenStack bug smash scheduled for the Mitaka release in March. Details can be found here: https://etherpad.openstack.org/p/OpenStack-Bug-Smash-Mitaka We're looking for people to specifically help with the Architecture Guide, which is currently going through a reorganization. Here is the link for more details: https://wiki.openstack.org/wiki/Architecture_Design_Guide_work_items If you are interested in helping out, more details can be found about our team and our meetings here: https://wiki.openstack.org/wiki/Documentation/OpsGuide

API Docs - Anne Gentle http://lists.openstack.org/pipermail/openstack-docs/2016-February/008286.html Swagger files now available at http://developer.openstack.org/draft/swagger/

Config Ref - Gauvain Pocentek No update this week.

Training labs - Pranav Salunke, Roger Luethi Fixing various things in training-labs cluster for VirtualBox and KVM backends. Improving workflow, configuration and making the library scripts nicer. Adding training-labs landing page (WIP). Summit related work. Some minor improvements.

Training Guides - Matjaz Pancur No update this week.

Hypervisor Tuning Guide - Joe Topjian No update this week.

UX/UI Docs Guidelines - Linette Williams Enhancement to UI content guidelines underway. Expect a new review shortly that covers icons and text formatting. If interested or have questions, contact Linette or Piet Kruithof.

Doc team meeting

Next meetings:

The APAC meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-02-10

Next meetings: US: Wednesday 17 February, 14:00 UTC APAC: Wednesday 24 February, 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

Note that there is currently discussion about moving the US meeting to 20:00 UTC. A patch is open to change this, with ongoing discussion about finding a meeting room: https://review.openstack.org/#/c/271361/

--

Keep on doc'ing!

Lana

https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#19_February_2016

12 February 2016

Hi everyone,

This week has been all about the Install Guide. We're locating pre-release packages now so we can begin testing in about two weeks' time. Please consider being a tester for this release. Even if you've never done it before, it's a great way to improve your OpenStack knowledge, and the more people we have testing, the better and more accurate our docs will be, which helps everyone. We're also starting to see a little more action in the lead up to the Austin Summit. ATC passes are going out, and the talk sessions are now open for voting: https://www.openstack.org/summit/austin-2016/vote-for-speakers/

Progress towards Mitaka

54 days to go!

389 bugs closed so far for this release.

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 Minor updates to the corosync/pacemaker, rabbitmq clusters setup guides

Installation Guide - Christian Berendt Mitaka Installation guide changes spec: https://review.openstack.org/#/c/274231/ Testing beginning, require packages: https://wiki.openstack.org/wiki/Documentation/MitakaDocTesting

Networking Guide - Edgar Magana Move the IRC meeting agenda to etherpad: https://etherpad.openstack.org/p/docnetworkingteam-agenda. Important Commits: DSCP addition to advanced qos guide: https://review.openstack.org/#/c/273638/ Add networking guide to Contributors Section: https://review.openstack.org/#/c/278330/ Last IRC Meeting Notes: http://eavesdrop.openstack.org/meetings/networking_guide/2016/networking_guide.2016-02-04-16.02.log.html

Security Guide - Nathaniel Dillon Continuing bugfixes and beginning Networking review (thanks to all Neutron contributors!)

User Guides - Joseph Robinson Held First US/EU Meeting, which was 1 and a 1/2 hours before the APAC meeting (Need to reserve the meeting time). Discussed Reorg- High Priority step - moving Dashboard content from the Admin Guide to the Cloud Admin Dashboard Chapter.

Ops and Arch Guides - Shilla Saebi 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. Operations guide RST migration pending - conversations still happening to see which route we'll take. Still deciding if the ops guide should have another revision or edition, see ML emails.

API Docs - Anne Gentle No update this week.

Config Ref - Gauvain Pocentek No update this week.

Training labs - Pranav Salunke, Roger Luethi We reviewed and merged several patches: bug fixes, refactoring and some code to help with debugging.

Training Guides - Matjaz Pancur No update this week.

Hypervisor Tuning Guide - Joe Topjian No update this week.

UX/UI Docs Guidelines - Linette Williams No update this week.

Doc team meeting

Next meetings:

The APAC meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-02-10

Next meetings: US: Wednesday 17 February, 14:00 UTC APAC: Wednesday 24 February, 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

Note that there is currently discussion about moving the US meeting to 20:00 UTC. A patch is open to change this, with ongoing discussion about finding a meeting room: https://review.openstack.org/#/c/271361/

--

Keep on doc'ing!

Lana

https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#12_February_2016

6 February 2016

Hi everyone,

A busy week here in docs, with today marking only two months left until Mitaka goes out. I've been working on the DocImpact script, the core team review, and a whole lot of general chasing things up and tidying around the place. I also note that the Installation Guide team is busy ramping up for Mitaka, so watch this space for your opportunity to jump into testing for that very soon. Next week, I'll be cleaning up the blueprints, and also starting to get in touch with our packaging contacts to get ready for release.

Progress towards Mitaka

60 days to go!

382 bugs closed so far for this release.

RST Conversions

  • All planned RST conversions are now complete!

Reorganisations

DocImpact

  • The implementation plan for the DocImpact script changed after we received feedback from Infra and Nova. Now, *all* projects (including the five 'defcore' projects) default to opening DocImpact bugs in their own bug queues. This change was proposed in https://review.openstack.org/#/c/276065/ and merged yesterday, very quickly! Projects will now be able to determine for themselves how they would like to use the DocImpact script within their own groups, and hopefully the quality of bug reporting to docs will improve dramatically as a result of this. I'd like to thank all the PTLs, cross-project liaisons, project core team members, and especially the Infra and Nova teams for their assistance and patience while we worked through this knotty problem. I'm happy to be able to report that, as of today, this project is now complete.

Speciality Teams

HA Guide - Bogdan Dobrelya No update this week.

Installation Guide - Christian Berendt Mitaka Installation guide changes spec: https://review.openstack.org/#/c/274231/

Networking Guide - Edgar Magana No update this week.

Security Guide - Nathaniel Dillon RST bug fixes and cleaning up of lingering migration issues. Looking for Neutron reviewers to see what is still accurate and what needs to be updated, please ping Nathaniel. Looking to setup PDF creation job.

User Guides - Joseph Robinson An action item from last meeting was addressed this week - working with new User Guide team members to continue reorganisation edits. Plans for an earlier, US+EU meeting, which would roll into an APAC meeting on Wedneday/Thursday fornightly meeting times are in place.

Ops and Arch Guides - Shilla Saebi 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. Operations guide RST migration pending - conversations still happening to see which route we'll take. Still deciding if the ops guide should have another revision or edition, see ML emails.

API Docs - Anne Gentle Continuing to work on builds of Swagger plus RST.

Config Ref - Gauvain Pocentek No update this week.

Training labs - Pranav Salunke, Roger Luethi Liberty support has been merged. The new default for training-labs clusters is the Liberty release.

Training Guides - Matjaz Pancur Removal of redundant Jenkins jobs (gate-training-guides-tox-slides) and tox targets. Upstream training archives (http://docs.openstack.org/upstream-training/upstream-archives.html) are now separated from the main landing page.

Hypervisor Tuning Guide - Joe Topjian No update this week.

UX/UI Docs Guidelines - Linette Williams Collaboration between the UX project and Doc project. The first UI text guidelines are live: http://docs.openstack.org/contributor-guide/ui-text-guidelines.html. Enhancements to guidelines in progress - specifically related to icons and text formatting. Text reviews are ongoing for new UI prototypes, as applicable. If interested in helping with UI panel reviews or with UI text guidelines, feel free to ping Linette or Piet Kruithof.

Doc team meeting

Next meetings:

The US meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-01-20

Next meetings: APAC: Wednesday 10 February, 00:30 UTC US: Wednesday 17 February, 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

Note that there is currently discussion about moving the US meeting to 20:00 UTC. A patch is open to change this, with ongoing discussion about finding a meeting room: https://review.openstack.org/#/c/271361/

--

Keep on doc'ing!

Lana

https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#6_February_2016