Jump to: navigation, search

Difference between revisions of "Documentation/WhatsUpDoc"

(→‎12 August 2016)
Line 23: Line 23:
 
Hi everyone,
 
Hi everyone,
  
−
A fairly quiet week this week, as I've been gradually working my way through old bugs. We're now only ten weeks out from release, so I've also been trying to tidy up some loose ends around the Contributor Guide. We have a couple of specs out for review right now, so if you're looking for some docs work to pick up, try checking these out: https://review.openstack.org/#/q/status:open+project:openstack/docs-specs,n,z
+
I have been struck down with flu yet again this week, so a quiet one from me (I'll be glad when winter is over, let me tell you!). Thanks to Darren for stepping in and looking after the APAC docs meeting for me while I was out. Anne has also been kicking it out of the park with her work on the API docs; I suggest you take a look at the update she sent to the mailing lists the other day to catch up: http://lists.openstack.org/pipermail/openstack-dev/2016-August/101380.html
  
 
== Progress towards Newton ==
 
== Progress towards Newton ==
  
−
68 days to go!
+
54 days to go!
  
−
Bugs closed so far: 339
+
Bugs closed so far: 365
  
 
Newton deliverables: https://wiki.openstack.org/wiki/Documentation/NewtonDeliverables
 
Newton deliverables: https://wiki.openstack.org/wiki/Documentation/NewtonDeliverables
Line 37: Line 37:
  
 
'''HA Guide: Andrew Beekhof'''
 
'''HA Guide: Andrew Beekhof'''
−
Informal discussions about appropriate contents and structure
+
No report this week.
  
 
'''Install Tutorials: Lana Brindley'''
 
'''Install Tutorials: Lana Brindley'''
−
Next meeting: 2 August 0600 UTC
+
Next meeting: 16 August 0600UTC
  
 
'''Networking Guide: Edgar Magana'''
 
'''Networking Guide: Edgar Magana'''
−
Guide re-organization patch has been merged: https://review.openstack.org/#/c/345110/
+
No report this week.
  
 
'''Security Guide: Nathaniel Dillon'''
 
'''Security Guide: Nathaniel Dillon'''
−
Performing full read-through and bug hunt
+
Bug hunt continued, all contributions are welcome, grammatical and technical alike! Focusing on the last half of the SecurityGuide, and the 'freshness' of code examples
−
Opened 5 new bugs
+
Threat analysis documentation and templates added
−
Currently looking at Neutron chapter
 
−
Incoming addition on rate-limiting and anti-DDoS (framework merged tonight (thanks Kato!) and additional details coming)
 
  
 
'''User Guides: Joseph Robinson'''
 
'''User Guides: Joseph Robinson'''
−
No report this week.
+
The Consistency and Editing patch is ready to merge, and just needs more reviews https://review.openstack.org/#/c/347641/ .
 +
Some pages in the User Guides are resulting in 404s (dashboard manage shares for example), and this bug is tracking the changes
 +
https://bugs.launchpad.net/openstack-manuals/+bug/1611792
 +
Thanks to Maria for taking on the file name changes to the User Guide, and Anne for also patching the Admin Guide file names!
  
 
'''Ops Guide: Shilla Saebi, Darren Chan'''
 
'''Ops Guide: Shilla Saebi, Darren Chan'''
−
Weekly Arch Guide working group meeting on Wednesday 20:00 UTC in progress.
+
Working on storage, networking, and compute sections in the Arch Guide.
−
Currently drafting the Design chapter and reusing existing content.  
+
Arch Guide working group proposed a series of short sprints, working in pairs as SME/writer. Dates TBD
−
Working on getting more enterprise docs uploaded and pushed upstream for ops guide
+
Waiting on enterprise ops documentation to migrate to the Ops Guide.
  
 
'''API Guide: Anne Gentle'''
 
'''API Guide: Anne Gentle'''
−
First App tutorial for the Shade SDK now moving out of draft state. Way to go Marcela Bonell and infra people who make this SDK possible.  
+
Ceilometer migrated content has landed! \o/ https://review.openstack.org/334028 Many thanks to Khushbu Parakh for sticking with it, and to Julien Danjou and Gordon Chung for accepting the (rather outdated) migrated content and taking responsiblity for it from now on.
−
Thank you to Kato Tomoyuki for deletions of the Image and Networking WADL files in api-site. This ongoing dedication and cleanup is super valuable and much appreciated.
+
Working on a template for http-status.yaml file that teams can use for new pretty HTTP Status code tables that just landed last week. https://review.openstack.org/#/c/351835/
 +
Ever closer to landing the API reference navigation. https://review.openstack.org/#/c/329508/
 +
Refer to status report on -dev and -docs mailing lists: http://lists.openstack.org/pipermail/openstack-dev/2016-August/101380.html
  
 
'''Config/CLI Ref: Tomoyuki Kato'''
 
'''Config/CLI Ref: Tomoyuki Kato'''
−
Reflecting comments from Stackers. Closed a few bugs for Configuration Reference. Working on the common configurations.
+
Closed a few bugs with mitaka backport.
  
 
'''Training labs: Pranav Salunke, Roger Luethi'''
 
'''Training labs: Pranav Salunke, Roger Luethi'''
Line 70: Line 73:
  
 
'''Training Guides: Matjaz Pancur'''
 
'''Training Guides: Matjaz Pancur'''
−
No report this week.
+
Updating Upstream training for the next OpenStack Summit (https://etherpad.openstack.org/p/upstream-university-improvements)
 +
Next meeting: Monday 15 August 1700 UTC in #openstack-meeting
  
 
'''Hypervisor Tuning Guide: Blair Bethwaite
 
'''Hypervisor Tuning Guide: Blair Bethwaite

Revision as of 04:33, 12 August 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

12 August 2016

Hi everyone,

I have been struck down with flu yet again this week, so a quiet one from me (I'll be glad when winter is over, let me tell you!). Thanks to Darren for stepping in and looking after the APAC docs meeting for me while I was out. Anne has also been kicking it out of the park with her work on the API docs; I suggest you take a look at the update she sent to the mailing lists the other day to catch up: http://lists.openstack.org/pipermail/openstack-dev/2016-August/101380.html

Progress towards Newton

54 days to go!

Bugs closed so far: 365

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.

Speciality Team Reports

HA Guide: Andrew Beekhof No report this week.

Install Tutorials: Lana Brindley Next meeting: 16 August 0600UTC

Networking Guide: Edgar Magana No report this week.

Security Guide: Nathaniel Dillon Bug hunt continued, all contributions are welcome, grammatical and technical alike! Focusing on the last half of the SecurityGuide, and the 'freshness' of code examples Threat analysis documentation and templates added

User Guides: Joseph Robinson The Consistency and Editing patch is ready to merge, and just needs more reviews https://review.openstack.org/#/c/347641/ . Some pages in the User Guides are resulting in 404s (dashboard manage shares for example), and this bug is tracking the changes https://bugs.launchpad.net/openstack-manuals/+bug/1611792 Thanks to Maria for taking on the file name changes to the User Guide, and Anne for also patching the Admin Guide file names!

Ops Guide: Shilla Saebi, Darren Chan Working on storage, networking, and compute sections in the Arch Guide. Arch Guide working group proposed a series of short sprints, working in pairs as SME/writer. Dates TBD Waiting on enterprise ops documentation to migrate to the Ops Guide.

API Guide: Anne Gentle Ceilometer migrated content has landed! \o/ https://review.openstack.org/334028 Many thanks to Khushbu Parakh for sticking with it, and to Julien Danjou and Gordon Chung for accepting the (rather outdated) migrated content and taking responsiblity for it from now on. Working on a template for http-status.yaml file that teams can use for new pretty HTTP Status code tables that just landed last week. https://review.openstack.org/#/c/351835/ Ever closer to landing the API reference navigation. https://review.openstack.org/#/c/329508/ Refer to status report on -dev and -docs mailing lists: http://lists.openstack.org/pipermail/openstack-dev/2016-August/101380.html

Config/CLI Ref: Tomoyuki Kato Closed a few bugs with mitaka backport.

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

Training Guides: Matjaz Pancur Updating Upstream training for the next OpenStack Summit (https://etherpad.openstack.org/p/upstream-university-improvements) Next meeting: Monday 15 August 1700 UTC in #openstack-meeting

Hypervisor Tuning Guide: Blair Bethwaite No report this week.

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

Site Stats

Just under 55% of our mobile visitors are using an Android operating system to access the site, while just under 40% of our mobile visitors are using iOS. A statistically insignificant 0.07% are still using their Blackberries ...

Doc team meeting

Next meetings:

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

Next meetings: US: Wednesday 3 August, 19:00 UTC APAC: Wednesday 10 August, 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#12_August_2016

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