Jump to: navigation, search

Difference between revisions of "Documentation/WhatsUpDoc"

(Site Stats)
m
 
(68 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]]
  
= 29 July 2016 =
+
= 7 April 2017 =
 
 
Hi everyone,
 
 
 
A fairly quiet week this week, as I've been gradually working my way through old bugs. We're now only ten weeks out from release, so I've also been trying to tidy up some loose ends around the Contributor Guide. We have a couple of specs out for review right now, so if you're looking for some docs work to pick up, try checking these out: https://review.openstack.org/#/q/status:open+project:openstack/docs-specs,n,z
 
 
 
== Progress towards Newton ==
 
 
 
68 days to go!
 
 
 
Bugs closed so far: 339
 
 
 
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: Andrew Beekhof'''
 
Informal discussions about appropriate contents and structure
 
 
 
'''Install Tutorials: Lana Brindley'''
 
Next meeting: 2 August 0600 UTC
 
 
 
'''Networking Guide: Edgar Magana'''
 
Guide re-organization patch has been merged: https://review.openstack.org/#/c/345110/
 
 
 
'''Security Guide: Nathaniel Dillon'''
 
Performing full read-through and bug hunt
 
Opened 5 new bugs
 
Currently looking at Neutron chapter
 
Incoming addition on rate-limiting and anti-DDoS (framework merged tonight (thanks Kato!) and additional details coming)
 
 
 
'''User Guides: Joseph Robinson'''
 
No report this week.
 
 
 
'''Ops Guide: Shilla Saebi, Darren Chan'''
 
Weekly Arch Guide working group meeting on Wednesday 20:00 UTC in progress.
 
Currently drafting the Design chapter and reusing existing content.
 
Working on getting more enterprise docs uploaded and pushed upstream for ops guide
 
 
 
'''API Guide: Anne Gentle'''
 
First App tutorial for the Shade SDK now moving out of draft state. Way to go Marcela Bonell and infra people who make this SDK possible.
 
Thank you to Kato Tomoyuki for deletions of the Image and Networking WADL files in api-site. This ongoing dedication and cleanup is super valuable and much appreciated.
 
 
 
'''Config/CLI Ref: Tomoyuki Kato'''
 
Reflecting comments from Stackers. Closed a few bugs for Configuration Reference. Working on the common configurations.
 
 
 
'''Training labs: Pranav Salunke, Roger Luethi'''
 
No report this week.
 
 
 
'''Training Guides: Matjaz Pancur'''
 
No report this week.
 
 
 
'''Hypervisor Tuning Guide: Blair Bethwaite
 
No report this week.
 
 
 
'''UX/UI Guidelines: Michael Tullis, Rodrigo Caballero'''
 
No report this week.
 
 
 
== Site Stats ==
 
 
 
Just under 55% of our mobile visitors are using an Android operating system to access the site, while just under 40% of our mobile visitors are using iOS. A statistically insignificant 0.07% are still using their Blackberries ...
 
 
 
== 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-07-27
 
 
 
Next meetings:
 
US: Wednesday 3 August, 19:00 UTC
 
APAC: Wednesday 10 August, 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#29_July_2016
 
 
 
= 22 July 2016 =
 
 
 
Hi everyone,
 
 
 
As many of you would have noticed from the email onslaught, I've been working on some Launchpad housekeeping this week. The blueprints are all tidied up now, and I intend to start on the bug list next week, so keep those email filters handy ;)
 
 
 
I'd also like to point out the hard work Andreas has been putting in to evaluate moving our docs jobs to Ubuntu Xenial. If you notice any weirdness, please let Andreas know.
 
 
 
== Progress towards Newton ==
 
 
 
75 days to go!
 
 
 
Bugs closed so far: 315
 
 
 
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: Andrew Beekhof'''
 
Got drafted (pun intended)
 
Started figuring out the current status and direction
 
 
 
'''Install Tutorials: Lana Brindley'''
 
Next meeting: 2 August 0600 UTC
 
 
 
'''Networking Guide: Edgar Magana'''
 
No report this week.
 
 
 
'''Security Guide: Nathaniel Dillon'''
 
No report this week.
 
 
 
'''User Guides: Joseph Robinson'''
 
No report this week.
 
 
 
'''Ops Guide: Shilla Saebi, Darren Chan'''
 
Started a weekly Arch Guide working group meeting on Wednesday 20:00 UTC. Currently drafting the Design chapter and reusing existing content.
 
 
 
'''API Guide: Anne Gentle'''
 
Sent email to -dev and -docs list to determine next steps for releasing openstackdocstheme and os-api-ref sphinx extension so we can get the better theming output: http://lists.openstack.org/pipermail/openstack-dev/2016-July/099373.html
 
Released 1.4.0 of openstackdocstheme in preparation for August (hopefully) readiness of theme/extension for unifying API docs navigation.
 
Completed updated of governance/reference/projects.yaml to indicate contributor and api docs URLs. Found that three projects have not completed migration (trove, telemetry/ceilometer, ) and found that nn projects don't use the openstackdocstheme and os-api-ref extension and then won't be included in a unified navigation solution for all OpenStack APIs.
 
 
 
'''Config/CLI Ref: Tomoyuki Kato'''
 
Adding Clustering service configuration options. Fixed some bugs. Updated a few CLI reference. Added python-watcherclient.
 
 
 
'''Training labs: Pranav Salunke, Roger Luethi'''
 
No report this week.
 
 
 
'''Training Guides: Matjaz Pancur'''
 
No report this week.
 
 
 
'''Hypervisor Tuning Guide: Blair Bethwaite
 
No report this week.
 
 
 
'''UX/UI Guidelines: Michael Tullis, Rodrigo Caballero'''
 
All five personas are up for review on Gerrit. https://review.openstack.org/#/c/326662/
 
Further improvements are planned for after the basic information is merged.
 
 
 
== HA Guide Speciality Team Update ==
 
 
 
Bogdan Dobrelya is stepping down from leading the HA Guide Speciality Team, and I would like to thank him for his hard work. I'd like to welcome Andrew Beekhof to the role, and wish him all the best. If you're interesting in helping out on the HA Guide, please let Andrew or me know and we'll get you started.
 
 
 
== Site Stats ==
 
 
 
While 70% of our site traffic comes through Google, just under 5% comes through Baidu, beating Bing on just 1.45%.
 
 
 
== 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-07-20
 
  
Next meetings:
+
Team,
APAC: Wednesday 27 July, 00:30 UTC
 
US: Wednesday 3 August, 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
+
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.
  
Keep on doc'ing!
+
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
  
Lana
+
== The Road to the Summit in Boston ==
  
https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#22_July_2016
+
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.
= 15 July 2016 =
+
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
Hi everyone,
 
 
 
CFP for the Barcelona Summit closed this week, so I've been caught up in the flurry of talk submissions. I hope you got yours in on time! We have more Installation Tutorials going up all the time, with Swift up and Designate now in progress. I'd also like to remind you all that we have instructions for creating your team's Install Tutorial in our Contributor Guide here: http://docs.openstack.org/contributor-guide/project-install-guide.html We'd love to get your feedback on that content!
 
 
 
== Progress towards Newton ==
 
 
 
82 days to go!
 
 
 
Bugs closed so far: 280
 
 
 
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.
 
 
 
The CFP for Barcelona is now closed. Best of luck to everyone who submitted a talk :)
 
  
 
== 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 Tutorials: Lana Brindley'''
+
* Hypervisor Tuning Guide - Blair Bethwaite: N/A
Continued to publish new guides, Swift is now up, Designate is on review. Submitted Summit talk on this topic. Don't miss our insstructions for creating a new Install Tutorial:http://docs.openstack.org/contributor-guide/project-install-guide.html Next meeting: 19 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 meeting 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'''
 
OpenStack ops guide reorg in progress & documented here: https://etherpad.openstack.org/p/ops-guide-reorg
 
Added enterprise docs troubleshooting information to the Ops Guide
 
 
 
'''API Guide: Anne Gentle'''
 
Keystone API sprint this week, details are here: https://etherpad.openstack.org/p/keystone-api-sprint Lance Bragstad is on FIRE!
 
Review these api-ref patchsets in progress: https://review.openstack.org/#/q/status:open+file:api-ref
 
Working on a plan for how to merge HTTP Status Code tables and Graham Hayes's patch to use the openstackdocstheme and Karen Bradshaw's overall API navigation in time for release, stay tuned.
 
 
 
'''Config/CLI Ref: Tomoyuki Kato'''
 
Got feedbacks from Dolph Matthews, thank you! Closed a few bugs. Updated some CLI reference.
 
 
 
'''Training labs: Pranav Salunke, Roger Luethi'''
 
Many minor improvements to training-labs library scripts
 
Finalzing PXE feature, still more work is required but the current patch should be in a state to be merged soon.
 
Finalizing parser POC to parse install-guides to BASH for testing install guides and also auto-creation of guest side scripts for training-labs
 
 
 
'''Training Guides: Matjaz Pancur'''
 
Removed unused images for Training guides, improvements on Getting Started (core and optional services, link updates).
 
 
 
