Jump to: navigation, search

Difference between revisions of "Documentation/WhatsUpDoc"

(8 July 2016)
Line 23: Line 23:
 
Hi everyone,
 
Hi everyone,
  
We're starting to see a real rush of projects publishing their Install Guides this week, which is really exciting! We're also working on getting the index page on docs.openstack.org up and running, so we should have that ready to go up by the time I'm writing this newsletter next week. Well done to all the docs people, and the cross-project liaisons who have been working hard to make this happen. It's great to see it all start to come together :)
+
This week I'm pleased to report that the index page for the new Install <s>Guides</a> Tutorials is up and running! We also had some lengthy discussions about the use of conditionalised formatting (with ``only``), so there were a few meaty topics to go through in the meeting this week. It's also been way too long since we last did a core team review, so that happened this week. I'd also like to remind you that the CFP for Barcelona is only open until mid next week, so get your proposals in soon! 
  
 
== Progress towards Newton ==
 
== Progress towards Newton ==
  
103 days to go!
+
89 days to go!
  
Bugs closed so far: 207
+
Bugs closed so far: 256
 +
 
 +
I think 50 bugs in two weeks is something of a record! Thanks to all the bug smashers working hard this week :)
  
 
Newton deliverables: https://wiki.openstack.org/wiki/Documentation/NewtonDeliverables
 
Newton deliverables: https://wiki.openstack.org/wiki/Documentation/NewtonDeliverables
 
Feel free to add more detail and cross things off as they are achieved throughout the release.
 
Feel free to add more detail and cross things off as they are achieved throughout the release.
  
Also, just a note that the CFP for Barcelona is open now, until 13 July. If you want to brainstorm some documentation-related ideas, please get in touch!
+
The CFP for Barcelona is open now, until 13 July. If you want to brainstorm some documentation-related ideas, please get in touch!
  
 
== Speciality Team Reports ==
 
== Speciality Team Reports ==
Line 42: Line 44:
  
 
'''Install Guide: Lana Brindley'''
 
'''Install Guide: Lana Brindley'''
Swift, Manila patches in progress. Petr is working on the index page: https://review.openstack.org/331704 Feedback requested! Next meeting: 5 July 0600 UTC
+
Index page is now up, needs some iteration to improve. Decided against using ``only`` for now (review after Newton), Manila patch to be updated. Next meeting: 19 July 0600 UTC
  
 
'''Networking Guide: Edgar Magana'''
 
'''Networking Guide: Edgar Magana'''
No report this week.
+
No meeting this week. Keep trying to move documentation from other dispersed places to the networking guide.
  
 
'''Security Guide: Nathaniel Dillon'''
 
'''Security Guide: Nathaniel Dillon'''
Line 51: Line 53:
  
 
'''User Guides: Joseph Robinson'''
 
'''User Guides: Joseph Robinson'''
No report this week.
+
Adding the consistency notes to the work items wiki page. Team emails.
  
 
'''Ops Guide: Shilla Saebi'''
 
'''Ops Guide: Shilla Saebi'''
Team is currently reviewing enterprise ops documentation to incorporate into the Ops Guide.  
+
No report this week.
Ops tasks are documented here: https://etherpad.openstack.org/p/ops-arch-tasks
 
OpenStack ops guide reorg in progress & documented here: https://etherpad.openstack.org/p/ops-guide-reorg
 
Members of the ops guide team are joining ops meetings to find volunteers
 
  
 
'''API Guide: Anne Gentle'''
 
'''API Guide: Anne Gentle'''
Progress ongoing on navigation for multiple OpenStack APIs: https://review.openstack.org/#/c/329508
+
Sign up on the etherpad to participate in a keystone Identity API sprint: https://etherpad.openstack.org/p/keystone-api-sprint
Working on lists of project's API references that don't use RST+YAML framework: http://lists.openstack.org/pipermail/openstack-docs/2016-June/008775.html
+
New patch this week to migrate the ceilometer Telemetry API docs, please review:  https://review.openstack.org/334028 Thank you Khushbu!
 +
Need another +2 from the swift team for their migration patch: https://review.openstack.org/#/c/312315/
 +
Updated patch in the governance repo projects.yaml file to indicate both contributor docs URLs and API docs URLs: https://review.openstack.org/#/c/316396/ Consider a work in progress for URL completeness and accuracy, but please review for format.
 +
Responding to input about API versions and release versions. See http://lists.openstack.org/pipermail/openstack-docs/2016-July/008818.html  
  
 
'''Config/CLI Ref: Tomoyuki Kato'''
 
'''Config/CLI Ref: Tomoyuki Kato'''
Got some comments for improvements from Brian Rosmaita, Hemanth Makkapati and Richard Jones. Thank you!
+
Closed many bugs.
Closed many bugs for Configuration Reference.
+
Implementing common configuration sections for shared services and libraries.
Updated openstack, glance, neutron-sanity-check, and trove-manage CLI reference.
+
Updated a few clients reference, and added solum client.
  
 
'''Training labs: Pranav Salunke, Roger Luethi'''
 
