Jump to: navigation, search

Difference between revisions of "Documentation/WhatsUpDoc"

(15 July 2016)
Line 23: Line 23:
 
Hi everyone,
 
Hi everyone,
  
This week I'm pleased to report that the index page for the new Install <s>Guides</s> 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!
+
CFP for the Barcelona Summit closed this week, so I've been caught up in the flurry of talk submissions. I hope you got yours in on time! We have more Installation Tutorials going up all the time, with Designate now in progress. I'd also like to remind you all that we have instructions for creating your team's Install Tutorial in our Contributor Guide here: http://docs.openstack.org/contributor-guide/project-install-guide.html We'd love to get your feedback on that content!
  
 
== Progress towards Newton ==
 
== Progress towards Newton ==
  
89 days to go!
+
82 days to go!
  
Bugs closed so far: 256
+
Bugs closed so far: 280
 
 
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.
  
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 now closed. Best of luck to everyone who submitted a talk :)
  
 
== Speciality Team Reports ==
 
== Speciality Team Reports ==
Line 43: Line 41:
 
No report this week.
 
No report this week.
  
'''Install Guide: Lana Brindley'''
+
'''Install Tutorials: 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
+
Continued to publish new guides, Swift is now up, Designate is on review. Submitted Summit talk on this topic. Don't miss our insstructions for creating a new Install Tutorial:http://docs.openstack.org/contributor-guide/project-install-guide.html  Next meeting: 19 July 0600 UTC
  
 
'''Networking Guide: Edgar Magana'''
 
'''Networking Guide: Edgar Magana'''
No meeting this week. Keep trying to move documentation from other dispersed places to the networking guide.
+
No meeting this week.
  
 
'''Security Guide: Nathaniel Dillon'''
 
'''Security Guide: Nathaniel Dillon'''
Line 53: Line 51:
  
 
'''User Guides: Joseph Robinson'''
 
'''User Guides: Joseph Robinson'''
Adding the consistency notes to the work items wiki page. Team emails.
+
No report this week.
  
 
'''Ops Guide: Shilla Saebi'''
 
'''Ops Guide: Shilla Saebi'''
No report this week.
+
OpenStack ops guide reorg in progress & documented here: https://etherpad.openstack.org/p/ops-guide-reorg
 +
Added enterprise docs troubleshooting information to the Ops Guide
  
 
'''API Guide: Anne Gentle'''
 
'''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  
+
Keystone API sprint this week, details are here: https://etherpad.openstack.org/p/keystone-api-sprint Lance Bragstad is on FIRE!
New patch this week to migrate the ceilometer Telemetry API docs, please review:  https://review.openstack.org/334028 Thank you Khushbu!
+
Review these api-ref patchsets in progress: https://review.openstack.org/#/q/status:open+file:api-ref
Need another +2 from the swift team for their migration patch: https://review.openstack.org/#/c/312315/
+
Working on a plan for how to merge HTTP Status Code tables and Graham Hayes's patch to use the openstackdocstheme and Karen Bradshaw's overall API navigation in time for release, stay tuned.
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'''
Closed many bugs.
+
Got feedbacks from Dolph Matthews, thank you! Closed a few bugs. Updated some CLI reference.
Implementing common configuration sections for shared services and libraries.
 
Updated a few clients reference, and added solum client.
 
  
 
'''Training labs: Pranav Salunke, Roger Luethi'''
 
'''Training labs: Pranav Salunke, Roger Luethi'''
No report this week.
+
Many minor improvements to training-labs library scripts
 +
Finalzing PXE feature, still more work is required but the current patch should be in a state to be merged soon.
 +
Finalizing parser POC to parse install-guides to BASH for testing install guides and also auto-creation of guest side scripts for training-labs
  
 
'''Training Guides: Matjaz Pancur'''
 
'''Training Guides: Matjaz Pancur'''
No report this week.
+
Removed unused images for Training guides, improvements on Getting Started (core and optional services, link updates).
  
 
'''Hypervisor Tuning Guide: Blair Bethwaite
 
