Revision as of 03:20, 2 September 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

OpenStack Docs Mailing List <Openstack-docs@lists.openstack.org>
OpenStack Development Mailing List <openstack-dev@lists.openstack.org>
Docs liaisons (from https://wiki.openstack.org/wiki/CrossProjectLiaisons#Documentation)
i18n List <openstack-i18n@lists.openstack.org>

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

2 September 2016

Hi everyone,

We have five weeks left until the Newton release goes out, so this week has been all about getting started on testing the Install Guide. We now have beta releases for all our distros, so thanks to our lovely package maintainers for getting back to me so quickly! We can still use more testers, though, all you need to do is sign up on the wiki page and start testing! https://wiki.openstack.org/wiki/Documentation/NewtonDocTesting

This week Andreas, Brian, Olga and I will be meeting with our new release managers Olena and Alex, to make sure they're up to speed. Don't forget that you contact any of us (or just send mail to the docs mailing list) if you have any questions about the Newton docs release.

Progress towards Newton

33 days to go!

Bugs closed so far: 407

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

The Road to Barcelona

If there's something you want to make sure we discuss at Summit, please put your ideas here: https://etherpad.openstack.org/p/Ocata-DocsSessions When we get our room allocations, I'll organise it into a schedule.
Talk acceptances have gone out, congratulations to everyone who got something accepted!
If you require a visa invitation letter to travel to Spain, then you need to fill out the form here: https://www.openstack.org/summit/barcelona-2016/travel/#visa

Docs Tools

There is a lot of cleanup happening on the docs site right now, so you might see some old and unloved content disappear. If you notice anything strange, please let Andreas or the docs mailing list know so we can get it straightened out.

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: 13 September 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 No meeting last week in light of the ops mid cycle and OpenStack East conference Updating use cases chapter in Arch Guide Looking for more enterprise troubleshooting docs to push upstream for the ops guide

API Guide: Anne Gentle New landing page for a collection of all API Reference docs and Guides in one place: https://review.openstack.org/#/c/361480/ Improvements to the sidebar link collection: https://review.openstack.org/#/c/362436/

Config/CLI Ref: Tomoyuki Kato Updated some CLI reference. Closed some bugs for Config Reference.

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

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#2_September_2016

@@ Line 24: / Line 24: @@
 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.
+We have five weeks left until the Newton release goes out, so this week has been all about getting started on testing the Install Guide. We now have beta releases for all our distros, so thanks to our lovely package maintainers for getting back to me so quickly! We can still use more testers, though, all you need to do is sign up on the wiki page and start testing! https://wiki.openstack.org/wiki/Documentation/NewtonDocTesting
+This week Andreas, Brian, Olga and I will be meeting with our new release managers Olena and Alex, to make sure they're up to speed. Don't forget that you contact any of us (or just send mail to the docs mailing list) if you have any questions about the Newton docs release.
 == Progress towards Newton ==
 days to go!
-Bugs closed so far: 387
+Bugs closed so far: 407
 Release planning: https://etherpad.openstack.org/p/NewtonRelease
-== Release Managers ==
+== The Road to Barcelona ==
-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.
+* If there's something you want to make sure we discuss at Summit, please put your ideas here: https://etherpad.openstack.org/p/Ocata-DocsSessions When we get our room allocations, I'll organise it into a schedule.
+* Talk acceptances have gone out, congratulations to everyone who got something accepted!
-== Install Tutorial Testing ==
+* If you require a visa invitation letter to travel to Spain, then you need to fill out the form here: https://www.openstack.org/summit/barcelona-2016/travel/#visa
-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.
+There is a lot of cleanup happening on the docs site right now, so you might see some old and unloved content disappear. If you notice anything strange, please let Andreas or the docs mailing list know so we can get it straightened out.
-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 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 ==
@@ Line 58: / Line 52: @@
 '''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.
+Core Guide testing is underway! Check out progress and sign up here: https://wiki.openstack.org/wiki/Documentation/MitakaDocTesting Next meeting: 13 September August 0600UTC.
 '''Networking Guide: Edgar Magana'''
-Attending the OpenStack East in NYC. No report this week.
+No report this week.
 '''Security Guide: Nathaniel Dillon'''
@@ Line 70: / Line 64: @@
 '''Ops Guide: Shilla Saebi, Darren Chan'''
-No report this week.
+No meeting last week in light of the ops mid cycle and OpenStack East conference
+Updating  use cases chapter in Arch Guide
+Looking for more enterprise troubleshooting docs to push upstream for the ops guide
 '''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.
+New landing page for a collection of all API Reference docs and Guides in one place: https://review.openstack.org/#/c/361480/
+Improvements to the sidebar link collection: https://review.openstack.org/#/c/362436/
 '''Config/CLI Ref: Tomoyuki Kato'''
-Merged some patches, updated a few CLI reference, nothing special.
+Updated some CLI reference. Closed some bugs for Config Reference.
 '''Training labs: Pranav Salunke, Roger Luethi'''
-Some minor changes, backports of features.
+No report this week.
-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).
+No report this week.
 '''Hypervisor Tuning Guide: Blair Bethwaite

Difference between revisions of "Documentation/WhatsUpDoc"