Jump to: navigation, search

Difference between revisions of "Documentation/WhatsUpDoc Archive"

Line 1: Line 1:
 +
= 29 January 2016 =
 +
 +
Hi everyone,
 +
 +
We seem to be more or less back into the swing of things here in docs land this week, with our meeting schedule back up and running, and now our very first full-length newsletter for 2016! We only have two and a half months until Mitaka goes out, but we're in great shape so far, with 345 bugs dealt with, and all the planned RST conversions complete. Most of the discussion this week has been around API documentation and Fairy Slipper, Docs Tools and some site theme changes, and a little back and forth on meeting times.
 +
 +
== Progress towards Mitaka ==
 +
 +
75 days to go!
 +
 +
345 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
 +
* Arch Guide
 +
** https://blueprints.launchpad.net/openstack-manuals/+spec/archguide-mitaka-reorg
 +
** Contact the Ops Guide Speciality team: https://wiki.openstack.org/wiki/Documentation/OpsGuide
 +
* User Guides
 +
** https://blueprints.launchpad.net/openstack-manuals/+spec/user-guides-reorganised
 +
** Contact the User Guide Speciality team: https://wiki.openstack.org/wiki/User_Guides
 +
 +
DocImpact
 +
* After some discussion on the dev list, we're adjusting our approach to this problem. Watch this space.
 +
 +
== Speciality Teams ==
 +
 +
'''HA Guide - Bogdan Dobrelya'''
 +
Meeting moved http://lists.openstack.org/pipermail/openstack-docs/2016-January/008209.html. Kenneth finished his Galera patch https://review.openstack.org/#/c/263075/, there were also several patches from different contributors, so things are improving.
 +
 +
'''Installation Guide - Christian Berendt'''
 +
AODH instructions near completion, EU/US meeting moved (Every two weeks (on even weeks) on Tuesday at 1600 UTC), APAC meeting will be dropped the next weeks if if not more participants join.
 +
 +
'''Networking Guide - Edgar Magana'''
 +
No update this week.
 +
 +
'''Security Guide - Nathaniel Dillon'''
 +
No update this week.
 +
 +
'''User Guides - Joseph Robinson'''
 +
One patch combining Images and Instances content merged, and a patch on Shared File Systems is now available for review. User Guide team meetings are set to begin next Thursday, with guidelines for combining admin and cloud admin files a topic for discussion.
 +
 +
'''Ops and Arch Guides - Shilla Saebi'''
 +
No update this week.
 +
 +
'''API Docs - Anne Gentle'''
 +
Anne imported and triaged over 60 GitHub Issues into Launchpad bugs. Anne working on build jobs for making API docs with fairy-slipper: https://review.openstack.org/#/c/269809. Anne emailed over 25 individuals about the plans for API docs and answered follow-up questions. Karen worked on validated Swagger: https://review.openstack.org/#/c/266527/. Need to release fairy-slipper this week or next.
 +
 +
'''Config Ref - Gauvain Pocentek'''
 +
No update this week.
 +
 +
'''Training labs - Roger Luethi'''
 +
Liberty is making good progress, trying to get Liberty patches working. Early beginnings of Fedora support switched to CentOS. Copy-on-write disks for KVM. Bug fixing and refactoring, as usual. Early work on python port. Plan to host training labs on a web page.
 +
 +
'''Training Guides - Matjaz Pancur'''
 +
German translation of the Upstream training (http://docs.openstack.org/de/upstream-training/) - this makes 3 full translations (en, de, ko_kr), ja is at 80%. A patch that enables direct bug reporting on the slides (https://review.openstack.org/#/c/259654/), several other patches.
 +
 +
'''Hyperviser Tuning Guide - Joe Topjian'''
 +
No update this week.
 +
 +
== Core Team Changes ==
 +
 +
The next core team review will occur on 1 February. In the meantime, it's probably a good time to go over what being a core means, and how the review system works. For more detail, see the Contributor Guide: http://docs.openstack.org/contributor-guide/docs-review.html
 +
 +
Docs cores have the ability to +2 docs reviews, and they also have the ability to merge reviews. Reviews are merged by cores only once there's been *two* +2 votes, and at least one +1. There are very few exceptions to this rule, for changes that need to go through very quickly to resolve gate breakages or similar, but this rule holds in just about every situation. Cores are assigned based on merit, usually through the core review process that we do every month. During a core review, the PTL gathers statistics on reviews made, and patches created and merged, and uses that to determine who should be added to (or removed from) the core list. That then goes to a vote of the existing core team before being actioned and announced. Core team members also have the ability to nominate (and vote on) exceptional team members, where the statistics might not reflect the amount of effort they have put in.
 +
 +
If you ever have any questions about becoming a docs core, or about getting your docs patch merged, you can contact the team on the usual docs mailing list, or ping any of us on IRC.
 +
 +
== Doc team meeting ==
 +
 +
The US team meeting was held last week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-01-20
 +
 +
Next meetings:
 +
APAC: Wednesday 27 January, 00:30 UTC
 +
US: Wednesday 3 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 four hours later to 20:00 UTC. If you have a strong opinion on this matter, make sure you weigh in on the mailing list thread: http://lists.openstack.org/pipermail/openstack-docs/2016-January/008206.html
 +
 +
--
 +
 +
Keep on doc'ing!
 +
 +
Lana
 +
 +
= 22 January 2016 =
 +
 +
Hi everyone,
 +
 +
We seem to be more or less back into the swing of things here in docs land this week, with our meeting schedule back up and running, and now our very first full-length newsletter for 2016! We only have two and a half months until Mitaka goes out, but we're in great shape so far, with 345 bugs dealt with, and all the planned RST conversions complete. Most of the discussion this week has been around API documentation and Fairy Slipper, Docs Tools and some site theme changes, and a little back and forth on meeting times.
 +
 +
== Progress towards Mitaka ==
 +
 +
75 days to go!
 +
 +
345 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
 +
* Arch Guide
 +
** https://blueprints.launchpad.net/openstack-manuals/+spec/archguide-mitaka-reorg
 +
** Contact the Ops Guide Speciality team: https://wiki.openstack.org/wiki/Documentation/OpsGuide
 +
* User Guides
 +
** https://blueprints.launchpad.net/openstack-manuals/+spec/user-guides-reorganised
 +
** Contact the User Guide Speciality team: https://wiki.openstack.org/wiki/User_Guides
 +
 +
DocImpact
 +
* After some discussion on the dev list, we're adjusting our approach to this problem. Watch this space.
 +
 +
== Speciality Teams ==
 +
 +
'''HA Guide - Bogdan Dobrelya'''
 +
Meeting moved http://lists.openstack.org/pipermail/openstack-docs/2016-January/008209.html. Kenneth finished his Galera patch https://review.openstack.org/#/c/263075/, there were also several patches from different contributors, so things are improving.
 +
 +
'''Installation Guide - Christian Berendt'''
 +
AODH instructions near completion, EU/US meeting moved (Every two weeks (on even weeks) on Tuesday at 1600 UTC), APAC meeting will be dropped the next weeks if if not more participants join.
 +
 +
'''Networking Guide - Edgar Magana'''
 +
No update this week.
 +
 +
'''Security Guide - Nathaniel Dillon'''
 +
No update this week.
 +
 +
'''User Guides - Joseph Robinson'''
 +
One patch combining Images and Instances content merged, and a patch on Shared File Systems is now available for review. User Guide team meetings are set to begin next Thursday, with guidelines for combining admin and cloud admin files a topic for discussion.
 +
 +
'''Ops and Arch Guides - Shilla Saebi'''
 +
No update this week.
 +
 +
'''API Docs - Anne Gentle'''
 +
Anne imported and triaged over 60 GitHub Issues into Launchpad bugs. Anne working on build jobs for making API docs with fairy-slipper: https://review.openstack.org/#/c/269809. Anne emailed over 25 individuals about the plans for API docs and answered follow-up questions. Karen worked on validated Swagger: https://review.openstack.org/#/c/266527/. Need to release fairy-slipper this week or next.
 +
 +
'''Config Ref - Gauvain Pocentek'''
 +
No update this week.
 +
 +
'''Training labs - Roger Luethi'''
 +
Liberty is making good progress, trying to get Liberty patches working. Early beginnings of Fedora support switched to CentOS. Copy-on-write disks for KVM. Bug fixing and refactoring, as usual. Early work on python port. Plan to host training labs on a web page.
 +
 +
'''Training Guides - Matjaz Pancur'''
 +
German translation of the Upstream training (http://docs.openstack.org/de/upstream-training/) - this makes 3 full translations (en, de, ko_kr), ja is at 80%. A patch that enables direct bug reporting on the slides (https://review.openstack.org/#/c/259654/), several other patches.
 +
 +
'''Hyperviser Tuning Guide - Joe Topjian'''
 +
No update this week.
 +
 +
== Core Team Changes ==
 +
 +
The next core team review will occur on 1 February. In the meantime, it's probably a good time to go over what being a core means, and how the review system works. For more detail, see the Contributor Guide: http://docs.openstack.org/contributor-guide/docs-review.html
 +
 +
Docs cores have the ability to +2 docs reviews, and they also have the ability to merge reviews. Reviews are merged by cores only once there's been *two* +2 votes, and at least one +1. There are very few exceptions to this rule, for changes that need to go through very quickly to resolve gate breakages or similar, but this rule holds in just about every situation. Cores are assigned based on merit, usually through the core review process that we do every month. During a core review, the PTL gathers statistics on reviews made, and patches created and merged, and uses that to determine who should be added to (or removed from) the core list. That then goes to a vote of the existing core team before being actioned and announced. Core team members also have the ability to nominate (and vote on) exceptional team members, where the statistics might not reflect the amount of effort they have put in.
 +
 +
If you ever have any questions about becoming a docs core, or about getting your docs patch merged, you can contact the team on the usual docs mailing list, or ping any of us on IRC.
 +
 +
== Doc team meeting ==
 +
 +
The US team meeting was held last week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-01-20
 +
 +
Next meetings:
 +
APAC: Wednesday 27 January, 00:30 UTC
 +
US: Wednesday 3 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 four hours later to 20:00 UTC. If you have a strong opinion on this matter, make sure you weigh in on the mailing list thread: http://lists.openstack.org/pipermail/openstack-docs/2016-January/008206.html
 +
 +
--
 +
 +
Keep on doc'ing!
 +
 +
Lana
 +
 +
= 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
 +
* Arch Guide
 +
** https://blueprints.launchpad.net/openstack-manuals/+spec/archguide-mitaka-reorg
 +
** Contact the Ops Guide Speciality team: https://wiki.openstack.org/wiki/Documentation/OpsGuide
 +
* User Guides
 +
** https://blueprints.launchpad.net/openstack-manuals/+spec/user-guides-reorganised
 +
** Contact the User Guide Speciality team: https://wiki.openstack.org/wiki/User_Guides
 +
 +
DocImpact
 +
* After some discussion on the dev list, we're adjusting our approach to this problem. Watch this space.
 +
 +
== 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
 +
 
= 11 December 2015 =
 
= 11 December 2015 =
  

Revision as of 03:44, 6 February 2016

Contents

29 January 2016

Hi everyone,

We seem to be more or less back into the swing of things here in docs land this week, with our meeting schedule back up and running, and now our very first full-length newsletter for 2016! We only have two and a half months until Mitaka goes out, but we're in great shape so far, with 345 bugs dealt with, and all the planned RST conversions complete. Most of the discussion this week has been around API documentation and Fairy Slipper, Docs Tools and some site theme changes, and a little back and forth on meeting times.

Progress towards Mitaka

75 days to go!

345 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. Watch this space.

Speciality Teams

HA Guide - Bogdan Dobrelya Meeting moved http://lists.openstack.org/pipermail/openstack-docs/2016-January/008209.html. Kenneth finished his Galera patch https://review.openstack.org/#/c/263075/, there were also several patches from different contributors, so things are improving.

Installation Guide - Christian Berendt AODH instructions near completion, EU/US meeting moved (Every two weeks (on even weeks) on Tuesday at 1600 UTC), APAC meeting will be dropped the next weeks if if not more participants join.

Networking Guide - Edgar Magana No update this week.

Security Guide - Nathaniel Dillon No update this week.

User Guides - Joseph Robinson One patch combining Images and Instances content merged, and a patch on Shared File Systems is now available for review. User Guide team meetings are set to begin next Thursday, with guidelines for combining admin and cloud admin files a topic for discussion.

Ops and Arch Guides - Shilla Saebi No update this week.

API Docs - Anne Gentle Anne imported and triaged over 60 GitHub Issues into Launchpad bugs. Anne working on build jobs for making API docs with fairy-slipper: https://review.openstack.org/#/c/269809. Anne emailed over 25 individuals about the plans for API docs and answered follow-up questions. Karen worked on validated Swagger: https://review.openstack.org/#/c/266527/. Need to release fairy-slipper this week or next.

Config Ref - Gauvain Pocentek No update this week.

Training labs - Roger Luethi Liberty is making good progress, trying to get Liberty patches working. Early beginnings of Fedora support switched to CentOS. Copy-on-write disks for KVM. Bug fixing and refactoring, as usual. Early work on python port. Plan to host training labs on a web page.

Training Guides - Matjaz Pancur German translation of the Upstream training (http://docs.openstack.org/de/upstream-training/) - this makes 3 full translations (en, de, ko_kr), ja is at 80%. A patch that enables direct bug reporting on the slides (https://review.openstack.org/#/c/259654/), several other patches.

Hyperviser Tuning Guide - Joe Topjian No update this week.

Core Team Changes

The next core team review will occur on 1 February. In the meantime, it's probably a good time to go over what being a core means, and how the review system works. For more detail, see the Contributor Guide: http://docs.openstack.org/contributor-guide/docs-review.html

Docs cores have the ability to +2 docs reviews, and they also have the ability to merge reviews. Reviews are merged by cores only once there's been *two* +2 votes, and at least one +1. There are very few exceptions to this rule, for changes that need to go through very quickly to resolve gate breakages or similar, but this rule holds in just about every situation. Cores are assigned based on merit, usually through the core review process that we do every month. During a core review, the PTL gathers statistics on reviews made, and patches created and merged, and uses that to determine who should be added to (or removed from) the core list. That then goes to a vote of the existing core team before being actioned and announced. Core team members also have the ability to nominate (and vote on) exceptional team members, where the statistics might not reflect the amount of effort they have put in.

If you ever have any questions about becoming a docs core, or about getting your docs patch merged, you can contact the team on the usual docs mailing list, or ping any of us on IRC.

Doc team meeting

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

Next meetings: APAC: Wednesday 27 January, 00:30 UTC US: Wednesday 3 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 four hours later to 20:00 UTC. If you have a strong opinion on this matter, make sure you weigh in on the mailing list thread: http://lists.openstack.org/pipermail/openstack-docs/2016-January/008206.html

--

Keep on doc'ing!

Lana

22 January 2016

Hi everyone,

We seem to be more or less back into the swing of things here in docs land this week, with our meeting schedule back up and running, and now our very first full-length newsletter for 2016! We only have two and a half months until Mitaka goes out, but we're in great shape so far, with 345 bugs dealt with, and all the planned RST conversions complete. Most of the discussion this week has been around API documentation and Fairy Slipper, Docs Tools and some site theme changes, and a little back and forth on meeting times.

Progress towards Mitaka

75 days to go!

345 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. Watch this space.

Speciality Teams

HA Guide - Bogdan Dobrelya Meeting moved http://lists.openstack.org/pipermail/openstack-docs/2016-January/008209.html. Kenneth finished his Galera patch https://review.openstack.org/#/c/263075/, there were also several patches from different contributors, so things are improving.

Installation Guide - Christian Berendt AODH instructions near completion, EU/US meeting moved (Every two weeks (on even weeks) on Tuesday at 1600 UTC), APAC meeting will be dropped the next weeks if if not more participants join.

Networking Guide - Edgar Magana No update this week.

Security Guide - Nathaniel Dillon No update this week.

User Guides - Joseph Robinson One patch combining Images and Instances content merged, and a patch on Shared File Systems is now available for review. User Guide team meetings are set to begin next Thursday, with guidelines for combining admin and cloud admin files a topic for discussion.

Ops and Arch Guides - Shilla Saebi No update this week.

API Docs - Anne Gentle Anne imported and triaged over 60 GitHub Issues into Launchpad bugs. Anne working on build jobs for making API docs with fairy-slipper: https://review.openstack.org/#/c/269809. Anne emailed over 25 individuals about the plans for API docs and answered follow-up questions. Karen worked on validated Swagger: https://review.openstack.org/#/c/266527/. Need to release fairy-slipper this week or next.

Config Ref - Gauvain Pocentek No update this week.

Training labs - Roger Luethi Liberty is making good progress, trying to get Liberty patches working. Early beginnings of Fedora support switched to CentOS. Copy-on-write disks for KVM. Bug fixing and refactoring, as usual. Early work on python port. Plan to host training labs on a web page.

Training Guides - Matjaz Pancur German translation of the Upstream training (http://docs.openstack.org/de/upstream-training/) - this makes 3 full translations (en, de, ko_kr), ja is at 80%. A patch that enables direct bug reporting on the slides (https://review.openstack.org/#/c/259654/), several other patches.

Hyperviser Tuning Guide - Joe Topjian No update this week.

Core Team Changes

The next core team review will occur on 1 February. In the meantime, it's probably a good time to go over what being a core means, and how the review system works. For more detail, see the Contributor Guide: http://docs.openstack.org/contributor-guide/docs-review.html

Docs cores have the ability to +2 docs reviews, and they also have the ability to merge reviews. Reviews are merged by cores only once there's been *two* +2 votes, and at least one +1. There are very few exceptions to this rule, for changes that need to go through very quickly to resolve gate breakages or similar, but this rule holds in just about every situation. Cores are assigned based on merit, usually through the core review process that we do every month. During a core review, the PTL gathers statistics on reviews made, and patches created and merged, and uses that to determine who should be added to (or removed from) the core list. That then goes to a vote of the existing core team before being actioned and announced. Core team members also have the ability to nominate (and vote on) exceptional team members, where the statistics might not reflect the amount of effort they have put in.

If you ever have any questions about becoming a docs core, or about getting your docs patch merged, you can contact the team on the usual docs mailing list, or ping any of us on IRC.

Doc team meeting

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

Next meetings: APAC: Wednesday 27 January, 00:30 UTC US: Wednesday 3 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 four hours later to 20:00 UTC. If you have a strong opinion on this matter, make sure you weigh in on the mailing list thread: http://lists.openstack.org/pipermail/openstack-docs/2016-January/008206.html

--

Keep on doc'ing!

Lana

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. Watch this space.

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

11 December 2015

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.

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

117 days to go!

150 bugs closed so far for this release.

RST Conversions

  • Arch Guide
    • RST conversion is complete! Well done Shilla and team for getting this done so incredibly quickly :)
  • Config Ref
  • Virtual Machine Image Guide
    • Is complete! Well done Tomoyuki-san :)

Reorganisations

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.

Document openstack-doc-tools and reorganise index page

  • Thanks to Brian and Christian for volunteering to take this on!

Horizon UX work

Speciality Teams

HA Guide - Bogdan Dobrelya 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

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

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!

Next meetings: US: Wednesday 16 December, 14:00 UTC APAC: Will resume in the new year

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!

Lana

4 December 2015

Hi everyone,

Slight delay in the newsletter this time around, it's been a busy week! I've been working on the DocImpact changes, reviewing the docs and docs-specs core teams, and catching up with blueprint management and reviews from while I was on leave.

Since we're getting to the pointy end of the year, remember to call out successes 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

121 days to go!

139 bugs closed so far for this release.

RST Conversions

Reorganisations

DocImpact

  • This is now well underway, with the first two patches merged. One changes the default bug queue for DocImpact back to the projects' own queue, and the other changes all current projects (with the exception of the six defcore projects) to their own bug queue. There has also been some discussion on the mailing lists about this process change. The next step is to merge 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. Thank you to Andreas, Josh Hesketh, and everyone else who has helped get us this far, and to the Nova team who are allowing us to use them as guinea pigs.

Document openstack-doc-tools and reorganise index page

  • Thanks to Brian and Christian for volunteering to take this on!

Horizon UX work

Speciality Teams

HA Guide - Bogdan Dobrelya Finished IRC meeting schedule poll, finalised the Corosync/pacemaker patch (https://review.openstack.org/235893), participating and tracking progress with the HA for OpenStack instances research (https://etherpad.openstack.org/p/automatic-evacuation) to make it into the HA guide, eventually.

Installation Guide - Christian Berendt Debian install guide nearly completed, testers needed; meeting time for the EU/US meeting will probably change from 13 UTC to 17 UTC; Aodh install instructions nearly finished, ongoing discussion because of missing SUSE packages; Japanese translation of the Liberty install guide published.

Networking Guide - Edgar Magana We are having our first official IRC meeting tomorrow at 1600 UTC. The goal is to find out what we can to complete during the Liberty cycle and have specific tasks assigned. Relevant patches: Create tags for the Networking Guide - WIP (https://review.openstack.org/#/c/251979/)

Security Guide - Nathaniel Dillon No update this week

User Guides - Joseph Robinson The User guide meeting on IRC worked, however attendance was down; the reorganization spec is updated with information from Big Tent Project navigator to define the scope (http://www.openstack.org/software/project-navigator) and information from the published nova-network to neutron migration study.

Ops and Arch Guides - Darren Chan The arch guide RST conversion is completed. We plan on doing a virtual swarm this December. The doodle link was sent out last week and the poll is now closed. The final date for the virtual swarm is: 12/21-12/22.

API Docs - Anne Gentle Working on usage docs for migration, how to build, what gets migrated, how the docs are assembled: https://github.com/russell/fairy-slipper/blob/master/doc/source/usage.rst Responding to spec reviews: https://review.openstack.org/#/c/246660/ Revising patch to bring fairy-slipper into openstack org: https://review.openstack.org/#/c/245352/

Config Ref - Gauvain Pocentek The RST migration is still in progress. The Manila section has been greatly improved in the process, and the Zaqar documentation should land during this cycle as the spec has been approved.

Training labs - Pranav Salunke KVM port is almost done. Planned to merge this by end of this week; Network configuration for the cluster is updated. Now it uses same network addresses as install guides; Welcome berndbausch into our team; Liberty port is in progress. Follow https://etherpad.openstack.org/p/training-labs-liberty for more details; Need to decide meeting time for weekly IRC meetings.

Training Guides - Matjaz Pancur No update this week

Hyperviser Tuning Guide - Joe Topjian Still on schedule. Halfway done with a first-pass cleanup. Should be ready for open contributions within 2 weeks.

Core Team Changes

During last week, I announced some changes to the docs-specs core team. Previously, this core team was a small subset of docs core team members, with an understanding that we would wait for speciality team leads to +1 a spec relevant to their team before approving. Now we have formalised that process by inviting each speciality team lead to the docs-specs core team, so that they can +2A their own specs. Speciality team leads are listed on the wiki here: https://wiki.openstack.org/wiki/Documentation/SpecialityTeams remember to engage them when you create a new spec for approval.

We have also reviewed the current docs core team list for December, and the results of that will be announced shortly. We will not be reviewing the team in January because of the holiday period, and will resume regular reviews in February 2016.

Doc team meeting

We held the APAC docs meeting this week. Big thanks to Joseph for running that while I was away, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-11-25

Next meetings: APAC: Wednesday 9 December, 00:30:00 UTC (CANCELLED) US: Wednesday 16 December, 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

--

Just a note that this will be my penultimate newsletter for 2015.

Keep on doc'ing! Lana


20 November 2015

Hi everyone,

This week I've been working on catching up with some reviews and bug triage, I've been speaking to O'Reilly about the future of the Ops Guide, and also been working on a range of other things including docs-specs core team review, and the addition of Zaqar docs into the user guides.

Just a quick heads up that there won't be a docs newsletter next week, though, as I'm taking a couple of days off (my Mum is coming to visit!), so I'll see you again around 4 December. For those of you in the United States, I hope you all have a lovely Thanksgiving :)

Progress towards Mitaka

138 days to go!

119 bugs closed so far for this release.

RST Conversions

Reorganisations

DocImpact

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.

Speciality Teams

HA Guide - Bogdan Dobrelya Two patches look ready for merge now: https://review.openstack.org/#/c/225418/ and https://review.openstack.org/235893

Installation Guide - Christian Berendt Business as usual. Nothing special to mention this week.

Networking Guide - Edgar Magana Open Reviews: https://review.openstack.org/#/c/239361/ Merged: https://review.openstack.org/#/c/246671/ Very slow progress, hoping to speed up after the USA holidays.

Security Guide - Nathaniel Dillon No update this week

User Guides - Joseph Robinson After a specification update, there is a need to provide a more comprehensive scope: a list of Core features within scope, and include research on the nova-network/ neutron migration study. Contact from Zaqar, Trove, and Murano Liaisons on Admin guide tasks has been helpful, and given the reorganisation direction. A patch on fernet tokens (FAQ format) merged into the Cloud Admin Guide this week.

Ops and Arch Guides - Darren Chan Arch guide migration is close to completion. We are currently planning to reorganize the guide over a two day virtual sprint in mid December.

API Docs - Anne Gentle Review ready for the Mitaka specification of a vision for app dev docs: https://review.openstack.org/#/c/246660/

Config Ref - Gauvain Pocentek The tools are ready, the liberty branch is set up, the RST migration is on! Pick your file, run the tools, and let's review.

Training labs - Pranav Salunke Training-labs has Kilo patch merged! We are currently updating the network configuration and trying to get things as per Matt's feedback/request. We plan to start adding Liberty very soon and also KVM port is on the way.

Training Guides - Matjaz Pancur There is interest in translating Upstream training; we are waiting for https://review.openstack.org/#/c/245615/ to merge to enable it on the repo.

Hyperviser Tuning Guide - Joe Topjian On schedule - working on changing bullet-point notes into rough draft sections.

Doc team meeting

We held the US docs meeting this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-11-18

Next meetings: APAC: Wednesday 25 November, 00:30:00 UTC US: Wednesday 2 December, 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

--

Keep on doc'ing! Lana

13 November 2015

Hi everyone,

Well, things are starting to ramp up again after Summit.

This week, I've spent some time catching up with other PTLs, and also worked on the DocImpact spec. I've also implemented my plan to get the Speciality Team leads to provide content on their projects individually, so many thanks to them for replying with so much great info!

Progress towards Mitaka

145 days to go!

100 bugs closed so far for this release.

DocImpact

RST Conversions

Reorganisations

Document openstack-doc-tools and reorganise index page

  • Thanks to Brian and Christian for volunteering to take these on!

Horizon UX work

  • There's an interesting opportunity to improve the wording in Horizon, specifically around LBaaS, and also to develop a set of standards around the language used in the dashboard. If you're interested, let me know and I'll get you in contact with the right people.

Speciality Teams

HA Guide - Bogdan Dobrelya Created a poll to shift HA guide IRC meeting time (http://lists.openstack.org/pipermail/openstack-docs/2015-November/007830.html). Submitted a status for HA guide testing (http://lists.openstack.org/pipermail/openstack-docs/2015-October/007718.html), hoping to see more participants in testing. Trying to push few patches, and initiated related discussion: https://review.openstack.org/#/c/225418/ and https://review.openstack.org/235893. Thinking on how to effectively collaborate with Adam Spiers and his Openstack HA initiative (http://lists.openstack.org/pipermail/openstack-dev/2015-November/079127.html) to benefit HA guide project as well.

Installation Guide - Christian Berendt Moved the team meeting from Google Hangout to IRC (online at http://eavesdrop.openstack.org/#Documentation_Install_Team_Meeting), we had our first team meeting on the IRC (http://eavesdrop.openstack.org/meetings/docinstallteam/2015/docinstallteam.2015-11-11-01.03.html), we discussed the inclusion of hypervisor specific appendixes, no consensus at the moment, really good progress on the Debian install guide, zigo is doing a good job.

Networking Guide - Edgar Magana We have a new spec for OVN: https://review.openstack.org/#/c/244367/ I am going to start pulling people into specific patches.

Security Guide - Nathaniel Dillon We have added a new chapter on Manila and have completed the reworking of the case studies.

User Guides - Joseph Robinson Our meeting format has changed from hangouts to IRC meetings, with the appropriate changes made to the meetbot script thanks to Brian. The mitaka specification: the priority at the moment is checking in with project docs liaisons to confirm what services are in scope, and then add a short statement to the specification outlining this scope. Responding to Cloud Admin Guide patches. Thanks to Andreas for the link.

Ops and Arch Guides - Shilla Saebi The operations guide RST migration is on hold until we find out if we are going to move forward with docbook or RST. In the meantime we are looking to add content and update it. The architecture guide RST conversion is underway. The progress on chapters and pages can be checked via the wiki page: https://wiki.openstack.org/wiki/Documentation/Migrate

API Docs - Anne Gentle Russell Sim plans to revise the templates for developer.openstack.org landing page to better match docs.openstack.org. We'll also map out a plan for fairy-slipper and the WADL migration. Spec to be updated soon.

Config Ref - Gauvain Pocentek The initial structure for the Config Reference RST migration is up, the automation tools are ready to handle RST tables generation, and a couple pages have already been converted. We're waiting for the liberty branching to start pushing more converted pages.

Training labs - Pranav Salunke Added Kilo support, still under review but in final stages (https://review.openstack.org/#/c/237061/). Halfway through adding KVM support, will probably need more time. Other small things like fixing readmes etc. Still pending to decide IRC meeting time.

Training Guides - Matjaz Pancur Two new core reviewers: Kato Tomoyuki and Tim Freund. We also added a new policy for cores: current lead of Upstream training session (held before each Summit) is now part of the core team by function.

Hyperviser Tuning Guide - Joe Topjian All data from the past etherpads have been compiled onto the wiki (https://wiki.openstack.org/wiki/Documentation/HypervisorTuningGuide). My goal right now is to translate the raw notes into something more readable. Once the page starts to resemble a readable guide, I'll try to rally others to join in.

Doc team meeting

We held the APAC docs meeting this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-11-11

Next meetings: US: Wednesday 18 November, 14:00 UTC APAC: Wednesday 25 November, 00:30: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

--

Keep on doc'ing! Lana

6 November 2015

Hi everyone,

Wow! What a great Summit! And isn't Tokyo a truly beautiful and amazing city? Thank you so much to the Japanese Stackers who hosted us, and to everyone who came along to the docs sessions and helped us hammer out a great plan for Mitaka. I'm very excited about this release!

This week, I've been catching up with everything that happened during Summit, and also working on outreach tasks. Today, I recorded an interview with Foundation about the project, and I've also published a blog post on the same topic, which will be published soon. You might also like to check out the SuperUser interview Anne and I did about the docs while we were in Tokyo: http://superuser.openstack.org/articles/openstack-documentation-why-it-s-important-and-how-you-can-contribute

Progress towards Mitaka

152 days to go!

77 bugs closed so far for this release.

API Docs

DocImpact

RST Conversions

Reorganisations

Training

Document openstack-doc-tools

  • Need volunteers for this!

Reorganise index page

  • The API docs have already moved off the front page
  • We need volunteers to look at the organisation of this page and to write one-sentence summaries of each book

Doc team meeting

Meetings will kick off again next week with the APAC meeting:

APAC: Wednesday 11 November, 00:30:00 UTC US: Wednesday 18 November, 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

--

Keep on doc'ing! Lana

三鷹 Summit Edition

Hi everyone,

Welcome to the Summit edition of the docs newsletter! Docs have had a wonderfully productive week here in Tokyo, and we've now established a plan for Mitaka. This newsletter covers the more important announcements, and the main points we want to hit in the next release.

Karin has kindly written up the summary of the Design Summit sessions here: https://etherpad.openstack.org/p/Mitaka-Docs-Meetup

Mitaka Goals

This is the list at the moment. There are more notes in the docs etherpads, and not everything has blueprints yet.

Speciality Team Changes

More detail on the Speciality Team wiki page: https://wiki.openstack.org/wiki/Documentation/SpecialityTeams

  • Install Guide is now with Christian Berendt
  • HA Guide is now with Bogdan Dobrelya
  • Networking Guide is now with Edgar Magana
  • New Hypervisor Tuning Guide team with Joe Topjian

Keep on doc'ing! Lana

9 October 2015

Hi everyone,

We're hurtling head first to Liberty, with only about a week left to go. I've been working on Summit preparations, and making sure we're ready to go when the time hits. This week, I'm working on Release Notes, keeping an eye on the final Install Guide testing, and some other housekeeping tasks.

This is my last docs newsletter before the Liberty release, although I'll endeavour to get a special Summit edition out as well. We will pick up regular meetings (and other tasks, like core team reviews) after the Summit.

Progress towards Liberty

5 days to go!

601 bugs closed so far for this release.

The main things that still need to be done before release: Testing, testing, testing: https://wiki.openstack.org/wiki/Documentation/LibertyDocTesting Reviews: https://review.openstack.org/#/q/status:open+project:openstack/openstack-manuals,n,z and https://review.openstack.org/#/q/status:open+project:openstack/api-site,n,z Bug triage: https://bugs.launchpad.net/openstack-manuals/+bugs?search=Search&field.status=New

Release Notes

Can all PTLs and Cross-Project Liaisons please check the Release Notes page, and ensure they've included all the new features for their project here: https://wiki.openstack.org/wiki/ReleaseNotes/Liberty

The best way to do this (I'm told) is to go through the blueprints created for Liberty. I will be editing these during the next few days, so please ensure you're up to date ASAP. Please contact me directly if you have any questions or problems.

Mitaka Summit Prep

Thank you to everyone who provided suggestions for Design Summit sessions. I've now mangled them into a draft schedule, which is available on Sched: http://mitakadesignsummit.sched.org/type/Documentation

Doc team meeting

The US meeting was held this week. The minutes are here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-10-07

The next meetings will be the final meetings before the Liberty release: APAC: Wednesday 14 October, 00:30: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

--

東京でお会いしましょう (See you in Tokyo!)

Lana

2 October 2015

Hi everyone,

Welcome to October, which means: it's nearly release day! I've been brushing up on the release management tasks, and continued my housekeeping duties to make sure we're in shape. The next two weeks will be spent watching the Installation Guide pretty closely, and making sure we get it all tested and ready to ship. If you are looking for something to do this week, please treat Install Guide testing as your main priority from here until 15 October. Also, don't forget to vote in the TC election next week!

Progress towards Liberty

12 days to go

534 bugs closed so far for this release.

The main things that still need to be done as we hurtle towards release: Testing, testing, testing: https://wiki.openstack.org/wiki/Documentation/LibertyDocTesting Reviews: https://review.openstack.org/#/q/status:open+project:openstack/openstack-manuals,n,z and https://review.openstack.org/#/q/status:open+project:openstack/api-site,n,z Bug triage: https://bugs.launchpad.net/openstack-manuals/+bugs?search=Search&field.status=New

Mitaka Summit Prep

Thank you to everyone who provided suggestions for Design Summit sessions. I've now mangled them into a draft schedule, which looks a little like this:

Fishbowls (Thursday PM): - The docs process, plus best practices - Mitaka planning - deliverables for the next release

Workrooms (Thursday AM): - Docs toolchain/infra info session - IA working session - Ops/Arch Guides & User Guides - Doc Contributor Guide: new content addition - API Docs Session

Meetup (Friday AM): - Contributors meetup. No agenda. We can assist with setting up devstack/working through the Install Guide during this session

Once I have access to Cheddar and Sched, I'll get this allocated more accurately. In the meantime, feedback or questions are welcome.

Bug Triage Process

The core team have been noticing a lot of people trying to close bugs that haven't been triaged recently. It is very important that you have someone else confirm your bug before you go ahead and create a patch. Waiting just a little while for triage can save you (and our core team!) a lot of work, and makes sure we don't let wayward changes past the gate. If you're unsure about whether you need to wait or not, or if you're in a hurry to work on a bug, you can always ping one of the core team on IRC or on our mailing list. The core team members are listed here, and we're always happy to help you out with a bug or a patch: https://launchpad.net/~openstack-doc-core

This is even more important than usual as we get closer to the Liberty release, so remember: If it's not triaged, don't fix it!

Doc team meeting

The APAC meeting was held this week. The minutes are here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-09-30

The next meetings will be the final meetings before the Liberty release: US: Wednesday 7 October, 14:00:00 UTC APAC: Wednesday 14 October, 00:30: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

--

Remember, if you have content you would like to add to this newsletter, or you would like to be added to the distribution list, please email me directly at openstack@lanabrindley.com, or visit: https://wiki.openstack.org/w/index.php?title=Documentation/WhatsUpDoc

Keep on doc'ing!

Lana

25 September 2015

Hi everyone,

First of all, thank you to everyone who has suggested sessions for docs at Tokyo. I'll keep the etherpad open for another week or so, just to give everyone a chance, and will start working on a draft schedule next week. I have spent most of this week on bug triage, which is repetitive work, but it's gratifying to see the numbers drop a little!

Progress towards Liberty

19 days to go

534 bugs closed so far for this release.

The main areas of focus we had during Liberty were the RST migration, paying down some of our technical debt, and improving our general communication issues. The RST conversion is well and truly complete, with just a couple of books waiting in the wings to be published. We have made some progress on improving our communication generally, with liaisons now more visible and involved, and some improved processes. Regarding old bugs, during Liberty we spotlighted a total of 24 bugs, exactly half of which have now been closed.

Mitaka Summit Prep

The schedule app for your phone is now available. This is a great tool once you're on the ground at Summit: https://itunes.apple.com/WebObjects/MZStore.woa/wa/viewSoftware?id=987216292&mt=8 (Apple) and https://play.google.com/store/apps/details?id=org.sched.openstacksummitmay2015vancouver (Android)

Docs have been allocated two fishbowls, four workrooms, and a half day meetup, so now is the time to start gathering ideas for what you would like to see us cover. Add your ideas to the etherpad here: https://etherpad.openstack.org/p/Tokyo-DocsSessions I'll create a draft session based on this feedback next week.

Bug Triage Process

The core team have been noticing a lot of people trying to close bugs that haven't been triaged recently. It is very important that you have someone else confirm your bug before you go ahead and create a patch. Waiting just a little while for triage can save you (and our core team!) a lot of work, and makes sure we don't let wayward changes past the gate. If you're unsure about whether you need to wait or not, or if you're in a hurry to work on a bug, you can always ping one of the core team on IRC or on our mailing list. The core team members are listed here, and we're always happy to help you out with a bug or a patch: https://launchpad.net/~openstack-doc-core

This is even more important than usual as we get closer to the Liberty release, so remember: If it's not triaged, don't fix it!

Spotlight Bugs

During Liberty we spotlighted a total of 24 bugs, exactly half of which have now been closed. This is a great effort to clear out some old dusty bugs and pay down some technical debt. Thanks go out to Tom Fifield, Olga Gusarenko, Yusuke Ide, Brian Moss, Deena Cooper, and Alexandra Settle for taking them on! With Liberty and the Summit bearing down on us, though, let's focus back on what needs to be done for release. At Summit, we'll discuss how to expand and improve on this effort in future releases.

Doc team meeting

The US meeting was held this week. The minutes are here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-09-23

The next meetings will be the final meetings before the Liberty release: APAC: Wednesday 30 September, 00:30:00 UTC US: Wednesday 7 October, 14:00: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

--

Remember, if you have content you would like to add to this newsletter, or you would like to be added to the distribution list, please email me directly at openstack@lanabrindley.com, or visit: https://wiki.openstack.org/w/index.php?title=Documentation/WhatsUpDoc

Keep on doc'ing!

Lana

18 September 2015

Hi everyone,

First of all, with PTL candidacy now closed, it appears that I will be continuing to hold the docs reins through to Mitaka. Thank you to all of you who contacted me personally over the last week or so, expressing their support. I'm very honoured to be leading such a great team, and I'm looking forward to continuing to serve you. As always, my door will continue to be open to ideas, comments, and criticism, so please keep telling me what you do and don't like!

We're less than a month away from the Liberty release now, and with the Mitaka PTL question settled, I'll be working on Design Summit session planning over the next few weeks. I've created an etherpad to gather your ideas, more on that in this newsletter. In other news, testing is now well underway on the Install Guide, I've knocked our existing blueprints into order, been doing some thinking about the DocImpact script, and worked with the speciality teams on determining the final work items for Liberty.

Progress towards Liberty

26 days to go

514 bugs closed so far for this release.

  • RST conversion:
    • Done.
  • User Guides information architecture overhaul
    • Underway. Some tasks to be held over to Mitaka.
  • Greater focus on helping out devs with docs in their repo
    • A certain amount of progress has been made here, and some wrinkles sorted out which will improve this process for the future.
  • Improve how we communicate with and support our corporate contributors
    • I'm still trying to come up with great ideas for this, please let me know what you think.
  • Improve communication with Docs Liaisons
    • I'm very pleased to see liaisons getting more involved in our bugs and reviews. Keep up the good work!
  • Clearing out old bugs
    • Great work this week, with two bugs from the last two weeks closed (thanks Deena and Tom!). Three new bugs this week.

Mitaka Summit Prep

The schedule app for your phone is now available. This is a great tool once you're on the ground at Summit: https://itunes.apple.com/WebObjects/MZStore.woa/wa/viewSoftware?id=987216292&mt=8 (Apple) and https://play.google.com/store/apps/details?id=org.sched.openstacksummitmay2015vancouver (Android)

Docs have been allocated two fishbowls, four workrooms, and a half day meetup, so now is the time to start gathering ideas for what you would like to see us cover. Add your ideas to the etherpad here: https://etherpad.openstack.org/p/Tokyo-DocsSessions

Outstanding Specs

  • Third Party Driver Content: This spec has been outstanding for a while, and we've finally reached a consensus on how to move forward. Please take a moment to review the spec here before we go ahead merge it: https://review.openstack.org/#/c/191041/

Doc team meeting

The APAC meeting was held this week. The minutes are here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-09-16

The next meetings are: US: Wednesday 23 September, 14:00:00 UTC APAC: Wednesday 30 September, 00:30: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

Spotlight bugs for this week

Let's show these three that we're never going to give them up, never going to let them down:

https://bugs.launchpad.net/openstack-manuals/+bug/1293328 Review Identity & LDAP integration

https://bugs.launchpad.net/openstack-manuals/+bug/1294726 Update Cloud Administration Guide for OpenDaylight ML2 MechanismDriver

https://bugs.launchpad.net/openstack-manuals/+bug/1300960 Making DB sanity checking be optional for DB migration

--

Remember, if you have content you would like to add to this newsletter, or you would like to be added to the distribution list, please email me directly at openstack@lanabrindley.com, or visit: https://wiki.openstack.org/w/index.php?title=Documentation/WhatsUpDoc

Keep on doc'ing!

Lana

11 September 2015

Hi everyone,

Things are really starting to heat up now! Summit preparations are well underway, PTL elections just opened, and testing is proceeding apace on the Install Guide. As well as preparing my candidacy for Mitaka Docs PTL, I've been continuing to sort out the outstanding blueprints, and also planning for some announcements in Tokyo. One of the interesting things I learned while compiling a list of Liberty achievements is that we have released fixes for nearly 500 bugs since Kilo was released. What an amazing achievement!

Progress towards Liberty

33 days to go

496 bugs closed so far.

  • RST conversion:
    • Done.
  • User Guides information architecture overhaul
    • This is now well underway.
  • Greater focus on helping out devs with docs in their repo
    • A certain amount of progress has been made here, and some wrinkles sorted out which will improve this process for the future.
  • Improve how we communicate with and support our corporate contributors
    • I'm still trying to come up with great ideas for this, please let me know what you think.
  • Improve communication with Docs Liaisons
    • I'm very pleased to see liaisons getting more involved in our bugs and reviews. Keep up the good work!
  • Clearing out old bugs
    • We've had some solid progress on last week's bugs, with two assigned, and one of those in progress. Three new bugs this week.

Mitaka Summit Prep

The schedule has now been released, congratulations to everyone who had a talk accepted this time around: https://www.openstack.org/summit/tokyo-2015/schedule/

All ATCs should have received their pass by now, so now is the time to be booking your travel and accommodation: https://www.openstack.org/summit/tokyo-2015/tokyo-and-travel/

Docs have been given their design summit session allocation, so start thinking about what you would like to see discussed. I'll send out an etherpad to start planning in the next week or two.

Conventions

A new governance patch has landed which changes the way we capitalise service names (I know almost exactly 50% of you will be happy about this!): https://wiki.openstack.org/wiki/Documentation/Conventions#Service_and_project_names Please be aware of this when editing files, and remember that the 'source of truth' for these things is the projects.yaml file: http://git.openstack.org/cgit/openstack/governance/tree/reference/projects.yaml

Doc team meeting

The US meeting was held this week. The minutes are here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-09-09

The next meetings are: APAC: Wednesday 16 September, 00:30:00 UTC US: Wednesday 23 September, 14:00: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

Spotlight bugs for this week

Let's show these three how much we care:

https://bugs.launchpad.net/openstack-manuals/+bug/1284301 Document Neutron SSL-VPN for cloudadmin

https://bugs.launchpad.net/openstack-manuals/+bug/1288044 Add user defined extra capabilities

https://bugs.launchpad.net/openstack-manuals/+bug/1292327 Make cors work better

--

Remember, if you have content you would like to add to this newsletter, or you would like to be added to the distribution list, please email me directly at openstack@lanabrindley.com, or visit: https://wiki.openstack.org/w/index.php?title=Documentation/WhatsUpDoc

Keep on doc'ing!

Lana

4 September 2015

Hi everyone,

This has been a fairly busy week, with Summit preparations beginning, more newly migrated RST books going live, and testing starting on the Install Guide. I've been spending time on sorting out the Liberty blueprints still outstanding, and also working on some old bugs.

Progress towards Liberty

40 days to go!

  • RST conversion:
    • Is now completed! Well done and a huge thank you to everyone who converted pages, approved reviews, and participated in publishing the new guides. This was a truly phenomenal effort :)
  • Greater focus on helping out devs with docs in their repo
    • A certain amount of progress has been made here, and some wrinkles sorted out which will improve this process for the future.
  • Improve how we communicate with and support our corporate contributors
    • If you currently work on documentation for a company that would like to improve their upstream commits for documentation, please contact me!
  • Improve communication with Docs Liaisons
    • I'm very pleased to see liaisons getting more involved in our bugs and reviews. Keep up the good work!
  • Clearing out old bugs
    • The last lot of old bugs are still languishing. I'm assuming you all hate them so very much that I've decided to give you three more to pick from. Have at it!

Countdown to Summit

With the Liberty release less than two months away, that means it's nearly Summit time again: https://www.openstack.org/summit/tokyo-2015/

The schedule has now been released, congratulations to everyone who had a talk accepted this time around: https://www.openstack.org/summit/tokyo-2015/schedule/

All ATCs should have received their pass by now, so now is the time to be booking your travel and accommodation: https://www.openstack.org/summit/tokyo-2015/tokyo-and-travel/

Conventions

A new governance patch has landed which changes the way we capitalise service names (I know almost exactly 50% of you will be happy about this!): https://wiki.openstack.org/wiki/Documentation/Conventions#Service_and_project_names Please be aware of this when editing files, and remember that the 'source of truth' for these things is the projects.yaml file: http://git.openstack.org/cgit/openstack/governance/tree/reference/projects.yaml

Docs Tools

openstack-doc-tools 0.30.0 and openstackdocstheme 1.2.1 have been released. openstack-doc-tools allows translation of the Install Guide. openstackdocstheme contains fixes for the inclusion of metatags, removes unused images and javascript files, and fixes the "Docs Home" link.

Doc team meeting

The APAC meeting was not held this week. The minutes from the previous US meeting are here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-08-26

The next meetings are: US: Wednesday 9 September, 14:00:00 UTC APAC: Wednesday 16 September, 00:30: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

Spotlight bugs for this week

Let's give these three a little love:

https://bugs.launchpad.net/openstack-manuals/+bug/1280092 end user guide lacks doc on admin password injection

https://bugs.launchpad.net/openstack-manuals/+bug/1282765 Chapter 6. Block Storage in OpenStack Cloud Administrator Guide

https://bugs.launchpad.net/openstack-manuals/+bug/1284215 Driver for IBM SONAS and Storwize V7000 Unified

--

Remember, if you have content you would like to add to this newsletter, or you would like to be added to the distribution list, please email me directly at openstack@lanabrindley.com, or visit: https://wiki.openstack.org/w/index.php?title=Documentation/WhatsUpDoc

Keep on doc'ing!

Lana

21 August 2015

Hi everyone,

First of all, apologies for missing last week's newsletter: I got so caught up in the documentation swarm happening here in Brisbane that it totally slipped my mind! To make up for it, have this week's newsletter a day early :) In swarm news, the two days ran extremely smoothly, much to the credit of Suyog, Brian, and Alex who did the heavy lifting of preparation and organisation. While we focused largely on copy editing, we also had a lot of great discussion about the overall architecture of the book, and now have a draft plan ready for Mitaka, which Darren is driving with the Ops/Arch Guide speciality team.

While last week was all about the docs swarm, this week has been doing the final cleanup on our newly converted RST books. The Security Guide is now up, and the Cloud Admin and HA Guides aren't far behind. We're also about to start testing the Install Guide, now that its conversion is complete. Well done to all the people who have helped out on these efforts, great job!

Progress towards Liberty

55 days to go!

  • RST conversion:
    • Install Guide: Conversion is done, testing to begin soon.
    • Cloud Admin Guide: is complete! The new version will be available on docs.openstack.org very soon.
    • HA Guide: is also done, and will available on the site soon.
    • Security Guide: is complete, and live: http://docs.openstack.org/security-guide/
  • User Guides information architecture overhaul
    • Some user analysis has begun, with a new blueprint to land soon.
  • Greater focus on helping out devs with docs in their repo
    • Work has picked up on the Ironic docs again.
  • Improve how we communicate with and support our corporate contributors
    • If you currently work on documentation for a company that would like to improve their upstream commits for documentation, please contact me!
  • Improve communication with Docs Liaisons
    • I'm very pleased to see liaisons getting more involved in our bugs and reviews. Keep up the good work!
  • Clearing out old bugs
    • Sadly, no action on the spotlight bugs again this week. I'll keep the current three bugs for this week, to give everyone a little more time.

RST Migration

That's it! We're done!

Do you have ideas for which book should be next? Have a think on it, and we'll discuss this at Summit.

Training Guides

I'm happy to announce that the Training Labs are now in their own repo, and are considered a documentation speciality team. Well done to Pranav, Matjaz, Sayali, and Roger for driving this effort.

Countdown to Summit

With the Liberty release less than two months away, that means it's nearly Summit time again: https://www.openstack.org/summit/tokyo-2015/

Here's a few things you might want to be thinking about:

  • Do you need a visa to visit Japan? If so, you need to be organising this NOW: https://www.openstack.org/summit/tokyo-2015/tokyo-and-travel/#visa
  • Do you have an ATC pass? If you haven't received your pass yet, and you're an ATC, please contact me so I can chase this up for you. Remember to use your ATC discount code before 31 August to make sure you get the full price discounted.

Doc team meeting

The APAC meeting was held this week. Read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-08-19

The next meetings are: US: Wednesday 26 August, 14:00:00 UTC APAC: Wednesday 2 September, 00:30: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

Spotlight bugs for this week

Let's give these three a little more love:

https://bugs.launchpad.net/openstack-manuals/+bug/1257018 VPNaaS isn't documented in cloud admin

https://bugs.launchpad.net/openstack-manuals/+bug/1257656 VMware: add support for VM diagnostics

https://bugs.launchpad.net/openstack-manuals/+bug/1261969 Document nova server package

--

Remember, if you have content you would like to add to this newsletter, or you would like to be added to the distribution list, please email me directly at openstack@lanabrindley.com, or visit: https://wiki.openstack.org/w/index.php?title=Documentation/WhatsUpDoc

Keep on doc'ing!

Lana

7 August 2015

Hi everyone,

Welcome to August! Today we can finally announce that the Cloud Admin Guide is now completely converted to RST! I have been doing a fair bit of 'behind the scenes' work this week, focusing mainly on Training Guides and our docs licensing. We also welcome another new core team member this week, and for those of you in the APAC region, get ready for the Docs Swarm in Brisbane, where we'll be working on restructuring the Architecture Design Guide.

Progress towards Liberty

68 days to go!

  • User Guides information architecture overhaul
    • Waiting on the RST conversion of the Cloud Admin Guide to be complete
  • Greater focus on helping out devs with docs in their repo
    • Work has stalled on the Ironic docs, we need to pick this up again. Contact me if you want to know more, or are willing to help out.
  • Improve how we communicate with and support our corporate contributors
    • I have been brainstorming ideas with Foundation, watch this space!
  • Improve communication with Docs Liaisons
    • I'm very pleased to see liaisons getting more involved in our bugs and reviews. Keep up the good work!
  • Clearing out old bugs
    • Sadly, no action on the spotlight bugs this week. Perhaps we're all worn out from the RST conversions? I'll keep the current three bugs for this week, to give everyone a little more time.

RST Migration

With the Cloud Admin Guide complete, we are now working on the Install Guide, HA Guide, and the Security Guide. If you would like to assist, please get in touch with the appropriate speciality team:

For books that are now being converted, don't forget that any change you make to the XML must also be made to the RST version until conversion is complete. Our lovely team of cores will be keeping an eye out to make sure loose changes to XML don't pass the gate, but try to help them out by pointing out both patches in your reviews.

Training Guides

I've been working with the Training Guides group and the docs core team to determine the best way to move forward with the Training Guides project. At this stage, we're planning on breaking the project up into a few distinct parts, and bringing Training Guides back into the documentation group as a speciality team. If you have any opinions or ideas on this, feel free to contact me so I can make sure we're considering all the options.

APAC Docs Swarm

We're less than a week away from the APAC doc swarm! This time we'll be working on the Architecture Design Guide. It's to be held at the Red Hat office in Brisbane, on 13-14 August. Check out http://openstack-swarm.rhcloud.com/ for all the info and to RSVP.

Core Team Changes

This month, we welcome KATO Tomoyuki on to our docs core team. Thanks for all your hard work Tomoyuki-san, and welcome to the team!

Doc team meeting

The APAC meeting was held this week. Read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-08-05

The next meetings are: US: Wednesday 12 August, 14:00:00 UTC APAC: Wednesday 19 August, 00:30: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

Spotlight bugs for this week

Let's give these three a little more oxygen:

https://bugs.launchpad.net/openstack-manuals/+bug/1257018 VPNaaS isn't documented in cloud admin

https://bugs.launchpad.net/openstack-manuals/+bug/1257656 VMware: add support for VM diagnostics

https://bugs.launchpad.net/openstack-manuals/+bug/1261969 Document nova server package

--

Remember, if you have content you would like to add to this newsletter, or you would like to be added to the distribution list, please email me directly at openstack@lanabrindley.com, or visit: https://wiki.openstack.org/w/index.php?title=Documentation/WhatsUpDoc

Keep on doc'ing!

Lana

31 July 2015

Hi everyone,

This week, like last, was all about the RST conversion. With just a 48 hour long sprint, the Install Guide is almost complete! A hearty congratulations to everyone who contributed. One of the interesting things about doing all these conversions is the amount of conversation it has started about our conventions, and I'm pleased to see that we're really starting to get a feel for how RST can work for us, and what we can demand of it. It's also great to see some related changes to the sphinx theme that handles how we display our shiny RST books.

Progress towards Liberty

75 days to go!

  • User Guides information architecture overhaul
    • Waiting on the RST conversion of the Cloud Admin Guide to be complete
  • Greater focus on helping out devs with docs in their repo
    • Work has stalled on the Ironic docs, we need to pick this up again. Contact me if you want to know more, or are willing to help out.
  • Improve how we communicate with and support our corporate contributors
    • I have been brainstorming ideas with Foundation, watch this space!
  • Improve communication with Docs Liaisons
    • I'm very pleased to see liaisons getting more involved in our bugs and reviews. Keep up the good work!
  • Clearing out old bugs
    • Thanks to Brian for picking up one of the spotlight bugs from last week. Three new bugs to look at this week.

RST Migration

The next books we are focusing on for RST conversion are the Install Guide, Cloud Admin Guide, HA Guide, and the Security Guide. If you would like to assist, please get in touch with the appropriate speciality team:

For books that are now being converted, don't forget that any change you make to the XML must also be made to the RST version until conversion is complete. Our lovely team of cores will be keeping an eye out to make sure loose changes to XML don't pass the gate, but try to help them out by pointing out both patches in your reviews.

Docs Tools

Thanks to Dave for picking up a bug this week and adding a navigation bar to the sidepane of the docs theme for our RST books. We should be releasing an updated docs theme shortly so you can play with this new functionality. In the meantime, if you have suggestions for the docs theme, raise the issue on the docs mailing list, or go right ahead and create a bug for it.

APAC Docs Swarm

The APAC team have been working on holding another doc swarm, this time working on the Architecture Design Guide. It's to be held at the Red Hat office in Brisbane, on 13-14 August. Check out http://openstack-swarm.rhcloud.com/ for all the info.

Doc team meeting

The US meeting got cancelled this week.

The next meetings are: APAC: Wednesday 5 August, 00:30:00 UTC US: Wednesday 12 August, 14:00: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

Spotlight bugs for this week

Three new spotlight bugs for you to sink your teeth into:

https://bugs.launchpad.net/openstack-manuals/+bug/1257018 VPNaaS isn't documented in cloud admin

https://bugs.launchpad.net/openstack-manuals/+bug/1257656 VMware: add support for VM diagnostics

https://bugs.launchpad.net/openstack-manuals/+bug/1261969 Document nova server package

--

Remember, if you have content you would like to add to this newsletter, or you would like to be added to the distribution list, please email me directly at openstack@lanabrindley.com, or visit: https://wiki.openstack.org/w/index.php?title=Documentation/WhatsUpDoc

Keep on doc'ing!

Lana

24 July 2015

Hi everyone,

Wow! What a great week for RST conversion patches! As I write this, there are only a handful of outstanding sections on the Cloud Admin and HA Guides, and well over 40 sections have now been converted on the Install Guide, with the conversion sprint running for another twelve hours or so. Thank you to everyone who has taken the time to grab a section and do a conversion, and to all those people who have given their +1 to a patch. I can't wait to see all our shiny new books up on docs.openstack.org :)

Progress towards Liberty

  • User Guides information architecture overhaul
    • Waiting on the RST conversion of the Cloud Admin Guide to be complete
  • Greater focus on helping out devs with docs in their repo
    • Work has stalled on the Ironic docs, we need to pick this up again. Contact me if you want to know more, or are willing to help out.
  • Improve how we communicate with and support our corporate contributors
    • I have been brainstorming ideas with Foundation, watch this space!
  • Improve communication with Docs Liaisons
    • I'm very pleased to see liaisons getting more involved in our bugs and reviews. Keep up the good work!
  • Clearing out old bugs
    • Sadly, no progress on the spotlight bugs from last week. I'll hold them over for another week, so now is your chance to jump in and grab them!

RST Migration

The next books we are focusing on for RST conversion are the Install Guide, Cloud Admin Guide, HA Guide, and the Security Guide. If you would like to assist, please get in touch with the appropriate speciality team:

For books that are now being converted, don't forget that any change you make to the XML must also be made to the RST version until conversion is complete. Our lovely team of cores will be keeping an eye out to make sure loose changes to XML don't pass the gate, but try to help them out by pointing out both patches in your reviews.

HA Guide Works

With the RST conversion on the HA Guide wrapping up, the HA Guide speciality team are looking for people to help out with the reorganisation and writing the new content. They have quite a few bugs to get through, and they need your help! Contact Matt Griffin, or any other member of the HA Guide Speciality Team, or join their weekly IRC meeting. Details here: https://wiki.openstack.org/wiki/Documentation/HA_Guide_Update

Docs Tools

While they're not strictly docs tools, I wanted to mention review dashboards here today. Did you know that we maintain a list of custom OpenStack review dashboards for you to use? They're customised to show only the reviews you care about, which can save you a lot of time and needless clicking. All you need to do is pick the dashboard you want to use, copy the URL, and save it to your bookmarks. Anne has just updated the Docs Review Inbox dashboard to include DocImpact reviews, so it's worth checking out: http://ghostcloud.net/openstack_gerrit_dashboards/dashboard_doc-program.html You can see the full list here: http://ghostcloud.net/openstack_gerrit_dashboards/

APAC Docs Swarm

The APAC team have been working on holding another doc swarm, this time working on the Architecture Design Guide. It's to be held at the Red Hat office in Brisbane, on 13-14 August. Check out http://openstack-swarm.rhcloud.com/ for all the info.

Doc team meeting

The APAC docs meeting was held this week, catch up on the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-07-22

The next meetings are: US: Wednesday 29 July, 14:00:00 UTC APAC: Wednesday 5 August, 00:30: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

Spotlight bugs for this week

Giving these three poor old bugs some extra oxygen:

https://bugs.launchpad.net/openstack-manuals/+bug/1241116 Using policies for protected properties

https://bugs.launchpad.net/openstack-manuals/+bug/1241179 Add notifications for groups and roles

https://bugs.launchpad.net/openstack-manuals/+bug/1251060 Xenapi: Allow windows builds with xentools 6.1 and 6.2

--

Remember, if you have content you would like to add to this newsletter, or you would like to be added to the distribution list, please email me directly at openstack@lanabrindley.com, or visit: https://wiki.openstack.org/w/index.php?title=Documentation/WhatsUpDoc

Keep on doc'ing!

Lana

17 July 2015

Hi everyone,

I'm very pleased to announce that we finally have a name for our M release: Mitaka (三鷹)! Accordingly, the Tokyo Summit for the Mitaka release is only just over 100 days away. CFP closed a couple of days ago, and I've noticed that the first round of ATC discount codes have gone out. If you haven't got yours yet, then keep patching Liberty and sit tight. The discount codes will come out in stages after every snapshot. This week, we've had some great discussions about networking scenarios in the Install Guide, and the best way to include RST files in our newly converted books. We also have both the HA Guide and the Cloud Admin Guide conversions in their final stages, and the Install Guide conversion sprint coming up. Very exciting!

Progress towards Liberty

  • User Guides information architecture overhaul
    • Waiting on the RST conversion of the Cloud Admin Guide to be complete
  • Greater focus on helping out devs with docs in their repo
    • Work has stalled on the Ironic docs, we need to pick this up again. Contact me if you want to know more, or are willing to help out.
  • Improve how we communicate with and support our corporate contributors
    • I have been brainstorming ideas with Foundation, watch this space!
  • Improve communication with Docs Liaisons
    • I'm very pleased to see liaisons getting more involved in our bugs and reviews. Keep up the good work!
  • Clearing out old bugs
    • A small amount of progress on the old bugs we held over from last week. New ones to check out in this newsletter!

RST Migration

The next books we are focusing on for RST conversion are the Install Guide, Cloud Admin Guide, HA Guide, and the Security Guide. If you would like to assist, please get in touch with the appropriate speciality team:

For books that are now being converted, don't forget that any change you make to the XML must also be made to the RST version until conversion is complete. Our lovely team of cores will be keeping an eye out to make sure loose changes to XML don't pass the gate, but try to help them out by pointing out both patches in your reviews.

Install Guide RST Conversion Sprint

In order to kick off the RST conversion of the Install Guide, the speciality team have decided to run a virtual conversion sprint over two days on July 22-24. For more information, see the https://wiki.openstack.org/wiki/VirtualSprints#Installation_guide_conversion_from_DocBook_to_RST wiki page, and the https://etherpad.openstack.org/p/installguide-rst-virtual-sprint etherpad.

HA Guide Works

With the RST conversion on the HA Guide wrapping up, the HA Guide speciality team are looking for people to help out with the reorganisation and writing the new content. They have quite a few bugs to get through, and they need your help! Contact Matt Griffin, or any other member of the HA Guide Speciality Team, or join their weekly IRC meeting. Details here: https://wiki.openstack.org/wiki/Documentation/HA_Guide_Update

Docs Tools

Last week, we released openstackdocstheme 1.1.0, see http://lists.openstack.org/pipermail/openstack-announce/2015-June/000392.html. The main new features in this release are improvements for bug reporting, variable lists like the glossary are now indented, and next/prev links are now icons on the upper right part of the page.

Additionally, the stable/icehouse branch of openstack-manuals has been EOLed, no further updates will be done from it. For more information, see http://lists.openstack.org/pipermail/openstack-infra/2015-July/002888.html

Doc team meeting

The next meetings are:

APAC: Wednesday 22 July, 00:30:00 UTC

US: Wednesday 29 July, 14:00: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

Spotlight bugs for this week

We've now got people assigned to work on last week's old bugs, which is great! Here are three more rusty old bugs that could use some love:

https://bugs.launchpad.net/openstack-manuals/+bug/1241116 Using policies for protected properties

https://bugs.launchpad.net/openstack-manuals/+bug/1241179 Add notifications for groups and roles

https://bugs.launchpad.net/openstack-manuals/+bug/1251060 Xenapi: Allow windows builds with xentools 6.1 and 6.2

--

Remember, if you have content you would like to add to this newsletter, or you would like to be added to the distribution list, please email me directly at openstack@lanabrindley.com, or visit: https://wiki.openstack.org/w/index.php?title=Documentation/WhatsUpDoc

Keep on doc'ing!

Lana

10 July 2015

Hi everyone,

First of all, apologies for my absence over the past couple of weeks. I took some time off to spend with my daughter while she was on school holidays, and then got ill! It never rains but it pours ;) While I was out, our M release was named, and then unnamed, and we're now waiting for a new name. We also had a great discussion about which networking scenario is the best fit for our new-and-improved Installation Guide, and planned a sprint to get the RST conversion for that book happening. More on that in this newsletter.

Progress towards Liberty

  • User Guides information architecture overhaul
    • Waiting on the RST conversion of the Cloud Admin Guide to be complete
  • Greater focus on helping out devs with docs in their repo
    • Work has started on the Ironic docs, we're now trying to resolve some issues with service name standards ("Bare Metal" or "Bare metal"?). Contact me if you want to know more, or are willing to help out.
  • Improve how we communicate with and support our corporate contributors
    • I have been brainstorming ideas with Foundation, watch this space!
  • Improve communication with Docs Liaisons
    • I'm very pleased to see liaisons getting more involved in our bugs and reviews. Keep up the good work!
  • Clearing out old bugs
    • Sadly, no progress this week.

RST Migration

The next books we are focusing on for RST conversion are the Install Guide, Cloud Admin Guide, HA Guide, and the Security Guide. If you would like to assist, please get in touch with the appropriate speciality team:

For books that are now being converted, don't forget that any change you make to the XML must also be made to the RST version until conversion is complete. Our lovely team of cores will be keeping an eye out to make sure loose changes to XML don't pass the gate, but try to help them out by pointing out both patches in your reviews.

Install Guide RST Conversion Sprint

In order to kick off the RST conversion of the Install Guide, the speciality team have decided to run a virtual conversion sprint over two days on July 22-24. For more information, see the https://wiki.openstack.org/wiki/VirtualSprints#Installation_guide_conversion_from_DocBook_to_RST wiki page, and the https://etherpad.openstack.org/p/installguide-rst-virtual-sprint etherpad.

New core team

The core team have just completed our review for July, and would like to welcome two new core contributors: Alexandra Settle, and Olena Logvinova. Congratulations to you both :)

Doc team meeting

The APAC meeting was cancelled this week, our next meetings are:

US: Wednesday 15 July, 14:00:00 UTC (note that this has NOT changed with daylight savings time) APAC: Wednesday 22 July, 00:30: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

Spotlight bugs for this week

Sadly, even with an extra week, our three spotlight bugs remain unloved. I'm going to keep them here for another week, so now is your chance to swoop in and make a difference!

https://bugs.launchpad.net/openstack-manuals/+bug/1212349 vmware documentation

https://bugs.launchpad.net/openstack-manuals/+bug/1212687 xenapi

https://bugs.launchpad.net/openstack-manuals/+bug/1239308 Add notifications for groups and roles

--

Remember, if you have content you would like to add to this newsletter, or you would like to be added to the distribution list, please email me directly at openstack@lanabrindley.com, or visit: https://wiki.openstack.org/w/index.php?title=Documentation/WhatsUpDoc

Keep on doc'ing!

Lana

26 June 2015

Hi everyone,

First of all, our M release has been named! Sadly, it hasn't cleared legal yet, so we can't publicly announce it, however, here are the poll results: http://civs.cs.cornell.edu/cgi-bin/results.pl?id=E_4983776e190c8dbc It was a close-run contest!

This week, I've been continuing to dust off some old bugs, and have been chatting to a few of our docs liaisons to work out how we can best get them engaged with what we're working on. I've also been spending a lot of time on standards questions, and thinking about the future of the DocImpact flag.

Progress towards Liberty

  • User Guides information architecture overhaul
    • Waiting on the RST conversion of the Cloud Admin Guide to be complete
  • Greater focus on helping out devs with docs in their repo
    • Work has started on the Ironic docs, we're now trying to resolve some issues with service name standards ("Bare Metal" or "Bare metal"?). Contact me if you want to know more, or are willing to help out.
  • Improve how we communicate with and support our corporate contributors
    • No progress this week
  • Improve communication with Docs Liaisons
    • I'm very pleased to see liaisons getting more involved in our bugs and reviews. Keep up the good work!
  • Clearing out old bugs
    • Thanks to Yusuke-san for closing bug 1330005!

RST Migration

The next books we are focusing on for RST conversion are the Install Guide, Cloud Admin Guide, HA Guide, and the Security Guide. If you would like to assist, please get in touch with the appropriate speciality team:

For books that are now being converted, don't forget that any change you make to the XML must also be made to the RST version until conversion is complete. Our lovely team of cores will be keeping an eye out to make sure loose changes to XML don't pass the gate, but try to help them out by pointing out both patches in your reviews.

Docs Tools

Andreas and Nick just released openstack-docs-tools 0.29.1, after we discovered an RST translation bug in 0.29. Thanks for the quick turnaround on that!

Documentation Standards

There's been quite a lot of conversation this week over capitalisation of service names, with the community divided down the middle as to which we prefer! While we all enjoy a good style discussion, I've also asked Anne (in her role on the TC) to confirm the legal restrictions for us. Watch this space! In the meantime, continue to discuss this on the mailing list :)

Docs Liaisons

Don't forget that we have subject matter experts to help you with documentation questions that you might have. One of the best ways to get our liaisons' attention is to add them to a bug or a patch. Feel free to look up the liaison for the project you're working with, and add them to the cc list for your patch:

https://wiki.openstack.org/wiki/CrossProjectLiaisons#Documentation

Doc team meeting

The APAC meeting was held this week, see the minutes here to catch up: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-06-24

Next meetings are: US: Wednesday 1 July, 14:00:00 UTC (note that this has NOT changed with daylight savings time) APAC: Wednesday 8 July, 00:30: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

Spotlight bugs for this week

Of the three bugs we spotlighted last week, one of them was closed (thanks Yusuke-san!), and the other two are still up for grabs. Olga is working on a Spotlight bug from last week, too. Let's keep the momentum, with another three sad old bugs that could use some love:

https://bugs.launchpad.net/openstack-manuals/+bug/1212349 vmware documentation

https://bugs.launchpad.net/openstack-manuals/+bug/1212687 xenapi

https://bugs.launchpad.net/openstack-manuals/+bug/1239308 Add notifications for groups and roles

--

Remember, if you have content you would like to add to this newsletter, or you would like to be added to the distribution list, please email me directly at openstack@lanabrindley.com, or visit: https://wiki.openstack.org/w/index.php?title=Documentation/WhatsUpDoc

Keep on doc'ing!

Lana

19 June 2015

Hi everyone,

This week, I've been working on helping out the Ironic team to sort out their Install Guide (thanks have to go to Gauvain and Nick, who have offered to help out with writing assistance here), and trying to come up with some better ways to work with the i18n team, and our docs liaisons. More on all of that further in.

Progress towards Liberty

  • User Guides information architecture overhaul
    • Waiting on the RST conversion of the Cloud Admin Guide to be complete
  • Greater focus on helping out devs with docs in their repo
    • We now have a team starting to form to work on Ironic docs. Contact me if you want to know more, or are willing to help out.
  • Improve how we communicate with and support our corporate contributors
    • No progress this week
  • Improve communication with Docs Liaisons
    • I have now reached out to liaisons. More later in this newsletter.
  • Clearing out old bugs
    • Thanks to Tom for closing bug 1195875. Let's keep up the great work!

RST Migration

The next books we are focusing on for RST conversion are the Install Guide, Cloud Admin Guide, HA Guide, and the Security Guide. If you would like to assist, please get in touch with the appropriate speciality team:

For books that are now being converted, don't forget that any change you make to the XML must also be made to the RST version until conversion is complete. Our lovely team of cores will be keeping an eye out to make sure loose changes to XML don't pass the gate, but try to help them out by pointing out both patches in your reviews.

Docs Tools

Andreas will shortly be updating openstack-docs-tools to 0.29.

Docs Liaisons

Don't forget that we have subject matter experts to help you with documentation questions that you might have. As you're working on bugs, feel free to give them a quick ping or an email to ask questions. They promise not to laugh at you!

https://wiki.openstack.org/wiki/CrossProjectLiaisons#Documentation

i18n Team

At Summit, I spent a lot of time with Ying Chun Guo (Daisy) from the translation team, to try and come up with a way we can make sure our teams are working together better. To that end, we've got a few ideas we're going to be implementing over the next few weeks. First of all, this newsletter now goes direct to the the translation mailing list, as well the dev and doc lists (hi translators!). Secondly, Daisy is going to poll her team to identify an i18n documentation liaison, who will be the go-to person for all questions about translation for docs. The other thing we're going to do is to make sure we're helping the i18n team to keep their status page up to date: https://wiki.openstack.org/wiki/I18nTeam/docs-translation#Document_categorize If you're working on a doc that is translated, please check that table and make sure the translation team know what you're up to! This will help prevent needless effort on their part, which benefits us all in the end.

Doc team meeting

The US meeting was held this week, see the minutes here to catch up: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-06-17

Apologies for the timing confusion on that one, it seems as though daylight savings changes took us by surprise. For now, the meeting will remain at 1400UTC. If you would prefer it to be at a different time, bring it up on the mailing list, or in the next US meeting.

Next meetings are: APAC: Wednesday 24 June, 00:30:00 UTC US: Wednesday 1 July, 14:00: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

Spotlight bugs for this week

Of the three bugs we spotlighted last week, one of them got marked as invalid (thanks Tom!), and another is in progress with SME assistance (thanks Olga!). That's great! Here's another three dusty old bugs that could use a polish up:

https://bugs.launchpad.net/openstack-manuals/+bug/1330005 Glance image properties and values (low hanging fruit)

https://bugs.launchpad.net/openstack-manuals/+bug/1394397 Nova notification_driver

https://bugs.launchpad.net/openstack-manuals/+bug/1205402 iPXE ISO boot support

--

Remember, if you have content you would like to add to this newsletter, or you would like to be added to the distribution list, please email me directly at openstack@lanabrindley.com, or visit: https://wiki.openstack.org/w/index.php?title=Documentation/WhatsUpDoc

Keep on doc'ing!

Lana

12 June 2015

Hi everyone,

This week, I've been spending some time in the dustier corners of our bug list. Do you know we currently have over 500 bugs open?! Scroll down to the bottom of this newsletter for more on what we're going to do about that.

If you have content you would like to add, or you would like to be added to the distribution list, please email me directly at openstack@lanabrindley.com. If you want to see my early drafts and typos, or check on old newsletters, you can do so here: https://wiki.openstack.org/w/index.php?title=Documentation/WhatsUpDoc

Progress towards Liberty

  • RST conversion:
  • User Guides information architecture overhaul
    • Waiting on the RST conversion of the Cloud Admin Guide to be complete
  • Greater focus on helping out devs with docs in their repo
    • Discussion with the Ironic team was started this week. We need a Speciality Team to take on this work.
  • Improve how we communicate with and support our corporate contributors
    • No progress this week
  • Improve communication with Docs Liaisons
  • Clearing out old bugs
    • I went through and pruned a lot of two- and three-year old bugs from the list. Please review and re open any you think still require tracking.
    • As part of this effort, I will be picking out a few old bugs to be spotlighted in each newsletter. Please take a look as they come up and see what you can do to help!

RST Migration

The next books we are focusing on for RST conversion are the Install Guide, Cloud Admin Guide, HA Guide, and the Security Guide. If you would like to assist, please get in touch with the appropriate speciality team:

For books that are now being converted, don't forget that any change you make to the XML must also be made to the RST version until conversion is complete. Our lovely team of cores will be keeping an eye out to make sure loose changes to XML don't pass the gate, but try to help them out by pointing out both patches in your reviews.

RST Common Files

We're coming across some build issues in the RST books with common files. If you have a common file in the ToC of a guide, please move it into the source file of that guide to prevent build issues. Using :orphan: directive marking on the file can also prevent sphinx marking the doc as an error.

Bug triaging

This week, the core team have noticed a lot of patches that have had to be cancelled, because they were fixing untriaged bugs. If you want to work on a bug, be sure that a core reviewer has triaged it before you create a patch. This will stop you spending time on patches that might not get accepted. We should now have core team available in most timezones, so if you need a bug looked at so you can get started quickly, ping the docs IRC channel, and a core should be around to help you out.

Doc team meeting

The APAC meeting was held this week, see the minutes here to catch up: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-06-10

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

Spotlight bugs for this week

This is a way of trying to get some eyeballs on old bugs, in an attempt to pay down some of our technical debt. Kudos to Tom Fifield who helped me work out what to do about them! Each week, I'll spotlight a few old bugs here for people to go and look at and determine if they're still valid or not. Please check out these bugs, let's have a conversation (in the bug comments), and if you can close them, do so! To make this slightly more exciting, I'll be attempting to keep track of who is closing these old bugs, and will see if I can't put together a little care package to send the way of anyone who makes a real difference here.

https://bugs.launchpad.net/openstack-manuals/+bug/1195875 Controller Callbacks

https://bugs.launchpad.net/openstack-manuals/+bug/1201978 Pluggable Remote User

https://bugs.launchpad.net/openstack-manuals/+bug/1204566 Stop and delete operations


Keep on doc'ing!

Lana

5 June 2015

Hi everyone,

With our Kilo branch now cut, we're running headlong into the Liberty development cycle! And don't forget to have your say on what the M release should be called: https://wiki.openstack.org/wiki/Release_Naming/M_Proposals

If you have content you would like to add, or you would like to be added to the distribution list, please email me directly at openstack@lanabrindley.com. I've also decided to start drafting these 'in the open' (as it were). If you want to see my early drafts and typos, or check on old newsletters, you can do so here: https://wiki.openstack.org/w/index.php?title=Documentation/WhatsUpDoc

Progress towards Liberty

  • RST conversion:
  • User Guides information architecture overhaul
    • Waiting on the RST conversion of the Cloud Admin Guide to be complete
  • Greater focus on helping out devs with docs in their repo
    • No progress this week
  • Improve how we communicate with and support our corporate contributors
    • I met with Alison of Oracle to discuss how we can help out their team
  • Improve communication with Cross Team Liaisons

Kilo Branching

Thanks to Andreas, Anne, and Tom for getting the Stable/Kilo branch completed this week. With this, Kilo is now complete* and patches for the Install Guide and the Config Reference will now be against Liberty unless you specifically backport a change to Kilo. You can do this by committing to master with the line Backport: Kilo in your commit message. Remember that all other book are continuously integrated, and this isn't necessary.

[*] Anne: feel free to go have a lie down ;)

RST Migration

The next books we are focusing on for RST conversion are the Install Guide, Cloud Admin Guide, and the HA Guide. If you would like to assist, please get in touch with the appropriate speciality team.


For books that are now being converted, don't forget that any change you make to the XML must also be made to the RST version until conversion is complete. Our lovely team of cores will be keeping an eye out to make sure loose changes to XML don't pass the gate, but try to help them out by pointing out both patches in your reviews.

New Core Reviewer Process

We did our first monthly round of Core Team review this week, and would like to welcome our newest core team member, Darren Chan. We also bid a fond farewell to Summer Long and Bryan Payne, who have been great core team members and contributors, but have now moved on to other adventures. We sincerely thank them both for their commitment over the time they were core.

The new core process is documented here: https://wiki.openstack.org/wiki/Documentation/HowTo#Achieving_core_reviewer_status The next round will be around 1 July.

Doc team meeting

The US meeting was held this week, see the minutes here to catch up: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-06-03

Thanks Shilla for running the US team meeting!

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

Thanks! Lana


29 May 2015

Hi everyone,

Continuing in Anne's fine tradition, I intend to send these out every Friday. If you have content you would like to add, or you would like to be added to the distribution list, please email me directly at openstack@lanabrindley.com. I've also decided to start drafting these 'in the open' (as it were). If you want to see my early drafts and typos, or check on old newsletters, you can do so here: https://wiki.openstack.org/w/index.php?title=Documentation/WhatsUpDoc

Design Summit

The Design Summit was a great success. We had ten sessions for docs overall, including two workgroups and a contributors' meetup. Thanks to everyone who came along (or participated remotely!) and had their say on the Liberty release. I've been spending time gathering my thoughts after the Summit, and have summarised the etherpad notes on the wiki here: https://wiki.openstack.org/w/index.php?title=Documentation/Liberty You can also see the original etherpads here: https://wiki.openstack.org/wiki/Design_Summit/Liberty/Etherpads#Documentation

In short, the main things I would like us to achieve for Liberty are:

  • RST conversion: Install Guide, Cloud Admin Guide, HA Guide
  • User Guides information architecture overhaul.
  • Greater focus on helping out devs with docs in their repo
  • Improve how we communicate with and support our corporate contributors


If you have a burning issue that didn't get addressed during the Summit, or that you think I've forgotten, now would be your chance to tell me about it! Look out for Blueprints and Specs for this work over the next couple of weeks.

RST Migration

The next books we are focusing on for RST conversion are the Install Guide, Cloud Admin Guide, and the HA Guide. If you would like to assist, please get in touch with the appropriate speciality team.


New Core Reviewer Process

One of the simpler changes I was asked to implement at the Design Summit was a new core reviewer process, with the aim of making it a more balanced approach to selecting core team members. We decided on a process that combines a monthly statistics-based selection process with a continuous nomination-based process. I've written up the details on the HowTo here: https://wiki.openstack.org/wiki/Documentation/HowTo#Achieving_core_reviewer_status and will implement the first round on 1 June.

Doc team meeting

APAC meeting was held this week, see the minutes here to catch up: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-05-27

Thanks to Joe for holding the APAC fort while I was travelling!

Next meetings are: US: Wednesday 3 June, 14:00:00 UTC APAC: Wednesday 10 June, 00:30: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

Thanks! Lana