[openstack-dev] [openstack-docs] [dev] What's up, doc?

[Alexandra Settle]

Team team team team team,

Well the last month has just FLOWN by since the PTG. We've got plenty going on 
in the doc team...

This week I have been helping out the security team with the Security Guide. 
We've been working on some cursory edits, and removal of content. A few patches 
have already made it through - thanks to the OSIC security team for tackling 
some of the outstanding bugs. There'll be more edits coming from me in the next 
few weeks. To see our planning: https://etherpad.openstack.org/p/sec-guide-pike
I am also in the process of drafting a governance tag for our install guides. 
Would be great for everyone to review and understand what the process will 
involve: https://review.openstack.org/#/c/445536/

Shoutout and big thanks to Brian Moss and the nova team who worked together 
tirelessly to document Nova v2 Cells and Placement API - which was a massive 
blocker for our Installation Guide.

Also, thank you to our Ocata release managers, Maria Zlatkova and Brian Moss 
for cutting the branch! Pike is well and truly underway now.

Ianeta Hutchinson has done an awesome job for the last two weeks in keeping our 
bug list under control. We are down to an amazing 104 bugs in queue, and 59 
bugs closed this cycle already! Next week, we have Lana 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

== The Road to the Summit in Boston ==

* Schedule has been released: 
https://www.openstack.org/summit/boston-2017/summit-schedule/
* Docs and I18n have a project onboarding room at the summit, keep an eye out 
on the dev ML for more information. Kendall will inform us when the time comes. 
Anyone around to help me with that? 
http://lists.openstack.org/pipermail/openstack-dev/2017-March/114149.html
* Docs project update will be delivered by me (asettle) on Mon 8, 
3:40pm-4:20pm. 
https://www.openstack.org/summit/boston-2017/summit-schedule/global-search?t=Alexandra+Settle

== Specialty Team Reports ==

* API - Anne Gentle: There's still a lot of discussion on 
https://review.openstack.org/#/c/421846/ which is about API change guidelines. 
Take a look and join in on the review. Also on the openstack-dev list, there's 
a thread about the future of the app catalog, which is relevant to the app 
developer audience so I include it here: 
http://lists.openstack.org/pipermail/openstack 
dev/2017-March/113362.html
 Also related to the app dev audience is the wrapping up of the App Ecosystem 
working group: 
http://lists.openstack.org/pipermail/user-committee/2017-March/001825.html

* Configuration Reference and CLI Reference - Tomoyuki Kato: N/A

* High Availability Guide - Ianeta Hutchinson: At the Atlanta PTG, the 
documentation team outlined a new table of contents that is now upstream as a 
draft here: 
https://github.com/openstack/openstack-manuals/tree/master/doc/ha-guide-draft. 
A blocker to progress in the past had been a lack of SME’s for the topic of 
high availability but that is no longer the case \o/. The OSIC DevOps team has 
an “adopt-a-guide” project in which they are collaborating with the OpenStack 
docs community and OSIC Docs team to apply the new ToC and validate all content 
for the guide. The progress of this collaboration is being tracked here 
https://docs.google.com/spreadsheets/d/1hw4axU2IbLlsjKpz9_EGlKQt0S6siViik7ETjNg_MgI/edit?usp=sharing
 We are calling for more contributors both as SME's and tech writers. Ping 
iphutch if interested!

* Hypervisor Tuning Guide - Blair Bethwaite: N/A

* Installation guides - Lana Brindley: Cells bug is closer to being fixed, and 
we are closer to a complete test install 
https://wiki.openstack.org/wiki/Documentation/OcataDocTesting look at all that 
green!). We're planning to branch Ocata by the end of this week.

* Networking Guide - John Davidge: N/A

* Operations and Architecture Design guides - Darren Chan: Arch Design Guide: 
Minor IA and general cleanup of the storage, compute, and networking sections 
in the Design chapter. Currently updating gaps in storage design content. Ops 
Guide: Removed cloud architecture content (migrated to the Arch Design Guide).

* Security Guide - Nathaniel Dillon: Edits from Alex going through, and patches 
from the OSIC DevOps team. See above for more info.

* Training Guides - Matjaz Pancur: For Training guides, related topics: a new 
brand for activities around OpenStack Upstream University/Training. It is now 
known as OpenStack Upstream Institute 
(https://wiki.openstack.org/wiki/OpenStack_Upstream_Institute)

* Training labs - Roger Luethi: We are currently testing our automated version 
of the Ocata install-guide. We had a problem with Ubuntu's new ISO image 
(16.04.2 LTS) which is now 

[openstack-dev] [openstack-docs] [dev] What's up, doc?

[Alexandra Settle]

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=Pike+release=1=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: N/A

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).

Admin and User guides - Joseph Robinson: For the User and Admin Guides, I've 
been looping through the 

[openstack-dev] [openstack-docs] [dev] What's up, Doc?

[Alexandra Settle]

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=Pike+release=1=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
__
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev