Jump to: navigation, search

Difference between revisions of "Documentation/WhatsUpDoc"

Line 18: Line 18:
 
==== Looking for older editions? ====
 
==== Looking for older editions? ====
 
You can see older newsletters here: [[Documentation/WhatsUpDoc_Archive]]
 
You can see older newsletters here: [[Documentation/WhatsUpDoc_Archive]]
 
= 10 March 2017 =
 
 
Team team team team team,
 
 
It's been a crazy few weeks since the PTG ramping up our goals for Pike! Big thanks to everyone who has really hit the ground running with our new set of objectives.
 
 
This week I have been helping out Ianeta with the High Availability Guide ToC plan, (which you can review here: https://review.openstack.org/#/c/440890/) and Rob Clark with the Security Guide plan (https://etherpad.openstack.org/p/sec-guide-pike). I have also been working alongside Brian and the nova team to unblock ourselves from a particularly nasty, critical, bug affecting the Install Guide. For more information: https://bugs.launchpad.net/openstack-manuals/+bug/1663485
 
 
Big thanks to Darren Chan who has been doing an awesome job for the last two weeks in keeping our bug list under control. We are down to an amazing 108 bugs in queue.
 
 
Next week, we have Ianeta who will be looking after the bug triage liaison role!
 
 
If you're sitting there thinking "bugs are for me, I really love triaging bugs!" well, you're in luck! We have a few spots open for the rest of the cycle: https://wiki.openstack.org/wiki/Documentation/SpecialityTeams#Bug_Triage_Team
 
 
== Progress towards Pike ==
 
 
* https://www.timeanddate.com/countdown/newyear?p0=24&msg=Pike+release&ud=1&font=slab
 
* Bugs closed in Pike: 32! You guys rock :)
 
 
== The Road to the Summit in Boston ==
 
 
The summit schedule has been announced!
 
* https://www.openstack.org/summit/boston-2017/summit-schedule/#day=2017-05-08
 
 
I will be representing the docs team at the summit for the new 'Project Update' session. For more information: https://www.openstack.org/summit/boston-2017/summit-schedule/global-search?t=Project+Update+-+Documentation
 
 
Let me know if you had any doc talks accepted!
 
 
== Speciality Team Reports ==
 
 
* API - Anne Gentle: One prominent change is that the Block Storage API v2 is now exactly replicated with v3 and so is now marked Deprecated. The list of all OpenStack APIs is now also here: https://developer.openstack.org/#api and you can see them based on support level here: https://developer.openstack.org/api-guide/quick-start/
 
* Configuration Reference and CLI Reference - Tomoyuki Kato: CLI Reference: NIL this week. Some bugs for the Config Ref and potential bug in the tooling.
 
* High Availability Guide - Ianeta Hutchinson: So we have this patch https://review.openstack.org/#/c/440890/13 to establish the new ToC for HA Guide. We are trying to move all content that is relevant in the current guide over to the new ToC. From there, we will be filing bugs to start collaboration with the OSIC DevOps team who have signed up to adopt-a-guide and will be helping to provide content as SME's.
 
* Hypervisor Tuning Guide - Blair Bethwaite: The Scientific-WG is considering proposing a hypervisor tuning + guide session for the Boston Forum though, so hopefully if that goes ahead it will create some renewed interest.
 
* Installation guides - Lana Brindley: Waiting to sort out the last couple of bugs before we branch, hopefully next week
 
* Networking Guide - John Davidge: Huge number of patches this week on the RFC 5737 fix[1] - thanks to caoyuan! Continued progress on replacing neutronclient commands with OSC versions. Thank you to all contributors. A patch[2] changing a documented use of ’tenant’ to ‘project’ sparked a discussion in the neutron team about the mixture of terminology in neutron, with the conclusion that all remaining references to ’tenant’ in our config files and elsewhere are to be replaced with ‘project’ as soon as possible. Some of these will require deprecation cycles. Impact on the networking guide should be minimal. [1] https://launchpad.net/bugs/1656378 [2] https://review.openstack.org/#/c/43816
 
* Operations and Architecture Design guides - Darren Chan: A patch to move the draft Arch Guide to docs.o.o has merged. The previous guide has been moved to a "to archive" directory until the archiving process is ready. The Arch Guide working group met this week to rearchitect and scope the design content. We're currently focussed on the storage content.
 
* Security Guide - Nathaniel Dillon: Rob Clark (PTL) and Alex are in the process of planning the ins and out of the overhaul of the guide. We're talking about dramatically reducing the scope, and introducing new, maintainable, content. Rob ( hyakuhei ) is also looking at getting a sprint in Austin at some point to get the security team all together and pump out some content. We also have the OSIC Security team pumping out some of the main, non-wishlist, bugs at preset
 
* Training Guides - Matjaz Pancur: N/A
 
* Training labs - Pranav Salunke, Roger Luethi: We have pushed the current state of the Ocata training-labs changeset in case others find it useful. The scripts follow the install-guide and
 
* https://review.openstack.org/#/c/438328/. The resulting cluster cannot launch instances because it fails to find a host (just like others following the install-guide have reported).
 
* User guides - Joseph Robinson: For the User and Admin Guides, I've been looping through the bug list - there are SDK bugs and the issue of moving the python SDK examples, which was discussed back in Newton. There are also two telemetry bugs, which I need to contact the liaisons for. The only other point, is reviewing the Admin Guide migration spec: https://review.openstack.org/#/c/439122/
 
 
== Doc team meeting ==
 
 
Our next meeting will be on Thursday, 23 March at 2100 UTC in #openstack-meeting-alt.
 
For more meeting details, including minutes and the agenda: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting
 
 
I am unavailable to be the meeting chair this week :( is someone able to host? Ping or email if you are able to help out!
 
 
--
 
 
Have a great weekend!
 
 
Alex
 
Fastest typer in the universe (2014) and expert cactus photographer
 
 
IRC: asettle
 
Twitter: dewsday
 
 
= 24 February 2017 =
 
 
Team team team team team,
 
 
Welcome to my second edition of What's up, Doc!
 
 
We have had an extremely busy week in Atlanta for the PTG. We had a really enthusiastic attendance and I am truly impressed by how much we have managed to get done. This newsletter will be a short one and focus on a small PTG update!
 
 
Our bug triager for the first 2 weeks of Pike is Darren Chan. Looking for more people to sign up and help out: https://wiki.openstack.org/wiki/Documentation/SpecialityTeams#Bug_Triage_Team 
 
 
== Progress towards Pike ==
 
 
Thanks to our amazing release managers, Maria, Brian and Lana for all their amazing hard work on the Ocata release. Big thanks to Anne for stepping in at the last minute!
 
 
* 44 days to go! https://www.timeanddate.com/countdown/newyear?p0=24&msg=Pike+release&ud=1&font=slab
 
 
== The Road to the Summit in Boston ==
 
 
Voting is now open for topics. You can find the list of topics here: https://www.openstack.org/summit/boston-2017/vote-for-speakers#/
 
I was able to find some documentation related topics. If anyone has any more topics I am unaware of, please reply to this email thread and share your talks!
 
 
Please vote for your fellow documenter below:
 
 
1. https://www.openstack.org/summit/boston-2017/vote-for-speakers#/17888
 
2. https://www.openstack.org/summit/boston-2017/vote-for-speakers#/18078
 
3. https://www.openstack.org/summit/boston-2017/vote-for-speakers#/17711
 
 
Event info is available here: http://www.openstack.org/ptg 
 
Purchase tickets here: https://pikeptg.eventbrite.com/ 
 
Tickets for the Boston summit: https://www.openstack.org/summit/boston-2017/
 
 
== PTG Update ==
 
 
We had a very successful PTG! Thanks to all those that were able to attend. Thanks to Ian Choi and the I18n team for being wonderful collaborators. We were able to get a lot done in our horizontal sessions. For anyone that is interested, here's our etherpad with all the notes from the sessions: https://etherpad.openstack.org/p/docs-i18n-ptg-pike
 
Here are a few of the exciting things to look out for in Pike:
 
 
1.      High Availability Guide improvements
 
a.      Adam Spiers and Ianeta Hutchinson will be leading the charge on the HA guide with a massive restructure and up-to-date new content.
 
2.      Reno release notes for OpenStack manuals
 
a.      Adam Spiers has been working alongside John Davidge and the Infra team to work on implementing the reno release notes process for documentation. Including looking at implementing new reno templates to work specifically for documentation!
 
3.      Networking Guide improvements and more collaboration with the neutron team.
 
a.      John Davidge has been working with the neutron team to develop the best way to ensure information flows into the guide. Discussions around the use of the DocImpact tag were successful.
 
4.      Administrator Guide changes! Keep your eye out for exciting developments.
 
a.      Ildiko Vancsa and Joseph Robinson will be working together to come up with a new specification to implement in Queens for our Administration Guide. Development teams have been enthusiastic about implementing the project-install-guide and are looking for similar structures with the Admin Guide. Stay tuned for more news here!
 
 
I had the opportunity to report back to meeting attendees yesterday afternoon, if anyone would like to know more, here are the meeting minutes: http://eavesdrop.openstack.org/meetings/docteam/2017/docteam.2017-02-23-20.59.log.txt 
 
 
== Doc team meeting ==
 
 
Our next meeting will be on Thursday 9 March at 2100 UTC in #openstack-meeting-alt.
 
 
Meeting chair will be me (Alexandra Settle - asettle)! \o/
 
 
For more meeting details, including minutes and the agenda: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting
 
 
--
 
 
Have a great weekend!
 
 
Alex
 
Lamp enthusiast and award winning marathon sleeper
 
 
IRC: asettle
 
Twitter: dewsday
 
 
= 10 February 2017 =
 
 
Team team team team team,
 
 
Welcome to my first edition of What's up, Doc!
 
 
Firstly, I just want to thank everyone who supported me when I announced I would like to run for manuals PTL. Although I ran the election uncontested (like the beginning of all good dictatorships), it was wonderful to receive messages of support from everyone. I’ve slowly been ramping up and getting used to the mass influx of emails. Turns out I’m really good at sending out emails with the incorrect time and/or date. Big thanks to Andreas for informing me the next 9th of January will be in 2020.
 
 
Without further ado, let's get down to business! We have a very short window now between Ocata and the start of Pike, and we still have quite a number of things left to achieve.
 
- If anyone has time to dedicate to Install Guide testing - please sign up (links below). Thanks to those who have already volunteered to help Lana out!
 
- As per my email yesterday, I'd love to see some people out there smashing bugs! (links also below, and more info in the meeting minutes from yesterday).
 
 
== Progress towards Ocata ==
 
 
* 12 days to go!
 
* Closed 256 bugs so far. We have 128 open bugs left: https://bugs.launchpad.net/openstack-manuals/+bugs
 
* Release tasks are being tracked here: https://wiki.openstack.org/wiki/Documentation/OcataDeliverables
 
* Install Guide testing is being tracked here: https://wiki.openstack.org/wiki/Documentation/OcataDocTesting
 
 
== The Road to PTG in Atlanta ==
 
 
Docs is a horizontal project, so our sessions will run across the Monday and Tuesday of the event. We will be combining the docs event with i18n, so translators and docs people will all be in the room together. Everyone welcome!
 
Conversation topics for Docs and i18n here: https://etherpad.openstack.org/p/docs-i18n-ptg-pike
 
 
Event info is available here: http://www.openstack.org/ptg
 
Purchase tickets here: https://pikeptg.eventbrite.com/
 
Tickets for the Boston summit: https://www.openstack.org/summit/boston-2017/
 
 
The CFP is now closed.
 
 
== Speciality Team Reports ==
 
 
API - Anne Gentle: The trove API docs are incomplete after migration, and a user reported the bug to the ML. Anne to log the missing clustering API info. Alex and Anne to meet with the app dev community manager at the Foundation to talk about goals for developer.openstack.org. The NFV Orchestration (tacker) team landed their API ref this week.
 
Configuration Reference and CLI Reference - Tomoyuki Kato: CLI Reference: Updated some CLI references. Added aodhclient. Config Reference: Start working on Ocata updates.
 
High Availability Guide - Ianeta Hutchinson: Sent a message to the ML looking for people interested in helping out on the HA guide for Pike. Planning for the PTG as I can’t attend.
 
Hypervisor Tuning Guide - Blair Bethwaite: N/A
 
Installation guides - Lana Brindley: Landing page review: https://review.openstack.org/#/c/425821/12. Install guide testing is well underway.
 
Networking Guide - John Davidge: Working on organising a Networking Guide working group with the neutron team at the PTG. Also been smashing bugs.
 
Operations and Architecture Design guides - Darren Chan: Darren and Ben are working on an action plan for the Arch Guide to be worked on during Pike to get the current draft guide published.
 
Security Guide - Nathaniel Dillon: Moved the sec-guide bugs to the sec team Launchpad. Sec and doc team to coordinate and come up with action plan for the future of the sec guide at the PTG.
 
Training Guides - Matjaz Pancur: N/A
 
Training labs - Pranav Salunke, Roger Luethi: Training-labs has a rough, but working Ocata patch. Issues we found are noted on the Etherpad as you requested. We should be able to release within a week or two after Ocata is official.
 
User guides - Joseph Robinson: The legacy command changes have gone through well this release, and the next steps is to check with the nova, neutron, cinder, and glance teams on the status of some specific project commands
 
 
== Doc team meeting ==
 
 
Our next meeting will be on Thursday 23 February at 2100 UTC in #openstack-meeting-alt. We will not be skipping the meeting in favor for the PTG as the docs sessions are on the Mon-Tues and I would love the opportunity to immediately report back to people who cannot attend.
 
 
Meeting chair will be me (Alexandra Settle - asettle)! \o/
 
 
For more meeting details, including minutes and the agenda: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting
 
 
--
 
 
Have a great weekend!
 
 
Alex
 
<br />
 
All round badass and supernaturally good potato peeler
 
<br />
 
<br />
 
IRC: asettle
 
<br />
 
Twitter: dewsday
 

Revision as of 16:49, 22 March 2017

Documentation Newsletters

This is where I draft the 'What's Up, Doc?' documentation newsletters. The newsletter is distributed every second 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 in the docs meeting every two weeks. If you are a speciality team leader and can't attend the meeting, please either send a proxy to the meeting, or email your report to the meeting chair ahead of time.

If you have something that you would like to add to the next newsletter, please add it here:

Looking for older editions?

You can see older newsletters here: Documentation/WhatsUpDoc_Archive