|
|
| Line 21: |
Line 21: |
| | Hi everyone, | | Hi everyone, |
| | | | |
| − | We're hurtling head first to Liberty, with only about a week left to go. I've been working on Summit preparations, and making sure we're ready to go when the time hits. This week, I'm working on Release Notes, keeping an eye on the final Install Guide testing, and some other housekeeping tasks.
| + | 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 is my last docs newsletter before the Liberty release, although I'll endeavour to get a special Summit edition out as well. We will pick up regular meetings (and other tasks, like core team reviews) after the Summit. | + | 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 Liberty == | + | == Progress towards Mitaka == |
| | | | |
| − | 5 days to go!
| + | 152 days to go! |
| | | | |
| − | 601 bugs closed so far for this release.
| + | 77 bugs closed so far for this release. |
| | | | |
| − | * Switch API docs over to swagger http://specs.openstack.org/openstack/docs-specs/specs/liberty/api-site.html (???)
| |
| − | * Implement new docimpact plan: https://blueprints.launchpad.net/openstack-manuals/+spec/review-docimpact
| |
| − | * RST Conversions:
| |
| − | ** Arch Guide: https://blueprints.launchpad.net/openstack-manuals/+spec/archguide-mitaka-rst
| |
| − | ** Ops Guide: https://blueprints.launchpad.net/openstack-manuals/+spec/ops-guide-rst (pending O'Reilly conversation)
| |
| − | ** Config Ref
| |
| − | * Reorganisations:
| |
| − | ** Arch Guide: https://blueprints.launchpad.net/openstack-manuals/+spec/archguide-mitaka-reorg
| |
| − | ** Ops Guide: https://blueprints.launchpad.net/openstack-manuals/+spec/improve-ops-guide
| |
| − | ** User Guides: https://blueprints.launchpad.net/openstack-manuals/+spec/user-guides-reorganised
| |
| − | * Training
| |
| − | ** Labs: https://blueprints.launchpad.net/openstack-manuals/+spec/training-labs
| |
| − | ** Guides: Upstream University & 'core' component updates, EOL Upstream Wiki page.
| |
| − | * First App Guide: testing & improvements
| |
| − | * Reorganise the index page
| |
| − | * Document the openstack-doc-tools
| |
| | | | |
| − | == Release Notes ==
| + | * Switch API docs over to swagger http://specs.openstack.org/openstack/docs-specs/specs/liberty/api-site.html |
| − | | |
| − | Can all PTLs and Cross-Project Liaisons please check the Release Notes page, and ensure they've included all the new features for their project here: https://wiki.openstack.org/wiki/ReleaseNotes/Liberty
| |
| − | | |
| − | The best way to do this (I'm told) is to go through the blueprints created for Liberty. I will be editing these during the next few days, so please ensure you're up to date ASAP. Please contact me directly if you have any questions or problems.
| |
| − | | |
| − | == Mitaka Summit Prep ==
| |
| − | | |
| − | Thank you to everyone who provided suggestions for Design Summit sessions. I've now mangled them into a draft schedule, which is available on Sched: http://mitakadesignsummit.sched.org/type/Documentation
| |
| − | | |
| − | == Doc team meeting ==
| |
| − | | |
| − | The US meeting was held this week. The minutes are here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-10-07
| |
| − | | |
| − | The next meetings will be the final meetings before the Liberty release:
| |
| − | APAC: Wednesday 14 October, 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
| |
| − | | |
| − | --
| |
| − | | |
| − | 東京でお会いしましょう (See you in Tokyo!)
| |
| − | | |
| − | Lana
| |
| − | = 三鷹 Summit Edition =
| |
| − | | |
| − | Hi everyone,
| |
| − | | |
| − | Welcome to the Summit edition of the docs newsletter! Docs have had a wonderfully productive week here in Tokyo, and we've now established a plan for Mitaka. This newsletter covers the more important announcements, and the main points we want to hit in the next release.
| |
| − | | |
| − | Karin has kindly written up the summary of the Design Summit sessions here: https://etherpad.openstack.org/p/Mitaka-Docs-Meetup
| |
| − | | |
| − | == Mitaka Goals ==
| |
| − | | |
| − | This is the list at the moment. There are more notes in the docs etherpads, and not everything has blueprints yet.
| |
| − | | |
| − | * Switch API docs over to swagger http://specs.openstack.org/openstack/docs-specs/specs/liberty/api-site.html (???) | |
| | * Implement new docimpact plan: https://blueprints.launchpad.net/openstack-manuals/+spec/review-docimpact | | * Implement new docimpact plan: https://blueprints.launchpad.net/openstack-manuals/+spec/review-docimpact |
| | * RST Conversions: | | * RST Conversions: |
| Line 100: |
Line 48: |
| | * Reorganise the index page | | * Reorganise the index page |
| | * Document the openstack-doc-tools | | * Document the openstack-doc-tools |
| − |
| |
| − | == Speciality Team Changes ==
| |
| − |
| |
| − | More detail on the Speciality Team wiki page: https://wiki.openstack.org/wiki/Documentation/SpecialityTeams
| |
| − |
| |
| − | * Install Guide is now with Christian Berendt
| |
| − | * HA Guide is now with Bogdan Dobrelya
| |
| − | * Networking Guide is now with Edgar Magana
| |
| − | * New Hypervisor Tuning Guide team with Joe Topjian
| |
| − |
| |
| − | Keep on doc'ing!
| |
| − | Lana
| |
| − |
| |
| − | = 9 October 2015 =
| |
| − |
| |
| − | Hi everyone,
| |
| − |
| |
| − | We're hurtling head first to Liberty, with only about a week left to go. I've been working on Summit preparations, and making sure we're ready to go when the time hits. This week, I'm working on Release Notes, keeping an eye on the final Install Guide testing, and some other housekeeping tasks.
| |
| − |
| |
| − | This is my last docs newsletter before the Liberty release, although I'll endeavour to get a special Summit edition out as well. We will pick up regular meetings (and other tasks, like core team reviews) after the Summit.
| |
| − |
| |
| − | == Progress towards Liberty ==
| |
| − |
| |
| − | 5 days to go!
| |
| − |
| |
| − | 601 bugs closed so far for this release.
| |
| − |
| |
| − | The main things that still need to be done before release:
| |
| − | Testing, testing, testing: https://wiki.openstack.org/wiki/Documentation/LibertyDocTesting
| |
| − | Reviews: https://review.openstack.org/#/q/status:open+project:openstack/openstack-manuals,n,z and https://review.openstack.org/#/q/status:open+project:openstack/api-site,n,z
| |
| − | Bug triage: https://bugs.launchpad.net/openstack-manuals/+bugs?search=Search&field.status=New
| |
| − |
| |
| − | == Release Notes ==
| |
| − |
| |
| − | Can all PTLs and Cross-Project Liaisons please check the Release Notes page, and ensure they've included all the new features for their project here: https://wiki.openstack.org/wiki/ReleaseNotes/Liberty
| |
| − |
| |
| − | The best way to do this (I'm told) is to go through the blueprints created for Liberty. I will be editing these during the next few days, so please ensure you're up to date ASAP. Please contact me directly if you have any questions or problems.
| |
| − |
| |
| − | == Mitaka Summit Prep ==
| |
| − |
| |
| − | Thank you to everyone who provided suggestions for Design Summit sessions. I've now mangled them into a draft schedule, which is available on Sched: http://mitakadesignsummit.sched.org/type/Documentation
| |
| | | | |
| | == Doc team meeting == | | == Doc team meeting == |
| Line 154: |
Line 61: |
| | | | |
| | 東京でお会いしましょう (See you in Tokyo!) | | 東京でお会いしましょう (See you in Tokyo!) |
| − |
| |
| − | Lana
| |
| − |
| |
| − | = 2 October 2015 =
| |
| − |
| |
| − | Hi everyone,
| |
| − |
| |
| − | Welcome to October, which means: it's nearly release day! I've been brushing up on the release management tasks, and continued my housekeeping duties to make sure we're in shape. The next two weeks will be spent watching the Installation Guide pretty closely, and making sure we get it all tested and ready to ship. If you are looking for something to do this week, please treat Install Guide testing as your main priority from here until 15 October. Also, don't forget to vote in the TC election next week!
| |
| − |
| |
| − | == Progress towards Liberty ==
| |
| − |
| |
| − | 12 days to go
| |
| − |
| |
| − | 534 bugs closed so far for this release.
| |
| − |
| |
| − | The main things that still need to be done as we hurtle towards release:
| |
| − | Testing, testing, testing: https://wiki.openstack.org/wiki/Documentation/LibertyDocTesting
| |
| − | Reviews: https://review.openstack.org/#/q/status:open+project:openstack/openstack-manuals,n,z and https://review.openstack.org/#/q/status:open+project:openstack/api-site,n,z
| |
| − | Bug triage: https://bugs.launchpad.net/openstack-manuals/+bugs?search=Search&field.status=New
| |
| − |
| |
| − | == Mitaka Summit Prep ==
| |
| − |
| |
| − | Thank you to everyone who provided suggestions for Design Summit sessions. I've now mangled them into a draft schedule, which looks a little like this:
| |
| − |
| |
| − | Fishbowls (Thursday PM):
| |
| − | - The docs process, plus best practices
| |
| − | - Mitaka planning - deliverables for the next release
| |
| − |
| |
| − | Workrooms (Thursday AM):
| |
| − | - Docs toolchain/infra info session
| |
| − | - IA working session - Ops/Arch Guides & User Guides
| |
| − | - Doc Contributor Guide: new content addition
| |
| − | - API Docs Session
| |
| − |
| |
| − | Meetup (Friday AM):
| |
| − | - Contributors meetup. No agenda. We can assist with setting up devstack/working through the Install Guide during this session
| |
| − |
| |
| − | Once I have access to Cheddar and Sched, I'll get this allocated more accurately. In the meantime, feedback or questions are welcome.
| |
| − |
| |
| − | == Bug Triage Process ==
| |
| − |
| |
| − | The core team have been noticing a lot of people trying to close bugs that haven't been triaged recently. It is very important that you have someone else confirm your bug before you go ahead and create a patch. Waiting just a little while for triage can save you (and our core team!) a lot of work, and makes sure we don't let wayward changes past the gate. If you're unsure about whether you need to wait or not, or if you're in a hurry to work on a bug, you can always ping one of the core team on IRC or on our mailing list. The core team members are listed here, and we're always happy to help you out with a bug or a patch: https://launchpad.net/~openstack-doc-core
| |
| − |
| |
| − | This is even more important than usual as we get closer to the Liberty release, so remember: If it's not triaged, don't fix it!
| |
| − |
| |
| − | == Doc team meeting ==
| |
| − |
| |
| − | The APAC meeting was held this week. The minutes are here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-09-30
| |
| − |
| |
| − | The next meetings will be the final meetings before the Liberty release:
| |
| − | US: Wednesday 7 October, 14:00:00 UTC
| |
| − | APAC: Wednesday 14 October, 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
| |
| − |
| |
| − | --
| |
| − |
| |
| − | Remember, if you have content you would like to add to this newsletter, or you would like to be added to the distribution list, please email me directly at openstack@lanabrindley.com, or visit: https://wiki.openstack.org/w/index.php?title=Documentation/WhatsUpDoc
| |
| − |
| |
| − | Keep on doc'ing!
| |
| | | | |
| | Lana | | Lana |
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:
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
The next meetings will be the final meetings before the Liberty release:
APAC: Wednesday 14 October, 00:30:00 UTC