'''Hypervisor Tuning Guide: Blair Bethwaite
 
No report this week.
 
 
 
'''UX/UI Guidelines: Michael Tullis, Rodrigo Caballero'''
 
No report this week.
 
 
 
== Core Team Review ==
 
 
 
Regretfully, Diane Fleming is no longer a core team member. I'd like to thank Diane for all her contributions to our team. She's been a powerhouse core team member since well before I did my very first OpenStack patch, and I think it's fair to say that many of us wouldn't be here without Diane's support and guidance.
 
 
 
== Site Stats ==
 
 
 
The number of people browsing the site using Opera has dropped by 5% over the past 30 days, but nearly 20% more people are using Edge (which I'm told is the new Windows browser that's replacing IE). Oddly, IE users have increased slightly as well, though, by 7%. Are people abandoning their Macs?!
 
  
 
== 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 (big thanks to Joseph for chairing that meeting in my absence!), you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-07-13
 
 
 
Next meetings:
 
US: Wednesday 20 July, 19:00 UTC
 
APAC: Wednesday 27 July, 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
+
= 27 March 2017 =
  
https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#15_July_2016
+
Team team team team team,
  
= 8 July 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'm pleased to report that the index page for the new Install <s>Guides</s> Tutorials is up and running! We also had some lengthy discussions about the use of conditionalised formatting (with ``only``), so there were a few meaty topics to go through in the meeting this week. It's also been way too long since we last did a core team review, so that happened this week. I'd also like to remind you that the CFP for Barcelona is only open until mid next week, so get your proposals in soon! 
+
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.
  
== Progress towards Newton ==
+
Also, thank you to our Ocata release managers, Maria Zlatkova and Brian Moss for cutting the branch! Pike is well and truly underway now.
  
89 days to go!
+
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!
  
Bugs closed so far: 256
+
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
  
I think 50 bugs in two weeks is something of a record! Thanks to all the bug smashers working hard this week :)
+
== 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
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
Index page is now up, needs some iteration to improve. Decided against using ``only`` for now (review after Newton), Manila patch to be updated. Next meeting: 19 July 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 meeting this week. Keep trying to move documentation from other dispersed places to the networking 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)
'''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'''
 
Adding the consistency notes to the work items wiki page. Team emails.
 
 
 
'''Ops Guide: Shilla Saebi'''
 
No report this week.
 
 
 
'''API Guide: Anne Gentle'''
 
Sign up on the etherpad to participate in a keystone Identity API sprint: https://etherpad.openstack.org/p/keystone-api-sprint
 
New patch this week to migrate the ceilometer Telemetry API docs, please review: https://review.openstack.org/334028 Thank you Khushbu!
 
Need another +2 from the swift team for their migration patch: https://review.openstack.org/#/c/312315/
 
Updated patch in the governance repo projects.yaml file to indicate both contributor docs URLs and API docs URLs: https://review.openstack.org/#/c/316396/ Consider a work in progress for URL completeness and accuracy, but please review for format.
 
Responding to input about API versions and release versions. See http://lists.openstack.org/pipermail/openstack-docs/2016-July/008818.html
 
 
 
'''Config/CLI Ref: Tomoyuki Kato'''
 
Closed many bugs.
 
Implementing common configuration sections for shared services and libraries.
 
Updated a few clients reference, and added solum client.
 
 
 
'''Training labs: Pranav Salunke, Roger Luethi'''
 
No report this week.
 
 
 
'''Training Guides: Matjaz Pancur'''
 
No report this week.
 
 
 
'''Hypervisor Tuning Guide: Blair Bethwaite
 
No report this week.
 
 
 
'''UX/UI Guidelines: Michael Tullis, Rodrigo Caballero'''
 
Three out of the five personas have been created and are being reviewed.
 
https://review.openstack.org/#/c/326662/
 
The last two personas will be added to the change within the week.
 
It was suggested to add a checklist for developers to be able to identify the appropriate persona for their work.
 
 
 
== Core Team Review ==
 
 
 
The core team have completed their review for July, and we would like to welcome Joseph Robinson to the openstack-doc-core team.
 
 
 
Joseph has been leading the User Guides speciality team for some time now, and has been a docs-specs-core as part of that role. Welcome to the larger core team, Joseph, we're really pleased to have you aboard :)
 
 
 
== Site Stats ==
 
 
 
25% of our hits are coming from new (rather than returning) users.
 
  
 
== 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 US meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-07-06
 
 
 
Next meetings:
 
APAC: Wednesday 13 July, 00:30 UTC
 
US: Wednesday 20 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
 
 
 
https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#8_July_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