'''Hypervisor Tuning Guide: Blair Bethwaite
Line 80: Line 77:
  
 
'''UX/UI Guidelines: Michael Tullis, Rodrigo Caballero'''
 
'''UX/UI Guidelines: Michael Tullis, Rodrigo Caballero'''
Three out of the five personas have been created and are being reviewed.
+
No report this week.
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.
 
  
 
== Core Team Review ==
 
== Core Team Review ==
  
The core team have completed their review for July, and we would like to welcome Joseph Robinson to the openstack-doc-core team.
+
Regretfully, Diane Fleming is no longer a core team member. I'd like to thank Diane for all her contributions to our team. She's been a powerhouse core team member since well before I did my very first OpenStack patch, and I think it's fair to say that many of us wouldn't be here without Diane's support and guidance.
 
 
Joseph has been leading the User Guides speciality team for some time now, and has been a docs-specs-core as part of that role. Welcome to the larger core team, Joseph, we're really pleased to have you aboard :)
 
  
 
== Site Stats ==
 
== Site Stats ==
Line 99: Line 91:
 
Next meetings:
 
Next meetings:
  
The US meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-07-06
+
The APAC meeting was held this week (big thanks to Joseph for chairing that meeting in my absence!), you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-07-13
  
 
Next meetings:
 
Next meetings:
APAC: Wednesday 13 July, 00:30 UTC
 
 
US: Wednesday 20 July, 19:00 UTC
 
US: Wednesday 20 July, 19:00 UTC
 +
APAC: Wednesday 27 July, 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
 
Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting

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

15 July 2016

Hi everyone,

CFP for the Barcelona Summit closed this week, so I've been caught up in the flurry of talk submissions. I hope you got yours in on time! We have more Installation Tutorials going up all the time, with Designate now in progress. I'd also like to remind you all that we have instructions for creating your team's Install Tutorial in our Contributor Guide here: http://docs.openstack.org/contributor-guide/project-install-guide.html We'd love to get your feedback on that content!

Progress towards Newton

82 days to go!

Bugs closed so far: 280

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 now closed. Best of luck to everyone who submitted a talk :)

Speciality Team Reports

HA Guide: Bogdan Dobrelya No report this week.

Install Tutorials: Lana Brindley Continued to publish new guides, Swift is now up, Designate is on review. Submitted Summit talk on this topic. Don't miss our insstructions for creating a new Install Tutorial:http://docs.openstack.org/contributor-guide/project-install-guide.html Next meeting: 19 July 0600 UTC

Networking Guide: Edgar Magana No meeting this week.

Security Guide: Nathaniel Dillon No report this week.

User Guides: Joseph Robinson No report this week.

Ops Guide: Shilla Saebi OpenStack ops guide reorg in progress & documented here: https://etherpad.openstack.org/p/ops-guide-reorg Added enterprise docs troubleshooting information to the Ops Guide

API Guide: Anne Gentle Keystone API sprint this week, details are here: https://etherpad.openstack.org/p/keystone-api-sprint Lance Bragstad is on FIRE! Review these api-ref patchsets in progress: https://review.openstack.org/#/q/status:open+file:api-ref Working on a plan for how to merge HTTP Status Code tables and Graham Hayes's patch to use the openstackdocstheme and Karen Bradshaw's overall API navigation in time for release, stay tuned.

Config/CLI Ref: Tomoyuki Kato Got feedbacks from Dolph Matthews, thank you! Closed a few bugs. Updated some CLI reference.

Training labs: Pranav Salunke, Roger Luethi Many minor improvements to training-labs library scripts Finalzing PXE feature, still more work is required but the current patch should be in a state to be merged soon. Finalizing parser POC to parse install-guides to BASH for testing install guides and also auto-creation of guest side scripts for training-labs

Training Guides: Matjaz Pancur Removed unused images for Training guides, improvements on Getting Started (core and optional services, link updates).

Hypervisor Tuning Guide: Blair Bethwaite No report this week.

UX/UI Guidelines: Michael Tullis, Rodrigo Caballero No report this week.

Core Team Review

Regretfully, Diane Fleming is no longer a core team member. I'd like to thank Diane for all her contributions to our team. She's been a powerhouse core team member since well before I did my very first OpenStack patch, and I think it's fair to say that many of us wouldn't be here without Diane's support and guidance.

Site Stats

25% of our hits are coming from new (rather than returning) users.

Doc team meeting

Next meetings:

The APAC meeting was held this week (big thanks to Joseph for chairing that meeting in my absence!), you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-07-13

Next meetings: US: Wednesday 20 July, 19:00 UTC APAC: Wednesday 27 July, 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

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

8 July 2016

Hi everyone,

This week I'm pleased to report that the index page for the new Install Guides 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.

Core Team Review

The core team have completed their review for July, and we would like to welcome Joseph Robinson to the openstack-doc-core team.

Joseph has been leading the User Guides speciality team for some time now, and has been a docs-specs-core as part of that role. Welcome to the larger core team, Joseph, we're really pleased to have you aboard :)

Site Stats

25% of our hits are coming from new (rather than returning) users.

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

Next meetings: APAC: Wednesday 13 July, 00:30 UTC US: Wednesday 20 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