|
|
| Line 106: |
Line 106: |
| | APAC: Wednesday 25 November, 00:30:00 UTC | | APAC: Wednesday 25 November, 00:30:00 UTC |
| | US: Wednesday 2 December, 14:00 UTC | | US: Wednesday 2 December, 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
| |
| − |
| |
| − | --
| |
| − |
| |
| − | Keep on doc'ing!
| |
| − | Lana
| |
| − |
| |
| − |
| |
| − | = 20 November 2015 =
| |
| − |
| |
| − | Hi everyone,
| |
| − |
| |
| − | This week I've been working on catching up with some reviews and bug triage, I've been speaking to O'Reilly about the future of the Ops Guide, and also been working on a range of other things including docs-specs core team review, and the addition of Zaqar docs into the user guides.
| |
| − |
| |
| − | Just a quick heads up that there won't be a docs newsletter next week, though, as I'm taking a couple of days off (my Mum is coming to visit!), so I'll see you again around 4 December. For those of you in the United States, I hope you all have a lovely Thanksgiving :)
| |
| − |
| |
| − | == Progress towards Mitaka ==
| |
| − |
| |
| − | 138 days to go!
| |
| − |
| |
| − | 119 bugs closed so far for this release.
| |
| − |
| |
| − | RST Conversions
| |
| − | * Arch Guide
| |
| − | ** https://blueprints.launchpad.net/openstack-manuals/+spec/archguide-mitaka-rst
| |
| − | ** Contact the Ops Guide Speciality team: https://wiki.openstack.org/wiki/Documentation/OpsGuide
| |
| − | * Ops Guide
| |
| − | ** https://blueprints.launchpad.net/openstack-manuals/+spec/ops-guide-rst
| |
| − | ** Determining whether or not we want to do an updated version for O'Reilly in L
| |
| − | * Config Ref
| |
| − | ** Contact the Config Ref Speciality team: https://wiki.openstack.org/wiki/Documentation/ConfigRef
| |
| − | * Virtual Machine Image Guide
| |
| − | ** https://blueprints.launchpad.net/openstack-manuals/+spec/image-guide-rst and https://review.openstack.org/#/c/244598/
| |
| − |
| |
| − | Reorganisations
| |
| − | * Arch Guide
| |
| − | ** https://blueprints.launchpad.net/openstack-manuals/+spec/archguide-mitaka-reorg
| |
| − | ** Doc sprint in planning for December. Contact the Ops Guide speciality team for more info or to get involved.
| |
| − | ** 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
| |
| − | * I've added some examples to the spec, and we're pretty much ready to go now: https://blueprints.launchpad.net/openstack-manuals/+spec/review-docimpact
| |
| − |
| |
| − | Document openstack-doc-tools and reorganise index page
| |
| − | * Thanks to Brian and Christian for volunteering to take this on!
| |
| − |
| |
| − | Horizon UX work
| |
| − | * Thanks to the people who offered to help out on this! If you're interested but haven't gotten in touch yet, contact Piet Kruithof of the UX team.
| |
| − |
| |
| − | == Speciality Teams ==
| |
| − |
| |
| − | '''HA Guide - Bogdan Dobrelya'''
| |
| − | Two patches look ready for merge now: https://review.openstack.org/#/c/225418/ and https://review.openstack.org/235893
| |
| − |
| |
| − | '''Installation Guide - Christian Berendt'''
| |
| − | Business as usual. Nothing special to mention this week.
| |
| − |
| |
| − | '''Networking Guide - Edgar Magana'''
| |
| − | Open Reviews: https://review.openstack.org/#/c/239361/ Merged: https://review.openstack.org/#/c/246671/ Very slow progress, hoping to speed up after the USA holidays.
| |
| − |
| |
| − | '''Security Guide - Nathaniel Dillon'''
| |
| − | No update this week
| |
| − |
| |
| − | '''User Guides - Joseph Robinson'''
| |
| − | After a specification update, there is a need to provide a more comprehensive scope: a list of Core features within scope, and include research on the nova-network/ neutron migration study. Contact from Zaqar, Trove, and Murano Liaisons on Admin guide tasks has been helpful, and given the reorganisation direction. A patch on fernet tokens (FAQ format) merged into the Cloud Admin Guide this week.
| |
| − |
| |
| − | '''Ops and Arch Guides - Darren Chan'''
| |
| − | Arch guide migration is close to completion. We are currently planning to reorganize the guide over a two day virtual sprint in mid December.
| |
| − |
| |
| − | '''API Docs - Anne Gentle'''
| |
| − | Review ready for the Mitaka specification of a vision for app dev docs: https://review.openstack.org/#/c/246660/
| |
| − |
| |
| − | '''Config Ref - Gauvain Pocentek'''
| |
| − | The tools are ready, the liberty branch is set up, the RST migration is on! Pick your file, run the tools, and let's review.
| |
| − |
| |
| − | '''Training labs - Pranav Salunke'''
| |
| − | Training-labs has Kilo patch merged! We are currently updating the network configuration and trying to get things as per Matt's feedback/request. We plan to start adding Liberty very soon and also KVM port is on the way.
| |
| − |
| |
| − | '''Training Guides - Matjaz Pancur'''
| |
| − | There is interest in translating Upstream training; we are waiting for https://review.openstack.org/#/c/245615/ to merge to enable it on the repo.
| |
| − |
| |
| − | '''Hyperviser Tuning Guide - Joe Topjian'''
| |
| − | On schedule - working on changing bullet-point notes into rough draft sections.
| |
| − |
| |
| − | == Doc team meeting ==
| |
| − |
| |
| − | We held the US docs meeting this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-11-18
| |
| − |
| |
| − | Next meetings:
| |
| − | APAC: Wednesday 25 November, 00:30:00 UTC
| |
| − | US: Wednesday 2 December, 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
| |
| − |
| |
| − | --
| |
| − |
| |
| − | Keep on doc'ing!
| |
| − | Lana
| |
| − |
| |
| − | = 13 November 2015 =
| |
| − |
| |
| − | Hi everyone,
| |
| − |
| |
| − | Well, things are starting to ramp up again after Summit.
| |
| − |
| |
| − | This week, I've spent some time catching up with other PTLs, and also worked on the DocImpact spec. I've also implemented my plan to get the Speciality Team leads to provide content on their projects individually, so many thanks to them for replying with so much great info!
| |
| − |
| |
| − | == Progress towards Mitaka ==
| |
| − |
| |
| − | 145 days to go!
| |
| − |
| |
| − | 100 bugs closed so far for this release.
| |
| − |
| |
| − | DocImpact
| |
| − | * I've updated the spec and made contact with Infra to nut out the finer technical details: https://blueprints.launchpad.net/openstack-manuals/+spec/review-docimpact
| |
| − |
| |
| − | RST Conversions
| |
| − | * Arch Guide
| |
| − | ** https://blueprints.launchpad.net/openstack-manuals/+spec/archguide-mitaka-rst
| |
| − | ** Contact the Ops Guide Speciality team: https://wiki.openstack.org/wiki/Documentation/OpsGuide
| |
| − | * Ops Guide
| |
| − | ** https://blueprints.launchpad.net/openstack-manuals/+spec/ops-guide-rst
| |
| − | ** Lana will reach out to O'Reilly to discuss the printed book before this work begins
| |
| − | * Config Ref
| |
| − | ** Contact the Config Ref Speciality team: https://wiki.openstack.org/wiki/Documentation/ConfigRef
| |
| − | * Virtual Machine Image Guide
| |
| − | ** https://blueprints.launchpad.net/openstack-manuals/+spec/image-guide-rst and https://review.openstack.org/#/c/244598/
| |
| − |
| |
| − | Reorganisations
| |
| − | * Arch Guide
| |
| − | ** 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
| |
| − |
| |
| − | Document openstack-doc-tools and reorganise index page
| |
| − | * Thanks to Brian and Christian for volunteering to take these on!
| |
| − |
| |
| − | Horizon UX work
| |
| − | * There's an interesting opportunity to improve the wording in Horizon, specifically around LBaaS, and also to develop a set of standards around the language used in the dashboard. If you're interested, let me know and I'll get you in contact with the right people.
| |
| − |
| |
| − | == Speciality Teams ==
| |
| − |
| |
| − | '''HA Guide - Bogdan Dobrelya'''
| |
| − | Created a poll to shift HA guide IRC meeting time (http://lists.openstack.org/pipermail/openstack-docs/2015-November/007830.html). Submitted a status for HA guide testing (http://lists.openstack.org/pipermail/openstack-docs/2015-October/007718.html), hoping to see more participants in testing. Trying to push few patches, and initiated related discussion: https://review.openstack.org/#/c/225418/ and https://review.openstack.org/235893. Thinking on how to effectively collaborate with Adam Spiers and his Openstack HA initiative (http://lists.openstack.org/pipermail/openstack-dev/2015-November/079127.html) to benefit HA guide project as well.
| |
| − |
| |
| − | '''Installation Guide - Christian Berendt'''
| |
| − | Moved the team meeting from Google Hangout to IRC (online at http://eavesdrop.openstack.org/#Documentation_Install_Team_Meeting), we had our first team meeting on the IRC (http://eavesdrop.openstack.org/meetings/docinstallteam/2015/docinstallteam.2015-11-11-01.03.html), we discussed the inclusion of hypervisor specific appendixes, no consensus at the moment, really good progress on the Debian install guide, zigo is doing a good job.
| |
| − |
| |
| − | '''Networking Guide - Edgar Magana'''
| |
| − | We have a new spec for OVN: https://review.openstack.org/#/c/244367/ I am going to start pulling people into specific patches.
| |
| − |
| |
| − | '''Security Guide - Nathaniel Dillon'''
| |
| − | We have added a new chapter on Manila and have completed the reworking of the case studies.
| |
| − |
| |
| − | '''User Guides - Joseph Robinson'''
| |
| − | Our meeting format has changed from hangouts to IRC meetings, with the appropriate changes made to the meetbot script thanks to Brian. The mitaka specification: the priority at the moment is checking in with project docs liaisons to confirm what services are in scope, and then add a short statement to the specification outlining this scope. Responding to Cloud Admin Guide patches. Thanks to Andreas for the link.
| |
| − |
| |
| − | '''Ops and Arch Guides - Shilla Saebi'''
| |
| − | The operations guide RST migration is on hold until we find out if we are going to move forward with docbook or RST. In the meantime we are looking to add content and update it. The architecture guide RST conversion is underway. The progress on chapters and pages can be checked via the wiki page: https://wiki.openstack.org/wiki/Documentation/Migrate
| |
| − |
| |
| − | '''API Docs - Anne Gentle'''
| |
| − | Russell Sim plans to revise the templates for developer.openstack.org landing page to better match docs.openstack.org. We'll also map out a plan for fairy-slipper and the WADL migration. Spec to be updated soon.
| |
| − |
| |
| − | '''Config Ref - Gauvain Pocentek'''
| |
| − | The initial structure for the Config Reference RST migration is up, the automation tools are ready to handle RST tables generation, and a couple pages have already been converted. We're waiting for the liberty branching to start pushing more converted pages.
| |
| − |
| |
| − | '''Training labs - Pranav Salunke'''
| |
| − | Added Kilo support, still under review but in final stages (https://review.openstack.org/#/c/237061/). Halfway through adding KVM support, will probably need more time. Other small things like fixing readmes etc. Still pending to decide IRC meeting time.
| |
| − |
| |
| − | '''Training Guides - Matjaz Pancur'''
| |
| − | Two new core reviewers: Kato Tomoyuki and Tim Freund. We also added a new policy for cores: current lead of Upstream training session (held before each Summit) is now part of the core team by function.
| |
| − |
| |
| − | '''Hyperviser Tuning Guide - Joe Topjian'''
| |
| − | All data from the past etherpads have been compiled onto the wiki (https://wiki.openstack.org/wiki/Documentation/HypervisorTuningGuide). My goal right now is to translate the raw notes into something more readable. Once the page starts to resemble a readable guide, I'll try to rally others to join in.
| |
| − |
| |
| − | == Doc team meeting ==
| |
| − |
| |
| − | We held the APAC docs meeting this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-11-11
| |
| − |
| |
| − | Next meetings:
| |
| − | US: Wednesday 18 November, 14:00 UTC
| |
| − | APAC: Wednesday 25 November, 00:30:00 UTC
| |
| − |
| |
| − | Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting
| |
| − |
| |
| − | --
| |
| − |
| |
| − | Keep on doc'ing!
| |
| − | Lana
| |
| − |
| |
| − | = 6 November 2015 =
| |
| − |
| |
| − | Hi everyone,
| |
| − |
| |
| − | Wow! What a great Summit! And isn't Tokyo a truly beautiful and amazing city? Thank you so much to the Japanese Stackers who hosted us, and to everyone who came along to the docs sessions and helped us hammer out a great plan for Mitaka. I'm very excited about this release!
| |
| − |
| |
| − | This week, I've been catching up with everything that happened during Summit, and also working on outreach tasks. Today, I recorded an interview with Foundation about the project, and I've also published a blog post on the same topic, which will be published soon. You might also like to check out the SuperUser interview Anne and I did about the docs while we were in Tokyo: http://superuser.openstack.org/articles/openstack-documentation-why-it-s-important-and-how-you-can-contribute
| |
| − |
| |
| − | == Progress towards Mitaka ==
| |
| − |
| |
| − | 152 days to go!
| |
| − |
| |
| − | 77 bugs closed so far for this release.
| |
| − |
| |
| − | API Docs
| |
| − | * The API docs are will be switched to swagger: http://specs.openstack.org/openstack/docs-specs/specs/liberty/api-site.html
| |
| − |
| |
| − | DocImpact
| |
| − | * I've removed the WIP from this blueprint, and will be working on this from next week: https://blueprints.launchpad.net/openstack-manuals/+spec/review-docimpact
| |
| − |
| |
| − | RST Conversions
| |
| − | * Arch Guide
| |
| − | ** https://blueprints.launchpad.net/openstack-manuals/+spec/archguide-mitaka-rst
| |
| − | ** Contact the Ops Guide Speciality team: https://wiki.openstack.org/wiki/Documentation/OpsGuide
| |
| − | * Ops Guide
| |
| − | ** https://blueprints.launchpad.net/openstack-manuals/+spec/ops-guide-rst
| |
| − | ** Lana will reach out to O'Reilly to discuss the printed book before this work begins
| |
| − | * Config Ref
| |
| − | ** Thanks for all the offers of help on this one! Please contact the Config Ref Speciality team: https://wiki.openstack.org/wiki/Documentation/ConfigRef
| |
| − |
| |
| − | Reorganisations
| |
| − | * Arch Guide
| |
| − | ** 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
| |
| − |
| |
| − | Training
| |
| − | * Labs
| |
| − | ** https://blueprints.launchpad.net/openstack-manuals/+spec/training-labs
| |
| − | * Guides
| |
| − | ** Upstream University & 'core' component updates, EOL Upstream Wiki page.
| |
| − |
| |
| − | Document openstack-doc-tools
| |
| − | * Need volunteers for this!
| |
| − |
| |
| − | Reorganise index page
| |
| − | * The API docs have already moved off the front page
| |
| − | * We need volunteers to look at the organisation of this page and to write one-sentence summaries of each book
| |
| − |
| |
| − | == Doc team meeting ==
| |
| − |
| |
| − | Meetings will kick off again next week with the APAC meeting:
| |
| − |
| |
| − | APAC: Wednesday 11 November, 00:30:00 UTC
| |
| − | US: Wednesday 18 November, 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 | | 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 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 week I've been working on catching up with some reviews and bug triage, I've been speaking to O'Reilly about the future of the Ops Guide, and also been working on a range of other things including docs-specs core team review, and the addition of Zaqar docs into the user guides.
Just a quick heads up that there won't be a docs newsletter next week, though, as I'm taking a couple of days off (my Mum is coming to visit!), so I'll see you again around 4 December. For those of you in the United States, I hope you all have a lovely Thanksgiving :)
Next meetings:
APAC: Wednesday 25 November, 00:30:00 UTC
US: Wednesday 2 December, 14:00 UTC