'''Training labs: Pranav Salunke, Roger Luethi'''
Webpage is looking good and also all the URL's point to the right link http://docs.openstack.org/training_labs/
+
No report this week.
Trying to finalize PXE support https://review.openstack.org/#/c/305991/
 
  
 
'''Training Guides: Matjaz Pancur'''
 
'''Training Guides: Matjaz Pancur'''
Italian translation of the Upstream training
+
No report this week.
Details about running a Lego session (https://review.openstack.org/#/c/325020/, https://review.openstack.org/#/c/330819/)
 
  
 
'''Hypervisor Tuning Guide: Blair Bethwaite
 
'''Hypervisor Tuning Guide: Blair Bethwaite
Line 80: Line 80:
  
 
'''UX/UI Guidelines: Michael Tullis, Rodrigo Caballero'''
 
'''UX/UI Guidelines: Michael Tullis, Rodrigo Caballero'''
No report this week.
+
Three out of the five personas have been created and are being reviewed.
 +
https://review.openstack.org/#/c/326662/
 +
The last two personas will be added to the change within the week.
 +
It was suggested to add a checklist for developers to be able to identify the appropriate persona for their work.
  
 
== Site Stats ==
 
== Site Stats ==

Revision as of 05:00, 8 July 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

Content Sources

Speciality team reports are gathered here: https://etherpad.openstack.org/p/Speciality_Team_Reports

  • Your
  • Content
  • Here

Looking for older editions?

You can see older newsletters here: Documentation/WhatsUpDoc_Archive

8 July 2016

Hi everyone,

This week I'm pleased to report that the index page for the new Install Guides</a> Tutorials is up and running! We also had some lengthy discussions about the use of conditionalised formatting (with ``only``), so there were a few meaty topics to go through in the meeting this week. It's also been way too long since we last did a core team review, so that happened this week. I'd also like to remind you that the CFP for Barcelona is only open until mid next week, so get your proposals in soon!

Progress towards Newton

89 days to go!

Bugs closed so far: 256

I think 50 bugs in two weeks is something of a record! Thanks to all the bug smashers working hard this week :)

Newton deliverables: https://wiki.openstack.org/wiki/Documentation/NewtonDeliverables Feel free to add more detail and cross things off as they are achieved throughout the release.

The CFP for Barcelona is open now, until 13 July. If you want to brainstorm some documentation-related ideas, please get in touch!

Speciality Team Reports

HA Guide: Bogdan Dobrelya No report this week.

Install Guide: Lana Brindley Index page is now up, needs some iteration to improve. Decided against using ``only`` for now (review after Newton), Manila patch to be updated. Next meeting: 19 July 0600 UTC

Networking Guide: Edgar Magana No meeting this week. Keep trying to move documentation from other dispersed places to the networking guide.

Security Guide: Nathaniel Dillon No report this week.

User Guides: Joseph Robinson Adding the consistency notes to the work items wiki page. Team emails.

Ops Guide: Shilla Saebi No report this week.

API Guide: Anne Gentle Sign up on the etherpad to participate in a keystone Identity API sprint: https://etherpad.openstack.org/p/keystone-api-sprint New patch this week to migrate the ceilometer Telemetry API docs, please review: https://review.openstack.org/334028 Thank you Khushbu! Need another +2 from the swift team for their migration patch: https://review.openstack.org/#/c/312315/ Updated patch in the governance repo projects.yaml file to indicate both contributor docs URLs and API docs URLs: https://review.openstack.org/#/c/316396/ Consider a work in progress for URL completeness and accuracy, but please review for format. Responding to input about API versions and release versions. See http://lists.openstack.org/pipermail/openstack-docs/2016-July/008818.html

Config/CLI Ref: Tomoyuki Kato Closed many bugs. Implementing common configuration sections for shared services and libraries. Updated a few clients reference, and added solum client.

Training labs: Pranav Salunke, Roger Luethi No report this week.

Training Guides: Matjaz Pancur No report this week.

Hypervisor Tuning Guide: Blair Bethwaite No report this week.

UX/UI Guidelines: Michael Tullis, Rodrigo Caballero Three out of the five personas have been created and are being reviewed. https://review.openstack.org/#/c/326662/ The last two personas will be added to the change within the week. It was suggested to add a checklist for developers to be able to identify the appropriate persona for their work.

Site Stats

The top five search terms on the site so far during June: snapshot, cinder, nova, security group, quota

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-06-22

Next meetings: APAC: Wednesday 29 June, 00:30 UTC US: Wednesday 6 July, 19: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

https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#8_July_2016