Jump to: navigation, search

Difference between revisions of "Documentation/WhatsUpDoc"

(Speciality Teams)
m
 
(181 intermediate revisions by 3 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)
 
* i18n List <openstack-i18n@lists.openstack.org>
 
* i18n List <openstack-i18n@lists.openstack.org>
  
==== Your suggestions for content ====
+
==== Content Sources ====
* Your
 
* Content
 
* Here
 
* Core reviewer responsibilities
 
  
==== Looking for older editions? ====
+
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.
You can see older newsletters here: [[Documentation/WhatsUpDoc_Archive]]
 
  
= 19 February 2016 =
+
If you have something that you would like to add to the next newsletter, please add it here:
  
Hi everyone,
+
*
  
This week I've been focusing on general housekeeping duties as we prepare to rush headlong into the release. I've cleaned up the blueprints list, and also been burning through the oldest bugs in our queue. I'm very pleased to report that the overall number of bugs has reduced dramatically in the past month or two, and the number of untriaged bugs is holding steady at a much lower rate than previously. I think this probably has a lot to do with the DocImpact changes we made at the beginning of the year, so it's very gratifying to see some solid improvement starting to filter through. In other news, thanks to all those people who helped us with locating pre-release packages for the Install Guide. Please feel free to begin testing! The more people we have testing, the better and more accurate our docs will be, which helps everyone.
+
==== Looking for older editions? ====
 
+
You can see older newsletters here: [[Documentation/WhatsUpDoc_Archive]]
== Progress towards Mitaka ==
 
 
 
47 days to go!
 
 
 
417 bugs closed so far for this release. There is a global bug smash event coming up March 7-9 to try and hit as many Mitaka bugs as possible. You can join an in-person group near you, or participate remotely. There are still plenty of docs bugs that can be attended to. Details here: https://etherpad.openstack.org/p/OpenStack-Bug-Smash-Mitaka
 
 
 
Docs Testing
 
* Volunteers required!
 
* https://wiki.openstack.org/wiki/Documentation/MitakaDocTesting
 
 
 
RST Conversions
 
* All planned RST conversions are now complete!
 
 
 
Reorganisations
 
* Arch Guide: really needs a last minute push to get this complete before Mitaka. If you can help out, it would be greatly appreciated!
 
** https://blueprints.launchpad.net/openstack-manuals/+spec/archguide-mitaka-reorg
 
** Contact the Ops Guide Speciality team: https://wiki.openstack.org/wiki/Documentation/OpsGuide
 
* User Guides
 
** https://blueprints.launchpad.net/openstack-manuals/+spec/user-guides-reorganised
 
** Contact the User Guide Speciality team: https://wiki.openstack.org/wiki/User_Guides
 
 
 
DocImpact
 
* Is now complete
 
 
 
== The Road to Austin ==
 
 
 
* ATC passes are going out now, so keep an eye on your inbox for your discount code if you haven't received yours yet.
 
* Talk voting is now closed
 
* You should be starting to think about booking travel and accommodation soon! If you need a visa to travel to the United States, there's more info here: https://www.openstack.org/summit/austin-2016/austin-and-travel/#visa
 
 
 
== Speciality Teams ==
 
 
 
'''HA Guide - Bogdan Dobrelya'''
 
No update this week.
 
 
 
'''Installation Guide - Matt Kassawara'''
 
Testing Mitaka milestone 3 using RDO packages and submitting patches for review. Lead of the install guide changed from Christian Berendt to Matt Kassawara.
 
  
'''Networking Guide - Edgar Magana'''
+
= 7 April 2017 =
No update this week.
 
  
'''Security Guide - Nathaniel Dillon'''
+
Team,
No update this week.
 
  
'''User Guides - Joseph Robinson'''
+
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/
The new User Guide team meetings are a success. We now have more contributors, and are disucssing doc editing, new content, and Information Architecture of the User Guides.
 
  
'''Ops and Arch Guides - Shilla Saebi'''
+
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.
Architecture guide reorganization is underway. We have a drafts repo in openstack-manuals, feel free to ping Shilla or Darren Chan if you are interested in helping out. Considering doing a swarm or work session at the summit in Austin for the Arch guide. Operations guide RST migration pending - conversations still happening to see which route we'll take. Still deciding if the ops guide should have another revision or edition, see ML e-mails. Call for volunteers email went out to the ops and docs ML from Devon Boatwright. We are looking for help! There is a global OpenStack bug smash scheduled for the Mitaka release in March. Details can be found here: https://etherpad.openstack.org/p/OpenStack-Bug-Smash-Mitaka We're looking for people to specifically help with the Architecture Guide, which is currently going through a reorganization. Here is the link for more details: https://wiki.openstack.org/wiki/Architecture_Design_Guide_work_items If you are interested in helping out, more details can be found about our team and our meetings here: https://wiki.openstack.org/wiki/Documentation/OpsGuide
 
  
'''API Docs - Anne Gentle'''
+
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!
http://lists.openstack.org/pipermail/openstack-docs/2016-February/008286.html Swagger files now available at http://developer.openstack.org/draft/swagger/
+
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
  
