Jump to: navigation, search

Difference between revisions of "Documentation/WhatsUpDoc"

(→‎6 February 2016)
Line 21: Line 21:
 
Hi everyone,
 
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 :)
+
A busy week here in docs, with today marking only two months left until Mitaka goes out. I've been working on the DocImpact script, the core team review, and a whole lot of general chasing things up and tidying around the place. I also note that the Installation Guide team is busy ramping up for Mitaka, so watch this space for your opportunity to jump into testing for that very soon. Next week, I'll be cleaning up the blueprints, and also starting to get in touch with our packaging contacts to get ready for release.
  
 
== Progress towards Mitaka ==
 
== Progress towards Mitaka ==
  
−
68 days to go!
+
60 days to go!
  
−
368 bugs closed so far for this release.
+
382 bugs closed so far for this release.
  
 
RST Conversions
 
RST Conversions
Line 33: Line 33:
  
 
Reorganisations
 
Reorganisations
−
* Arch Guide
+
* Arch Guide: really needs a last minute push to get this complete before Mitaka. If you can help out, it would be greatly appreciated!
 
** https://blueprints.launchpad.net/openstack-manuals/+spec/archguide-mitaka-reorg
 
** https://blueprints.launchpad.net/openstack-manuals/+spec/archguide-mitaka-reorg
 
** Contact the Ops Guide Speciality team: https://wiki.openstack.org/wiki/Documentation/OpsGuide
 
** Contact the Ops Guide Speciality team: https://wiki.openstack.org/wiki/Documentation/OpsGuide
Line 41: Line 41:
  
 
DocImpact
 
DocImpact
−
* After some discussion on the dev list, we're adjusting our approach to this problem. Watch this space.
+
* The implementation plan for the DocImpact script changed after we received feedback from Infra and Nova. Now, *all* projects (including the five 'defcore' projects) default to opening DocImpact bugs in their own bug queues. This change was proposed in https://review.openstack.org/#/c/276065/ and merged yesterday, very quickly!  Projects will now be able to determine for themselves how they would like to use the DocImpact script within their own groups, and hopefully the quality of bug reporting to docs will improve dramatically as a result of this. I'd like to thank all the PTLs, cross-project liaisons, project core team members, and especially the Infra and Nova teams for their assistance and patience while we worked through this knotty problem. I'm happy to be able to report that, as of today, this project is now complete.
  
 
== Speciality Teams ==
 
== Speciality Teams ==
Line 49: Line 49:
  
 
'''Installation Guide - Christian Berendt'''
 
'''Installation Guide - Christian Berendt'''
−
AODH install instructions merged
+
Mitaka Installation guide changes spec: https://review.openstack.org/#/c/274231/
  
 
'''Networking Guide - Edgar Magana'''
 
'''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
+
No update this week.
  
 
'''Security Guide - Nathaniel Dillon'''
 
'''Security Guide - Nathaniel Dillon'''
−
No update this week.
+
RST bug fixes and cleaning up of lingering migration issues. Looking for Neutron reviewers to see what is still accurate and what needs to be updated, please ping Nathaniel. Looking to setup PDF creation job.
  
 
'''User Guides - Joseph Robinson'''
 
'''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.
+
An action item from last meeting was addressed this week - working with new User Guide team members to continue reorganisation edits. Plans for an earlier, US+EU meeting, which would roll into an APAC meeting on Wedneday/Thursday fornightly meeting times are in place.
  
 
'''Ops and Arch Guides - Shilla Saebi'''
 
'''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.
+
Architecture guide reorganization is underway. We have a drafts repo in openstack-manuals, feel free to ping Shilla or Darren Chan if you are interested in helping out. Considering doing a swarm or work session at the summit in Austin for the Arch guide. Operations guide RST migration pending - conversations still happening to see which route we'll take. Still deciding if the ops guide should have another revision or edition, see ML emails.
  
 
'''API Docs - Anne Gentle'''
 
'''API Docs - Anne Gentle'''
−
No update this week.
+
Continuing to work on builds of Swagger plus RST.
  
 
'''Config Ref - Gauvain Pocentek'''
 
'''Config Ref - Gauvain Pocentek'''
Line 70: Line 70:
  
 
'''Training labs - Pranav Salunke, Roger Luethi'''
 
'''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.
+
Liberty support has been merged. The new default for training-labs clusters is the Liberty release.
  
 
'''Training Guides - Matjaz Pancur'''
 
'''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/.
+
Removal of redundant Jenkins jobs (gate-training-guides-tox-slides) and tox targets. Upstream training archives (http://docs.openstack.org/upstream-training/upstream-archives.html) are now separated from the main landing page.
  
 
'''Hypervisor Tuning Guide - Joe Topjian'''
 
'''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
+
No update this week.
 +
 
 +
'''UX/UI Docs Guidelines - Linette Williams'''
 +
Collaboration between the UX project and Doc project. The first UI text guidelines are live: http://docs.openstack.org/contributor-guide/ui-text-guidelines.html. Enhancements to guidelines in progress - specifically related to icons and text formatting. Text reviews are ongoing for new UI prototypes, as applicable. If interested in helping with UI panel reviews or with UI text guidelines,  feel free to ping Linette or Piet Kruithof.
  
 
== Doc team meeting ==
 
== Doc team meeting ==
  
 
Next meetings:
 
Next meetings:
−
US: Wednesday 3 February, 14:00 UTC
+
 
 +
The US meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-01-20
 +
 
 +
Next meetings:
 
APAC: Wednesday 10 February, 00:30 UTC
 
APAC: Wednesday 10 February, 00:30 UTC
 +
US: Wednesday 17 February, 14:00 UTC
  
 
Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting
 
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
+
Note that there is currently discussion about moving the US meeting to 20:00 UTC. A patch is open to change this, with ongoing discussion about finding a meeting room: https://review.openstack.org/#/c/271361/
  
 
--
 
--

Revision as of 04:06, 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

6 February 2016

Hi everyone,

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

Progress towards Mitaka

60 days to go!

382 bugs closed so far for this release.

RST Conversions

  • All planned RST conversions are now complete!

Reorganisations

DocImpact

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

Speciality Teams

HA Guide - Bogdan Dobrelya No update this week.

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

Networking Guide - Edgar Magana No update this week.

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

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

Ops and Arch Guides - Shilla Saebi Architecture guide reorganization is underway. We have a drafts repo in openstack-manuals, feel free to ping Shilla or Darren Chan if you are interested in helping out. Considering doing a swarm or work session at the summit in Austin for the Arch guide. Operations guide RST migration pending - conversations still happening to see which route we'll take. Still deciding if the ops guide should have another revision or edition, see ML emails.

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

Config Ref - Gauvain Pocentek No update this week.

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

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

Hypervisor Tuning Guide - Joe Topjian No update this week.

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

Doc team meeting

Next meetings:

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

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

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

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

--

Keep on doc'ing!

Lana

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