Jump to: navigation, search

Difference between revisions of "Documentation/WhatsUpDoc"

(Site Stats)
(Doc team meeting)
Line 100: Line 100:
 
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-08-17
+
The APAC meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-08-24
  
 
Next meetings:
 
Next meetings:
APAC: Wednesday 24 August, 00:30 UTC
 
 
US: Wednesday 31 August, 19:00 UTC
 
US: Wednesday 31 August, 19:00 UTC
 +
APAC: Wednesday 7 September, 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 03:03, 26 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
  • New openstackdoocstheme release - 1.5.0

Looking for older editions?

You can see older newsletters here: Documentation/WhatsUpDoc_Archive

26 August 2016

Hi everyone,

This week marks six weeks left to the Newton release, so I've been busy getting everything prepared. We're now ready to start testing the core Installation Tutorial, so check out the wiki and get signed up: https://wiki.openstack.org/wiki/Documentation/NewtonDocTesting#Testers We've also selected two new release managers to assist with this release, please welcome Olena and Alex! More on those topics in this newsletter.

Progress towards Newton

40 days to go!

Bugs closed so far: 387

Release planning: https://etherpad.openstack.org/p/NewtonRelease

Release Managers

There was an overwhelming response to my request for release managers, which was very cool! The first two responders were Olena Logvinova <ologvinova@mirantis.com> and Alexandra Settle <alexandra.settle@RACKSPACE.COM>, so please welcome them to the release team. Their main role during this process is to make sure that all the tasks we have to complete get done accurately and on schedule. It's an important job, and we're really glad to have you both on board.

Install Tutorial Testing

Install Tutorial testing is just about ready to kick off. If you're interested in helping, make sure you've added your name on to the list on our testing wiki page: https://wiki.openstack.org/wiki/Documentation/NewtonDocTesting (if you don't have wiki access, just email me directly and I'll add you in).

Thanks to our package maintainers, we now have b2 pre-release packages ready for Ubuntu and Debian, so those are ready to be tested.

Docs Tools

I'm very pleased to announce that we have now removed DocBook from our build tools. The end of an era! Thanks to Anne, Andreas, and David Cramer for keeping this project alive for so long, and eventually seeing it come to fruition.

Version 1.5.0 of openstackdoccstheme was released this week.

In other tools news, there are plans afoot to move developer.openstack.org and docs.openstack.org away from Rackspace Cloudsites, and on to pages that OpenStack Infra can control. This has been on the proverbial backburner for a long time, but the Infra team is now in a position to make it happen. You can read and comment on the Infra spec here: https://review.openstack.org/#/c/276482/

Speciality Team Reports

HA Guide: Andrew Beekhof No report this week.

Install Tutorials: Lana Brindley Core Guide testing is underway! Check out progress and sign up here: https://wiki.openstack.org/wiki/Documentation/MitakaDocTesting Next meeting: 30 August 0600UTC.

Networking Guide: Edgar Magana Attending the OpenStack East in NYC. No report this week.

Security Guide: Nathaniel Dillon No report this week.

User Guides: Joseph Robinson No report this week.

Ops Guide: Shilla Saebi, Darren Chan No report this week.

API Guide: Anne Gentle Releasing openstackdocstheme with new sidebar and integration with os-api-ref Sphinx Extension. Many thanks to Karen Bradshaw, Sean Dague, Graham Hayes, Andreas Jaeger (and anyone I may have missed!) for their tireless efforts on this release. WOW.

Config/CLI Ref: Tomoyuki Kato Merged some patches, updated a few CLI reference, nothing special.

Training labs: Pranav Salunke, Roger Luethi Some minor changes, backports of features. The parser is almost done. https://github.com/dguitarbite/rst2bash Updated the openstack-manuals, install-guides with the new syntax which is parser friendly. I should start sending the required patches to manuals repo. soon after finalizing the syntax.. https://github.com/dguitarbite/openstack-manuals/commit/c9e7e1bb2c7269f02a757768dd2dd309fa2233ac

Training Guides: Matjaz Pancur Upstream training improvement (https://etherpad.openstack.org/p/upstream-university-improvements). Please consider participating in the Remote content sprint (proposed timeframe: first half of September, see etherpad for details).

Hypervisor Tuning Guide: Blair Bethwaite No report this week.

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

Site Stats

Keystone and Ceph are this week's most popular search terms.

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-08-24

Next meetings: US: Wednesday 31 August, 19:00 UTC APAC: Wednesday 7 September, 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#26_August_2016

19 August 2016

Hi everyone,

Watch out, Install Guide testing season is about to begin! If you're a package maintainer, cross-project liaison, or just a helpful testing regular, look out for an email from me real soon now! In the meantime, keep hitting those bugs, and letting us know if you spot any problems in the guide.

Progress towards Newton

47 days to go!

Bugs closed so far: 371

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 Some reviews, nothing interesting

Install Tutorials: Lana Brindley Core Guide testing to kick off Real Soon Now (tm). Next meeting: 30 August 0600UTC.

Networking Guide: Edgar Magana No report this week.

Security Guide: Nathaniel Dillon No report this week.

User Guides: Joseph Robinson No report this week.

Ops Guide: Shilla Saebi, Darren Chan Reorganized monitoring content in the Ops Guide Migrating ops, legal, and security content in the Arch Guide Working on use cases chapter and design chapter in the Arch Guide

API Guide: Anne Gentle No report this week.

Config/CLI Ref: Tomoyuki Kato A few cleanups are under going. Updated some client references.

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

Site Stats

Just under 90,000 sessions on the docs site this week.

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-08-17

Next meetings: APAC: Wednesday 24 August, 00:30 UTC US: Wednesday 31 August, 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#19_August_2016

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!). Anne, however, has 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

This week, 385 visitors came to the docs site from Stack Overflow, 423 visitors came via searching on duckduckgo, and 508 came from ask.openstack.org.

Doc team meeting

Next meetings:

The APAC meeting failed to make quorum this week, but thanks to Darren for trying anyway :)

Next meetings: US: Wednesday 17 August, 19:00 UTC APAC: Wednesday 24 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