'''Config Ref - Gauvain Pocentek'''
+
== The Road to the Summit in Boston ==
No update this week.
 
  
'''Training labs - Pranav Salunke, Roger Luethi'''
+
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.
Fixing various things in training-labs cluster for VirtualBox and KVM backends. Improving workflow, configuration and making the library scripts nicer. Adding training-labs landing page (WIP). Summit related work. Some minor improvements.
+
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
  
'''Training Guides - Matjaz Pancur'''
+
== Speciality Team Reports ==
No update this week.
 
  
'''Hypervisor Tuning Guide - Joe Topjian'''
+
* 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 update 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.
'''UX/UI Docs Guidelines - Linette Williams'''
+
* Hypervisor Tuning Guide - Blair Bethwaite: N/A
Enhancement to UI content guidelines underway. Expect a new review shortly that covers icons and text formatting. If interested or have questions, contact Linette or Piet Kruithof.
+
* 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 ==
 
== 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 APAC meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-02-10
 
 
 
Next meetings:
 
US: Wednesday 17 February, 14:00 UTC
 
APAC: Wednesday 24 February, 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
 
 
 
Note that there is currently discussion about moving the US meeting to 20:00 UTC. A patch is open to change this, with ongoing discussion about finding a meeting room: https://review.openstack.org/#/c/271361/
 
  
 
--
 
--
 +
 +
Have a great week :)
 +
 +
Alex
  
Keep on doc'ing!
+
IRC: asettle
 
+
Twitter: dewsday
Lana
 
 
 
https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#19_February_2016
 
 
 
= 12 February 2016 =
 
 
 
Hi everyone,
 
 
 
This week has been all about the Install Guide. We're locating pre-release packages now so we can begin testing in about two weeks' time. Please consider being a tester for this release. Even if you've never done it before, it's a great way to improve your OpenStack knowledge, and the more people we have testing, the better and more accurate our docs will be, which helps everyone. We're also starting to see a little more action in the lead up to the Austin Summit. ATC passes are going out, and the talk sessions are now open for voting: https://www.openstack.org/summit/austin-2016/vote-for-speakers/
 
  
== Progress towards Mitaka ==
+
= 27 March 2017 =
  
54 days to go!
+
Team team team team team,
  
389 bugs closed so far for this release.
+
Well the last month has just FLOWN by since the PTG. We've got plenty going on in the docs team...
  
Docs Testing
+
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
* Volunteers required!
+
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/
* https://wiki.openstack.org/wiki/Documentation/MitakaDocTesting
 
  
RST Conversions
+
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.
* All planned RST conversions are now complete!
 
  
Reorganisations
+
Also, thank you to our Ocata release managers, Maria Zlatkova and Brian Moss for cutting the branch! Pike is well and truly underway now.
* Arch Guide: really needs a last minute push to get this complete before Mitaka. If you can help out, it would be greatly appreciated!
 
** https://blueprints.launchpad.net/openstack-manuals/+spec/archguide-mitaka-reorg
 
** Contact the Ops Guide Speciality team: https://wiki.openstack.org/wiki/Documentation/OpsGuide
 
* User Guides
 
** https://blueprints.launchpad.net/openstack-manuals/+spec/user-guides-reorganised
 
** Contact the User Guide Speciality team: https://wiki.openstack.org/wiki/User_Guides
 
  
DocImpact
+
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!
* Is now complete
 
  
== The Road to Austin ==
+
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
  
