Difference between revisions of "Documentation/WhatsUpDoc"
Petr Kovar (talk | contribs) m |
|||
| (392 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 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: | |
| − | 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: | ||
| − | |||
| − | |||
==== Distribution List ==== | ==== Distribution List ==== | ||
| − | |||
* 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> | ||
| − | ==== | + | ==== 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 == | == 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 == | |
| − | |||
| − | * | + | * 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 | ||
| − | + | == 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 == | == 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 | |
| − | |||
| − | |||
| − | |||
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
- OpenStack Development Mailing List <openstack-dev@lists.openstack.org>
- Docs liaisons (from https://wiki.openstack.org/wiki/CrossProjectLiaisons#Documentation)
- i18n List <openstack-i18n@lists.openstack.org>
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
- 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
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
