Jump to: navigation, search

Difference between revisions of "Documentation/WhatsUpDoc"

(Site Stats)
m
 
(84 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
= Documentation Newsletters =
 
= 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:
+
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 ====
 
==== Distribution List ====
* OpenStack Docs Mailing List <Openstack-docs@lists.openstack.org>
 
 
* OpenStack Development Mailing List <openstack-dev@lists.openstack.org>
 
* OpenStack Development Mailing List <openstack-dev@lists.openstack.org>
 
* Docs liaisons (from https://wiki.openstack.org/wiki/CrossProjectLiaisons#Documentation)
 
* Docs liaisons (from https://wiki.openstack.org/wiki/CrossProjectLiaisons#Documentation)
Line 10: Line 9:
 
==== Content Sources ====
 
==== Content Sources ====
  
Speciality team reports are gathered here: https://etherpad.openstack.org/p/Speciality_Team_Reports
+
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.
  
* Your
+
If you have something that you would like to add to the next newsletter, please add it here:
* Content
+
 
* Here
+
*  
  
 
==== 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]]
  
= 24 June 2016 =
+
= 7 April 2017 =
 
 
Hi everyone,
 
  
We're starting to see a real rush of projects publishing their Install Guides this week, which is really exciting! We're also working on getting the index page on docs.openstack.org up and running, so we should have that ready to go up by the time I'm writing this newsletter next week. Well done to all the docs people, and the cross-project liaisons who have been working on hard to make this happen. It's great to see it all start to come together :)
+
Team,
  
== Progress towards Newton ==
+
This week I have still been working on drafting a governance tag for our guides called "docs:follows-policy". I have been working with Doug Hellmann (dhellmann) in the last week to change to draft dramatically, so it would be good for docs people to review again. We are trying to make this a more broad tag now, so it can be applied for other guides too. To review: https://review.openstack.org/#/c/445536/ I am also in the process of documenting guidelines in our Contribution Guide - which would also benefit from doc reviews:  https://review.openstack.org/#/c/453642/
  
103 days to go!
+
Would like to call out and thank John Davidge for his awesome work with the Networking Guide and neutron-related patches. He's been providing valuable guidance, and reviews, and it has been greatly appreciated by myself and the team.
  
Bugs closed so far: 207
+
Lana Brindley has done an awesome job for the last two weeks in keeping our bug list under control. We are down to an amazing 102 bugs in queue, and 82 bugs closed this cycle already!
 +
Next week, I 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 one spot open for the rest of the cycle (14 Aug - 28 Aug): https://wiki.openstack.org/wiki/Documentation/SpecialityTeams#Bug_Triage_Team
  
Newton deliverables: https://wiki.openstack.org/wiki/Documentation/NewtonDeliverables
+
== The Road to the Summit in Boston ==
Feel free to add more detail and cross things off as they are achieved throughout the release.
 
  
Also, just a note that the CFP for Barcelona is open now, until 13 July. If you want to brainstorm some documentation-related ideas, please get in touch!
+
Keep an eye out for the docs and I18n have a project onboarding room at the summit. Melvin Hillsman (mrhillsman) of the User Committee submitted a forum topic for the Ops Guide to get operator feedback.
 +
David Flanders from the Foundation has also proposed a forum topic for developer.openstack.org (which currently houses our API, SDK, and other dev stuff). We'll be discussing major changes to that and would like to see some feedback from people here. Any questions on that, shoot it my way. My main objective for this forum topic is to reduce our current technical debt that lives on this site.
 +
For more information on forum topics: https://wiki.openstack.org/wiki/Forum
 +
Schedule has been released: https://www.openstack.org/summit/boston-2017/summit-schedul
  
 
== Speciality Team Reports ==
 
== Speciality Team Reports ==
  
'''HA Guide: Bogdan Dobrelya'''
+
* API - Anne Gentle: API versioning in relation to release versioning is currently manually compiled for the 40-ish API services, so ideas on how to automate and surface that info welcomed. More info: http://lists.openstack.org/pipermail/openstack-dev/2017-March/114690.html
No report this week.
+
* Configuration Reference and CLI Reference - Tomoyuki Kato: N/A
 