* ATC passes are going out now, so keep an eye on your inbox for your discount code if you haven't received yours yet.
+
== The Road to the Summit in Boston ==
* Don't forget to vote on your favourite talks: https://www.openstack.org/summit/austin-2016/vote-for-speakers/
 
  
== Speciality Teams ==
+
* 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
  
'''HA Guide - Bogdan Dobrelya'''
+
== Speciality Team Reports ==
Minor updates to the corosync/pacemaker, rabbitmq clusters setup guides
 
  
'''Installation Guide - Christian Berendt'''
+
* 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
Mitaka Installation guide changes spec: https://review.openstack.org/#/c/274231/ Testing beginning, require packages: https://wiki.openstack.org/wiki/Documentation/MitakaDocTesting
+
* 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!
'''Networking Guide - Edgar Magana'''
+
* Hypervisor Tuning Guide - Blair Bethwaite: N/A
Move the IRC meeting agenda to etherpad: https://etherpad.openstack.org/p/docnetworkingteam-agenda. Important Commits: DSCP addition to advanced qos guide: https://review.openstack.org/#/c/273638/ Add networking guide to Contributors Section: https://review.openstack.org/#/c/278330/ Last IRC Meeting Notes: http://eavesdrop.openstack.org/meetings/networking_guide/2016/networking_guide.2016-02-04-16.02.log.html
+
* 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
'''Security Guide - Nathaniel Dillon'''
+
* 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).
Continuing bugfixes and beginning Networking review (thanks to all Neutron contributors!)
+
* 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)
'''User Guides - Joseph Robinson'''
+
* 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.
Held First US/EU Meeting, which was 1 and a 1/2 hours before the APAC meeting (Need to reserve the meeting time). Discussed Reorg- High Priority step - moving Dashboard content from the Admin Guide to the Cloud Admin Dashboard Chapter.
+
* 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
'''Ops and Arch Guides - Shilla Saebi'''
 
Architecture guide reorganization is underway. We have a drafts repo in openstack-manuals, feel free to ping Shilla or Darren Chan if you are interested in helping out. Considering doing a swarm or work session at the summit in Austin for the Arch guide. Operations guide RST migration pending - conversations still happening to see which route we'll take. Still deciding if the ops guide should have another revision or edition, see ML emails.
 
 
 
'''API Docs - Anne Gentle'''
 
No update this week.
 
 
 
'''Config Ref - Gauvain Pocentek'''
 
No update this week.
 
 
 
'''Training labs - Pranav Salunke, Roger Luethi'''
 
We reviewed and merged several patches: bug fixes, refactoring and some code to help with debugging.
 
 
 
'''Training Guides - Matjaz Pancur'''
 
No update this week.
 
 
 
'''Hypervisor Tuning Guide - Joe Topjian'''
 
No update this week.
 
 
 
'''UX/UI Docs Guidelines - Linette Williams'''
 
No update this week.
 
  
 
== 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-02-10
 
 
 
Next meetings:
 
US: Wednesday 17 February, 14:00 UTC
 
APAC: Wednesday 24 February, 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
 
 
 
Note that there is currently discussion about moving the US meeting to 20:00 UTC. A patch is open to change this, with ongoing discussion about finding a meeting room: https://review.openstack.org/#/c/271361/
 
 
 
--
 
 
 
Keep on doc'ing!
 
 
 
Lana
 
 
 
https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#12_February_2016
 
 
 
= 6 February 2016 =
 
 
 
Hi everyone,
 
 
 
A busy week here in docs, with today marking only two months left until Mitaka goes out. I've been working on the DocImpact script, the core team review, and a whole lot of general chasing things up and tidying around the place. I also note that the Installation Guide team is busy ramping up for Mitaka, so watch this space for your opportunity to jump into testing for that very soon. Next week, I'll be cleaning up the blueprints, and also starting to get in touch with our packaging contacts to get ready for release.
 
 
 
== Progress towards Mitaka ==
 
 
 
60 days to go!
 
 
 
382 bugs closed so far for this release.
 
 
 
RST Conversions
 
* All planned RST conversions are now complete!
 
 
 
Reorganisations
 
* Arch Guide: really needs a last minute push to get this complete before Mitaka. If you can help out, it would be greatly appreciated!
 
