Jump to: navigation, search

Difference between revisions of "Documentation/WhatsUpDoc"

(6 February 2016)
Line 94: Line 94:
 
Lana
 
Lana
  
= 6 February 2016 =
+
= 29 January 2016 =
  
 
Hi everyone,
 
Hi everyone,

Revision as of 03:42, 6 February 2016

Documentation Newsletters

This is where I draft the 'What's Up, Doc?' documentation newsletters. The newsletter is distributed every Friday (ish), to the openstack-docs mailing list. If you want to be added to the distribution list, or have content to add, please edit these sections:

Distribution List

Your suggestions for content

  • Your
  • Content
  • Here
  • Core reviewer responsibilities

Looking for older editions?

You can see older newsletters here: Documentation/WhatsUpDoc_Archive

29 January 2016

Hi everyone,

An incredibly hot week here in the antipodes, coupled with Australia Day has meant that I haven't been particularly productive this week. Luckily, the rest of you have picked up the slack, and things have been ticking along nicely. Thanks everyone :)

Progress towards Mitaka

68 days to go!

368 bugs closed so far for this release.

RST Conversions

  • All planned RST conversions are now complete!

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 No update this week.

Installation Guide - Christian Berendt AODH install instructions merged

Networking Guide - Edgar Magana Networking guide versioning has been completed, we are publishing Liberty and Mitaka releases. Networking guide ToC has been updated and missing chapter have been assigned. Etherpad with the topic missing from the guide: https://etherpad.openstack.org/p/networking-guide

Security Guide - Nathaniel Dillon No update this week.

User Guides - Joseph Robinson Team meetings started again this week, and the large point was an IA reorg after content merging. Other discussion point included checking in with Docs liasons for Sahara, Trove, Murano, and Magneto plus checking in with interested volunteers for the User Guide Team.

Ops and Arch Guides - Shilla Saebi Reorganization of the architecture guide is on-going. We have a full team of volunteers on our wiki <https://wiki.openstack.org/wiki/Documentation/OpsGuide>, but not much traction. We need more volunteers and we were looking to do a swarm in Manchester but not enough team members attending. Looking to maybe set one up for Austin.

API Docs - Anne Gentle No update this week.

Config Ref - Gauvain Pocentek No update this week.

Training labs - Pranav Salunke, Roger Luethi Liberty support continues to make good progress. We can now launch an instance VM. Some clean up and reviewing still needs to be done.

Training Guides - Matjaz Pancur Preparations for Austin Upstream training (https://review.openstack.org/#/c/271006/). New landing page for Training guides (http://docs.openstack.org/draft/training-guides/.

Hypervisor Tuning Guide - Joe Topjian An update to to the Guide was posted back in December with a call for participation: http://lists.openstack.org/pipermail/openstack-operators/2015-December/009147.html

Doc team meeting

Next meetings: US: Wednesday 3 February, 14:00 UTC APAC: Wednesday 10 February, 00:30 UTC

Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting

Note that there is currently discussion about moving the US meeting 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

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

29 January 2016

Hi everyone,

An incredibly hot week here in the antipodes, coupled with Australia Day has meant that I haven't been particularly productive this week. Luckily, the rest of you have picked up the slack, and things have been ticking along nicely. Thanks everyone :)

Progress towards Mitaka

68 days to go!

368 bugs closed so far for this release.

RST Conversions

  • All planned RST conversions are now complete!

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 No update this week.

Installation Guide - Christian Berendt AODH install instructions merged

Networking Guide - Edgar Magana Networking guide versioning has been completed, we are publishing Liberty and Mitaka releases. Networking guide ToC has been updated and missing chapter have been assigned. Etherpad with the topic missing from the guide: https://etherpad.openstack.org/p/networking-guide

Security Guide - Nathaniel Dillon No update this week.

User Guides - Joseph Robinson Team meetings started again this week, and the large point was an IA reorg after content merging. Other discussion point included checking in with Docs liasons for Sahara, Trove, Murano, and Magneto plus checking in with interested volunteers for the User Guide Team.

Ops and Arch Guides - Shilla Saebi Reorganization of the architecture guide is on-going. We have a full team of volunteers on our wiki <https://wiki.openstack.org/wiki/Documentation/OpsGuide>, but not much traction. We need more volunteers and we were looking to do a swarm in Manchester but not enough team members attending. Looking to maybe set one up for Austin.

API Docs - Anne Gentle No update this week.

Config Ref - Gauvain Pocentek No update this week.

Training labs - Pranav Salunke, Roger Luethi Liberty support continues to make good progress. We can now launch an instance VM. Some clean up and reviewing still needs to be done.

Training Guides - Matjaz Pancur Preparations for Austin Upstream training (https://review.openstack.org/#/c/271006/). New landing page for Training guides (http://docs.openstack.org/draft/training-guides/.

Hypervisor Tuning Guide - Joe Topjian An update to to the Guide was posted back in December with a call for participation: http://lists.openstack.org/pipermail/openstack-operators/2015-December/009147.html

Doc team meeting

Next meetings: US: Wednesday 3 February, 14:00 UTC APAC: Wednesday 10 February, 00:30 UTC

Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting

Note that there is currently discussion about moving the US meeting 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