+
* High Availability Guide - Ianeta Hutchinson: We are continuing to collaborate with OS DevOps team. See the tag ha-guide-draft for bugs opened to fill content for the new guide.
'''Install Guide: Lana Brindley'''
+
* Hypervisor Tuning Guide - Blair Bethwaite: N/A
Swift, Manila patches in progress. Petr is working on the index page: https://review.openstack.org/331704 Feedback requested! Next meeting: 5 July 0600 UTC
+
* Installation guides - Lana Brindley: We have now branched, so please remember to backport if you have edits to the Ocata guide now. Big thanks to all the testers who have been working hard over the past month or two (that Nova cells bug was *tough*!), and to Brian and Mariia for doing the heavy lifting. Noticed a bunch links to draft versions of the guide in Newton/Ocata branches, backports for that have been merged, and the Contributor Guide updated so we don't miss it in the future (https://docs.openstack.org/contributor guide/release/taskdetail.html#update-links-in-all-books).
 
+
* Networking Guide - John Davidge: More patches landed in the last couple of weeks dealing with the move to OSC, and more are still in flight. Progress also continues on RFC 5737 compliance. Thanks to all contributors for their work.
'''Networking Guide: Edgar Magana'''
+
* Operations and Architecture Design guides - Darren Chan: Arch Guide: edited architecture considerations content and cleaned up the index page structure which was applied across OS manuals. Some ops-related content was moved to the Ops Guide. Our current focus is improving the storage design content and networking design content.
No report this week.
+
* Training Guides - Matjaz Pancur: N/A
 
+
* Training labs - Roger Luethi: We released the Ocata version of training-labs this week.
'''Security Guide: Nathaniel Dillon'''
+
* User guides - Joseph Robinson: For the user guides - the spec on migrating the Admin Guide content this week moved closer to merging. I started preparing the work items for action on the User Guides tasks wiki page.
No report this week.
+
* Theme and Tools - Brian Moss: Anne has a spec up for theme consolidation, please check it out: https://review.openstack.org/#/c/454346/, Brian has fixed up the sitemap tool tests, reviews welcome: https://review.openstack.org/#/c/453976/. 41 open bugs, 13 closed in Pike
 
 
'''User Guides: Joseph Robinson'''
 
No report this week.
 
 
 
'''Ops Guide: Shilla Saebi'''
 
Team is currently reviewing enterprise ops documentation to incorporate into the Ops Guide.  
 
Ops tasks are documented here: https://etherpad.openstack.org/p/ops-arch-tasks
 
OpenStack ops guide reorg in progress & documented here: https://etherpad.openstack.org/p/ops-guide-reorg
 
Members of the ops guide team are joining ops meetings to find volunteers
 
 
 
'''API Guide: Anne Gentle'''
 
Progress ongoing on navigation for multiple OpenStack APIs: https://review.openstack.org/#/c/329508
 
Working on lists of project's API references that don't use RST+YAML framework: http://lists.openstack.org/pipermail/openstack-docs/2016-June/008775.html
 
 
 
'''Config/CLI Ref: Tomoyuki Kato'''
 
Got some comments for improvements from Brian Rosmaita, Hemanth Makkapati and Richard Jones. Thank you!
 
Closed many bugs for Configuration Reference.
 
Updated openstack, glance, neutron-sanity-check, and trove-manage CLI reference.
 
 
 
'''Training labs: Pranav Salunke, Roger Luethi'''
 
Webpage is looking good and also all the URL's point to the right link http://docs.openstack.org/training_labs/
 
Trying to finalize PXE support https://review.openstack.org/#/c/305991/
 
 
 
'''Training Guides: Matjaz Pancur'''
 
Italian translation of the Upstream training
 
Details about running a Lego session (https://review.openstack.org/#/c/325020/, https://review.openstack.org/#/c/330819/)
 
 
 
'''Hypervisor Tuning Guide: Blair Bethwaite
 
No report this week.
 
 
 
'''UX/UI Guidelines: Michael Tullis, Rodrigo Caballero'''
 
No report this week.
 
 
 
== Site Stats ==
 
 
 
The top five search terms on the site so far during June: snapshot, cinder, nova, security group, quota
 
  
 
== Doc team meeting ==
 
== Doc team meeting ==
 +
 +
Our next meeting will be on Thursday, 20 April at 2100 UTC in #openstack-meeting-alt.
 +
For more meeting details, including minutes and the agenda: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting
 +
The meeting chair will be me!
  
Next meetings:
+
Big thanks to Joseph for stepping up in the last 2 meetings and hosting in my absence! Really appreciated it :)
 
 
The US meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-06-22
 
 
 
Next meetings:
 
APAC: Wednesday 29 June, 00:30 UTC
 
US: Wednesday 6 July, 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
 
  
 
--
 
--
 +
 +
Have a great week :)
 +
 +
Alex
  
Keep on doc'ing!
+
IRC: asettle
 +
Twitter: dewsday
  
Lana
+
= 27 March 2017 =
  
https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#24_June_2016
+
Team team team team team,
  
= 17 June 2016 =
+
Well the last month has just FLOWN by since the PTG. We've got plenty going on in the docs team...
  
Hi everyone,
+
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/
  
This week I've very pleased to announce that we have our first project-specific Install Guide published! Petr Kovar got Heat over the line in first place, and it's looking great:  http://docs.openstack.org/project-install-guide/orchestration/draft/index.html Well done Petr, and of course all the wonderful docs people who helped us get to this point. We're also expecting to see Trove published very soon. I've been using the lessons learned from these early projects to flesh out our instructions a little more, so it should be even easier for projects to get their Install Guides up and running. We still need to create the central index, but it's all starting to come together now.
+
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.
  
I'm also excited to announce that, for the very first time, we have a specific Ops Cross-Project Liaison. Please welcome Robert Starmer to the CPL family :)
+
Also, thank you to our Ocata release managers, Maria Zlatkova and Brian Moss for cutting the branch! Pike is well and truly underway now.
  
== Progress towards Newton ==
+
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!
  
110 days to go!
+
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
  
Bugs closed so far: 185
+
== The Road to the Summit in Boston ==
  
Newton deliverables: https://wiki.openstack.org/wiki/Documentation/NewtonDeliverables
+
* Schedule has been released: https://www.openstack.org/summit/boston-2017/summit-schedule/
Feel free to add more detail and cross things off as they are achieved throughout the release.
+
* 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
Also, just a note that the CFP for Barcelona is open now, until 13 July. If you want to brainstorm some documentation-related ideas, please get in touch!
 
  
 
== Speciality Team Reports ==
 
== Speciality Team Reports ==
  
'''HA Guide: Bogdan Dobrelya'''
+
* 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
No report this week.
+
* 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!
'''Install Guide: Lana Brindley'''
+
* Hypervisor Tuning Guide - Blair Bethwaite: N/A
Orchestration is done! Well done, Petr :) Working on updating instructions in the Contributor Guide. Instructions: http://docs.openstack.org/contributor-guide/project-install-guide.html Next meeting: Tue 21 June 0600 UTC
+
* 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/NewtonDocTesting look at all that green!). We're planning to branch Ocata by the end of this week.
 
+
* Networking Guide - John Davidge: N/A
'''Networking Guide: Edgar Magana'''
+
* 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).
No report this week.
+
* 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)
'''Security Guide: Nathaniel Dillon'''
+
* 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 resolved.
No report this week.
+
* User guides - Joseph Robinson: Several other Legacy commands were converted to OS commands this week. Reviewed the Admin Guide spec.
 
+
* Theme and Tools - Brian Moss: I'd like to do an openstackdocstheme release soon, as we've got some items (PDF styling, search page JS fix, image centering) that would be good to have in production. Any concerns or last minute items to merge please let me know. We've had some issues come up with the auto-generation scripts. Some have been fixed already (thanks Kato and Christian!), and we're investigating others. If you notice anything amiss or would like to help out, please let me know. 46 open bugs, 8 closed in Pike
'''User Guides: Joseph Robinson'''
 
Began a consistency and IA plan, and held the US meeting. Emailing one new interested contributor.
 
 
 
'''Ops Guide: Darren Chan'''
 
Some architecture content moved from the Ops Guide to the draft Arch Guide. Patches will be submitted to remove old content from the Ops Guide. Team is currently reviewing enterprise ops documentation to incorporate into the Ops Guide.
 
 
 
'''API Guide: Anne Gentle'''
 
Check out all the open reviews for api-ref: https://review.openstack.org/#/q/status:open+file:api-ref Nice.
 
Went to weekly team meeting for swift, landed build patch for swift's api-ref, responding to reviews.
 
Noodling with Karen Bradshaw about API navigation, https://review.openstack.org/#/c/329508/ (though I can't take any credit for the work!)
 
 
 
'''Config/CLI Ref: Tomoyuki Kato'''
 
Closed many bugs continuously. Started working on the common configurations for shared services and libraries.
 
 
 
'''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, Stephen Ballard'''
 
No report this week.
 
 
 
== Training Guides/Labs Core Team Changes ==
 
 
 
We've adjusted the training guides and labs core teams so that speciality team leads are core in their own repos, and the docs core team is an 'included group' in both repos. This is intended to stop the core teams for these groups drifting out of date too quickly. Note that it is expected that docs cores will not be the primary reviewers/mergers for training repos, but are there as backup in case extra eyes are needed. That responsibility will continue to lie with the training teams themselves, as they know the codebase the best.  
 
 
 
You can see the updated core team lists here:
 
Training Guides: https://review.openstack.org/#/admin/groups/uuid-3490bf37012cb344104cb315f3dd5c76dabea62f,members
 
Training Labs: https://review.openstack.org/#/admin/groups/1118,members
 
 
 
== Site Stats ==
 
 
 
During May the top viewed book was the Mitaka Ubuntu Install Guide, followed closely by the Mitaka RDO Install Guide. Rolling into third place was the Admin Guide.  
 
 
 
Also, apologies for an error I made in this section last week. The correct number for the total number of views in May was 2,365,626.
 
  
 
== Doc team meeting ==
 
== Doc team meeting ==
 
+
Next meetings:
+
Our next meeting will be on Thursday, 7 April at 2100 UTC in #openstack-meeting-alt.
 
+
For more meeting details, including minutes and the agenda: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting
The APAC meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-06-15
 
 
 
Next meetings:
 
US: Wednesday 22 June, 19:00 UTC
 
APAC: Wednesday 29 June, 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
 
  
 
--
 
--
 +
 +
Have a great week :)
 +
 +
Alex
  
Keep on doc'ing!
+
IRC: asettle
 
+
Twitter: dewsday
Lana
 
 
 
https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#17_June_2016
 
 
 
= 10 June 2016 =
 
 
 
Hi everyone,
 
 
 
My week has been spent on the Install Guide, and a big thanks to Andreas for getting the Infra patch up and documenting the new process. The Install Guide team meeting was well attended this week, and I've been following up on the actions from that. I also contacted the cross project liaisons with the information they need to get their content moved, and I'm looking forward to seeing some of these start work next week.
 
 
 
In other news, Joseph has been busy reviewing the User Guides, and could use a little help working on the information architecture, and getting a few new projects documented. User Guide meetings are held in US and APAC timezones and volunteers are essential to get this effort complete for Newton. Get all the info here: https://wiki.openstack.org/wiki/User_Guides
 
 
 
== Progress towards Newton ==
 
 
 
117 days to go!
 
 
 
Bugs closed so far: 163
 
 
 
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: Bogdan Dobrelya'''
 
No report this week.
 
 
 
'''Install Guide: Lana Brindley'''
 
Infra patch: https://review.openstack.org/#/c/326039/ Instructions: http://docs.openstack.org/contributor-guide/project-install-guide.html Next meeting: Tue 21 June 0600 UTC
 
 
 
'''Networking Guide: Edgar Magana'''
 
No meeting this week. Working on a better ToC for the guide that may impact of the of scenarios.
 
Moving more networking content from other guides into the Networking one in order to keep everything in one central point and better updated.
 
 
 
'''Security Guide: Nathaniel Dillon'''
 
No report this week.
 
 
 
'''User Guides: Joseph Robinson'''
 
Outstanding Tasks - Contacting more project teams for inclusion status, IA plans for the new guide. Some team discussion on fixing old links - contact me if anyone is interested in contributing more content to the User Guides team.
 
 
 
'''Ops Guide: Shilla Saebi'''
 
Ops tasks are documented here: https://etherpad.openstack.org/p/ops-arch-tasks OpenStack ops guide reorg in progress & documented here: https://etherpad.openstack.org/p/ops-guide-reorg Working on posting enterprise docs for cleanup. Looking for volunteers in ops/arch docs group to attend ops specific meetings to find additional info and help.
 
 
 
'''API Guide: Anne Gentle'''
 
Call for help for unified all-OpenStack API navigation design: http://lists.openstack.org/pipermail/openstack-docs/2016-June/008730.html
 
Discussing project-level organization in  https://review.openstack.org/312259
 
Discussing source organization in  https://review.openstack.org/314819
 
Redirects and deletions in api-site are welcomed! For example, see https://review.openstack.org/327399
 
Updated README for api-site: https://review.openstack.org/327395
 
 
 
'''Config/CLI Ref: Tomoyuki Kato'''
 
Closed a few bugs continuously. Cleaned up many bugs about tool-generated configuration options that are already released for Mitaka. **We need folks for vendor plug-in docs from each vendor.**
 
 
 
'''Training labs: Pranav Salunke, Roger Luethi'''
 
Working on the training-labs landing page to make it look much better. Reintroducing the tooling to build zip files. Working on PXE support for baremetal provisioning. Working on Python port of training-labs.
 
 
 
'''Training Guides: Matjaz Pancur'''
 
No report this week.
 
 
 
'''Hypervisor Tuning Guide: Blair Bethwaite
 
No report this week.
 
 
 
'''UX/UI Guidelines: Michael Tullis, Stephen Ballard'''
 
No report this week.
 
 
 
== Site Stats ==
 
 
 
During May, the docs.openstack.org site had 620 sessions, with just under 20% by new users. The average time of all sessions for the month was about 5 and a half minutes, looking at an average of 3 and a half pages.
 
 
 
== 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-06-08
 
 
 
Next meetings:
 
APAC: Wednesday 15 June, 00:30 UTC
 
US: Wednesday 22 June, 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#10_June_2016
 
 
 
= 3 June 2016 =
 
 
 
Hi everyone,
 
 
 
I'm very pleased to be able to announce the results of our Install Guide naming poll this week. We ended up with 31 responses, and a very clear winner in "OpenStack Installation Tutorial". Thank you to everyone who voted! Also, just a note that I'm still very much in need of representatives from the various project teams to pitch in and help us get things running. Please make sure your project is represented by coming along to meetings, or at least contacting us through the mailing list.
 
 
 
This week I've also spent some time with the Upstream training team, identifying gaps in the current material, and preparing for Barcelona.
 
 
 
== Progress towards Newton ==
 
 
 
124 days to go!
 
 
 
Bugs closed so far: 134
 
 
 
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: Bogdan Dobrelya'''
 
No report this week.
 
 
 
'''Install Guide: Lana Brindley'''
 
Poll concluded, winner is "OpenStack Installation Tutorial". Connected with CPLs this week to encourage more participation. Next meeting: Tue 7 June 0600 UTC.
 
 
 
'''Networking Guide: Edgar Magana'''
 
Moved DHCP HA chapter to Networking Guide for better maintenance and updates. Planning to move more sections and focus on DVR HA. Suffering of very low attendance for the IRC meeting.
 
 
 
'''Security Guide: Nathaniel Dillon'''
 
No report this week.
 
 
 
'''User Guides: Joseph Robinson'''
 
Some contact with the Magnum team. Held meetings, brought up the link changes, which is something I most need some assistance with. IA plan still forthcoming.
 
 
 
'''Ops Guide: Shilla Saebi'''
 
No report this week.
 
 
 
'''API Guide: Anne Gentle'''
 
New layout for API reference docs from additions to openstackdocs theme. Also already added four-color scheme for GET/PUT/POST/DELETE Thanks Graham Hayes! Work in progress here: https://api.os.gra.ham.ie/compute/
 
Reviews:  https://review.openstack.org/#/q/project:openstack/openstackdocstheme+status:open and https://review.openstack.org/#/q/project:openstack/os-api-ref+status:open
 
Discussion on SDKs and FirstApp audience happening on user-committee list: http://lists.openstack.org/pipermail/user-committee/2016-May/000889.html
 
 
 
'''Config/CLI Ref: Tomoyuki Kato'''
 
Closed some bugs with Mitaka backport. Fixed the incorrect RST markup at  the new options section, with generation tool update.
 
 
 
'''Training labs: Pranav Salunke, Roger Luethi'''
 
No report this week.
 
 
 
'''Training Guides: Matjaz Pancur'''
 
Upstream training updates, Barcelona schedule.
 
 
 
'''Hypervisor Tuning Guide: Blair Bethwaite
 
No report this week.
 
 
 
'''UX/UI Guidelines: Michael Tullis, Stephen Ballard'''
 
The first prototype of content was presented and source information gaps were identified. A first draft will be complete by June 9.
 
 
 
== Site Stats ==
 
 
 
In the Install Guide naming poll, "OpenStack Installation Tutorial" finished with 29% of the vote, well ahead of "OpenStack Evaluation Setup Guide" at 19%, and "Basic Install Guide" at 16%. And, because charts are fun, here are the final results: https://docs.google.com/spreadsheets/d/1VlNFebI_KFobs-XIT5oRhULRymwrqON8SV9pH4uiYIQ/pubchart?oid=2070399201&format=image
 
 
 
I personally thought "OpenStack from Scratch" was the most creative title. And the potentially confusing "Manual Install Guide" ("Guided Install Manual"?) had a small following at just under 10% of the vote. Thanks for all the great suggestions :)
 
 
 
== 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-06-01
 
 
 
Next meetings:
 
US: Wednesday 8 June, 19:00 UTC
 
APAC: Wednesday 15 June, 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#3_June_2016
 

Latest revision as of 17:37, 30 November 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

7 April 2017

Team,

This week I have still been working on drafting a governance tag for our guides called "docs:follows-policy". I have been working with Doug Hellmann (dhellmann) in the last week to change to draft dramatically, so it would be good for docs people to review again. We are trying to make this a more broad tag now, so it can be applied for other guides too. To review: https://review.openstack.org/#/c/445536/ I am also in the process of documenting guidelines in our Contribution Guide - which would also benefit from doc reviews: https://review.openstack.org/#/c/453642/

Would like to call out and thank John Davidge for his awesome work with the Networking Guide and neutron-related patches. He's been providing valuable guidance, and reviews, and it has been greatly appreciated by myself and the team.

Lana Brindley has done an awesome job for the last two weeks in keeping our bug list under control. We are down to an amazing 102 bugs in queue, and 82 bugs closed this cycle already! Next week, I 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 one spot open for the rest of the cycle (14 Aug - 28 Aug): https://wiki.openstack.org/wiki/Documentation/SpecialityTeams#Bug_Triage_Team

The Road to the Summit in Boston

Keep an eye out for the docs and I18n have a project onboarding room at the summit. Melvin Hillsman (mrhillsman) of the User Committee submitted a forum topic for the Ops Guide to get operator feedback. David Flanders from the Foundation has also proposed a forum topic for developer.openstack.org (which currently houses our API, SDK, and other dev stuff). We'll be discussing major changes to that and would like to see some feedback from people here. Any questions on that, shoot it my way. My main objective for this forum topic is to reduce our current technical debt that lives on this site. For more information on forum topics: https://wiki.openstack.org/wiki/Forum Schedule has been released: https://www.openstack.org/summit/boston-2017/summit-schedul

Speciality Team Reports

  • API - Anne Gentle: API versioning in relation to release versioning is currently manually compiled for the 40-ish API services, so ideas on how to automate and surface that info welcomed. More info: http://lists.openstack.org/pipermail/openstack-dev/2017-March/114690.html
  • Configuration Reference and CLI Reference - Tomoyuki Kato: N/A
  • High Availability Guide - Ianeta Hutchinson: We are continuing to collaborate with OS DevOps team. See the tag ha-guide-draft for bugs opened to fill content for the new guide.
  • Hypervisor Tuning Guide - Blair Bethwaite: N/A
  • Installation guides - Lana Brindley: We have now branched, so please remember to backport if you have edits to the Ocata guide now. Big thanks to all the testers who have been working hard over the past month or two (that Nova cells bug was *tough*!), and to Brian and Mariia for doing the heavy lifting. Noticed a bunch links to draft versions of the guide in Newton/Ocata branches, backports for that have been merged, and the Contributor Guide updated so we don't miss it in the future (https://docs.openstack.org/contributor guide/release/taskdetail.html#update-links-in-all-books).
  • Networking Guide - John Davidge: More patches landed in the last couple of weeks dealing with the move to OSC, and more are still in flight. Progress also continues on RFC 5737 compliance. Thanks to all contributors for their work.
  • Operations and Architecture Design guides - Darren Chan: Arch Guide: edited architecture considerations content and cleaned up the index page structure which was applied across OS manuals. Some ops-related content was moved to the Ops Guide. Our current focus is improving the storage design content and networking design content.
  • Training Guides - Matjaz Pancur: N/A
  • Training labs - Roger Luethi: We released the Ocata version of training-labs this week.
  • User guides - Joseph Robinson: For the user guides - the spec on migrating the Admin Guide content this week moved closer to merging. I started preparing the work items for action on the User Guides tasks wiki page.
  • Theme and Tools - Brian Moss: Anne has a spec up for theme consolidation, please check it out: https://review.openstack.org/#/c/454346/, Brian has fixed up the sitemap tool tests, reviews welcome: https://review.openstack.org/#/c/453976/. 41 open bugs, 13 closed in Pike

Doc team meeting

Our next meeting will be on Thursday, 20 April at 2100 UTC in #openstack-meeting-alt. For more meeting details, including minutes and the agenda: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting The meeting chair will be me!

Big thanks to Joseph for stepping up in the last 2 meetings and hosting in my absence! Really appreciated it :)

--

Have a great week :)

Alex

IRC: asettle Twitter: dewsday

27 March 2017

Team team team team team,

Well the last month has just FLOWN by since the PTG. We've got plenty going on in the docs 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

Speciality 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/NewtonDocTesting 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 resolved.
  • User guides - Joseph Robinson: Several other Legacy commands were converted to OS commands this week. Reviewed the Admin Guide spec.
  • Theme and Tools - Brian Moss: I'd like to do an openstackdocstheme release soon, as we've got some items (PDF styling, search page JS fix, image centering) that would be good to have in production. Any concerns or last minute items to merge please let me know. We've had some issues come up with the auto-generation scripts. Some have been fixed already (thanks Kato and Christian!), and we're investigating others. If you notice anything amiss or would like to help out, please let me know. 46 open bugs, 8 closed in Pike

Doc team meeting

Our next meeting will be on Thursday, 7 April at 2100 UTC in #openstack-meeting-alt. For more meeting details, including minutes and the agenda: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting

--

Have a great week :)

Alex

IRC: asettle Twitter: dewsday