** https://blueprints.launchpad.net/openstack-manuals/+spec/archguide-mitaka-reorg
 
** Contact the Ops Guide Speciality team: https://wiki.openstack.org/wiki/Documentation/OpsGuide
 
* User Guides
 
** https://blueprints.launchpad.net/openstack-manuals/+spec/user-guides-reorganised
 
** Contact the User Guide Speciality team: https://wiki.openstack.org/wiki/User_Guides
 
 
 
DocImpact
 
* The implementation plan for the DocImpact script changed after we received feedback from Infra and Nova. Now, *all* projects (including the five 'defcore' projects) default to opening DocImpact bugs in their own bug queues. This change was proposed in https://review.openstack.org/#/c/276065/ and merged yesterday, very quickly!  Projects will now be able to determine for themselves how they would like to use the DocImpact script within their own groups, and hopefully the quality of bug reporting to docs will improve dramatically as a result of this. I'd like to thank all the PTLs, cross-project liaisons, project core team members, and especially the Infra and Nova teams for their assistance and patience while we worked through this knotty problem. I'm happy to be able to report that, as of today, this project is now complete.
 
 
 
== Speciality Teams ==
 
 
 
'''HA Guide - Bogdan Dobrelya'''
 
No update this week.
 
 
 
'''Installation Guide - Christian Berendt'''
 
Mitaka Installation guide changes spec: https://review.openstack.org/#/c/274231/
 
 
 
'''Networking Guide - Edgar Magana'''
 
No update this week.
 
 
 
'''Security Guide - Nathaniel Dillon'''
 
RST bug fixes and cleaning up of lingering migration issues. Looking for Neutron reviewers to see what is still accurate and what needs to be updated, please ping Nathaniel. Looking to setup PDF creation job.
 
 
 
'''User Guides - Joseph Robinson'''
 
An action item from last meeting was addressed this week - working with new User Guide team members to continue reorganisation edits. Plans for an earlier, US+EU meeting, which would roll into an APAC meeting on Wedneday/Thursday fornightly meeting times are in place.
 
 
 
'''Ops and Arch Guides - Shilla Saebi'''
 
Architecture guide reorganization is underway. We have a drafts repo in openstack-manuals, feel free to ping Shilla or Darren Chan if you are interested in helping out. Considering doing a swarm or work session at the summit in Austin for the Arch guide. Operations guide RST migration pending - conversations still happening to see which route we'll take. Still deciding if the ops guide should have another revision or edition, see ML emails.
 
 
 
'''API Docs - Anne Gentle'''
 
Continuing to work on builds of Swagger plus RST.
 
 
 
'''Config Ref - Gauvain Pocentek'''
 
No update this week.
 
 
 
'''Training labs - Pranav Salunke, Roger Luethi'''
 
Liberty support has been merged. The new default for training-labs clusters is the Liberty release.
 
 
 
'''Training Guides - Matjaz Pancur'''
 
Removal of redundant Jenkins jobs (gate-training-guides-tox-slides) and tox targets. Upstream training archives (http://docs.openstack.org/upstream-training/upstream-archives.html) are now separated from the main landing page.
 
 
 
'''Hypervisor Tuning Guide - Joe Topjian'''
 
No update this week.
 
 
 
'''UX/UI Docs Guidelines - Linette Williams'''
 
Collaboration between the UX project and Doc project. The first UI text guidelines are live: http://docs.openstack.org/contributor-guide/ui-text-guidelines.html. Enhancements to guidelines in progress - specifically related to icons and text formatting. Text reviews are ongoing for new UI prototypes, as applicable. If interested in helping with UI panel reviews or with UI text guidelines,  feel free to ping Linette or Piet Kruithof.
 
 
 
== 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-01-20
 
 
 
Next meetings:
 
APAC: Wednesday 10 February, 00:30 UTC
 
US: Wednesday 17 February, 14: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
 
 
 
Note that there is currently discussion about moving the US meeting to 20:00 UTC. A patch is open to change this, with ongoing discussion about finding a meeting room: https://review.openstack.org/#/c/271361/
 
  
 
--
 
--
 +
 +
Have a great week :)
 +
 +
Alex
  
Keep on doc'ing!
+
IRC: asettle
 
+
Twitter: dewsday
Lana
 
 
 
https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#6_February_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