Jump to: navigation, search

Documentation/WhatsUpDoc Archive

< Documentation
Revision as of 06:26, 4 September 2015 by Loquacity (talk | contribs)

Contents

21 August 2015

Hi everyone,

First of all, apologies for missing last week's newsletter: I got so caught up in the documentation swarm happening here in Brisbane that it totally slipped my mind! To make up for it, have this week's newsletter a day early :) In swarm news, the two days ran extremely smoothly, much to the credit of Suyog, Brian, and Alex who did the heavy lifting of preparation and organisation. While we focused largely on copy editing, we also had a lot of great discussion about the overall architecture of the book, and now have a draft plan ready for Mitaka, which Darren is driving with the Ops/Arch Guide speciality team.

While last week was all about the docs swarm, this week has been doing the final cleanup on our newly converted RST books. The Security Guide is now up, and the Cloud Admin and HA Guides aren't far behind. We're also about to start testing the Install Guide, now that its conversion is complete. Well done to all the people who have helped out on these efforts, great job!

Progress towards Liberty

55 days to go!

  • RST conversion:
    • Install Guide: Conversion is done, testing to begin soon.
    • Cloud Admin Guide: is complete! The new version will be available on docs.openstack.org very soon.
    • HA Guide: is also done, and will available on the site soon.
    • Security Guide: is complete, and live: http://docs.openstack.org/security-guide/
  • User Guides information architecture overhaul
    • Some user analysis has begun, with a new blueprint to land soon.
  • Greater focus on helping out devs with docs in their repo
    • Work has picked up on the Ironic docs again.
  • Improve how we communicate with and support our corporate contributors
    • If you currently work on documentation for a company that would like to improve their upstream commits for documentation, please contact me!
  • Improve communication with Docs Liaisons
    • I'm very pleased to see liaisons getting more involved in our bugs and reviews. Keep up the good work!
  • Clearing out old bugs
    • Sadly, no action on the spotlight bugs again this week. I'll keep the current three bugs for this week, to give everyone a little more time.

RST Migration

That's it! We're done!

Do you have ideas for which book should be next? Have a think on it, and we'll discuss this at Summit.

Training Guides

I'm happy to announce that the Training Labs are now in their own repo, and are considered a documentation speciality team. Well done to Pranav, Matjaz, Sayali, and Roger for driving this effort.

Countdown to Summit

With the Liberty release less than two months away, that means it's nearly Summit time again: https://www.openstack.org/summit/tokyo-2015/

Here's a few things you might want to be thinking about:

  • Do you need a visa to visit Japan? If so, you need to be organising this NOW: https://www.openstack.org/summit/tokyo-2015/tokyo-and-travel/#visa
  • Do you have an ATC pass? If you haven't received your pass yet, and you're an ATC, please contact me so I can chase this up for you. Remember to use your ATC discount code before 31 August to make sure you get the full price discounted.

Doc team meeting

The APAC meeting was held this week. Read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-08-19

The next meetings are: US: Wednesday 26 August, 14:00:00 UTC APAC: Wednesday 2 September, 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

Spotlight bugs for this week

Let's give these three a little more love:

https://bugs.launchpad.net/openstack-manuals/+bug/1257018 VPNaaS isn't documented in cloud admin

https://bugs.launchpad.net/openstack-manuals/+bug/1257656 VMware: add support for VM diagnostics

https://bugs.launchpad.net/openstack-manuals/+bug/1261969 Document nova server package

--

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

7 August 2015

Hi everyone,

Welcome to August! Today we can finally announce that the Cloud Admin Guide is now completely converted to RST! I have been doing a fair bit of 'behind the scenes' work this week, focusing mainly on Training Guides and our docs licensing. We also welcome another new core team member this week, and for those of you in the APAC region, get ready for the Docs Swarm in Brisbane, where we'll be working on restructuring the Architecture Design Guide.

Progress towards Liberty

68 days to go!

  • User Guides information architecture overhaul
    • Waiting on the RST conversion of the Cloud Admin Guide to be complete
  • Greater focus on helping out devs with docs in their repo
    • Work has stalled on the Ironic docs, we need to pick this up again. Contact me if you want to know more, or are willing to help out.
  • Improve how we communicate with and support our corporate contributors
    • I have been brainstorming ideas with Foundation, watch this space!
  • Improve communication with Docs Liaisons
    • I'm very pleased to see liaisons getting more involved in our bugs and reviews. Keep up the good work!
  • Clearing out old bugs
    • Sadly, no action on the spotlight bugs this week. Perhaps we're all worn out from the RST conversions? I'll keep the current three bugs for this week, to give everyone a little more time.

RST Migration

With the Cloud Admin Guide complete, we are now working on the Install Guide, HA Guide, and the Security Guide. If you would like to assist, please get in touch with the appropriate speciality team:

For books that are now being converted, don't forget that any change you make to the XML must also be made to the RST version until conversion is complete. Our lovely team of cores will be keeping an eye out to make sure loose changes to XML don't pass the gate, but try to help them out by pointing out both patches in your reviews.

Training Guides

I've been working with the Training Guides group and the docs core team to determine the best way to move forward with the Training Guides project. At this stage, we're planning on breaking the project up into a few distinct parts, and bringing Training Guides back into the documentation group as a speciality team. If you have any opinions or ideas on this, feel free to contact me so I can make sure we're considering all the options.

APAC Docs Swarm

We're less than a week away from the APAC doc swarm! This time we'll be working on the Architecture Design Guide. It's to be held at the Red Hat office in Brisbane, on 13-14 August. Check out http://openstack-swarm.rhcloud.com/ for all the info and to RSVP.

Core Team Changes

This month, we welcome KATO Tomoyuki on to our docs core team. Thanks for all your hard work Tomoyuki-san, and welcome to the team!

Doc team meeting

The APAC meeting was held this week. Read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-08-05

The next meetings are: US: Wednesday 12 August, 14:00:00 UTC APAC: Wednesday 19 August, 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

Spotlight bugs for this week

Let's give these three a little more oxygen:

https://bugs.launchpad.net/openstack-manuals/+bug/1257018 VPNaaS isn't documented in cloud admin

https://bugs.launchpad.net/openstack-manuals/+bug/1257656 VMware: add support for VM diagnostics

https://bugs.launchpad.net/openstack-manuals/+bug/1261969 Document nova server package

--

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

31 July 2015

Hi everyone,

This week, like last, was all about the RST conversion. With just a 48 hour long sprint, the Install Guide is almost complete! A hearty congratulations to everyone who contributed. One of the interesting things about doing all these conversions is the amount of conversation it has started about our conventions, and I'm pleased to see that we're really starting to get a feel for how RST can work for us, and what we can demand of it. It's also great to see some related changes to the sphinx theme that handles how we display our shiny RST books.

Progress towards Liberty

75 days to go!

  • User Guides information architecture overhaul
    • Waiting on the RST conversion of the Cloud Admin Guide to be complete
  • Greater focus on helping out devs with docs in their repo
    • Work has stalled on the Ironic docs, we need to pick this up again. Contact me if you want to know more, or are willing to help out.
  • Improve how we communicate with and support our corporate contributors
    • I have been brainstorming ideas with Foundation, watch this space!
  • Improve communication with Docs Liaisons
    • I'm very pleased to see liaisons getting more involved in our bugs and reviews. Keep up the good work!
  • Clearing out old bugs
    • Thanks to Brian for picking up one of the spotlight bugs from last week. Three new bugs to look at this week.

RST Migration

The next books we are focusing on for RST conversion are the Install Guide, Cloud Admin Guide, HA Guide, and the Security Guide. If you would like to assist, please get in touch with the appropriate speciality team:

For books that are now being converted, don't forget that any change you make to the XML must also be made to the RST version until conversion is complete. Our lovely team of cores will be keeping an eye out to make sure loose changes to XML don't pass the gate, but try to help them out by pointing out both patches in your reviews.

Docs Tools

Thanks to Dave for picking up a bug this week and adding a navigation bar to the sidepane of the docs theme for our RST books. We should be releasing an updated docs theme shortly so you can play with this new functionality. In the meantime, if you have suggestions for the docs theme, raise the issue on the docs mailing list, or go right ahead and create a bug for it.

APAC Docs Swarm

The APAC team have been working on holding another doc swarm, this time working on the Architecture Design Guide. It's to be held at the Red Hat office in Brisbane, on 13-14 August. Check out http://openstack-swarm.rhcloud.com/ for all the info.

Doc team meeting

The US meeting got cancelled this week.

The next meetings are: APAC: Wednesday 5 August, 00:30:00 UTC US: Wednesday 12 August, 14:00: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

Spotlight bugs for this week

Three new spotlight bugs for you to sink your teeth into:

https://bugs.launchpad.net/openstack-manuals/+bug/1257018 VPNaaS isn't documented in cloud admin

https://bugs.launchpad.net/openstack-manuals/+bug/1257656 VMware: add support for VM diagnostics

https://bugs.launchpad.net/openstack-manuals/+bug/1261969 Document nova server package

--

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

24 July 2015

Hi everyone,

Wow! What a great week for RST conversion patches! As I write this, there are only a handful of outstanding sections on the Cloud Admin and HA Guides, and well over 40 sections have now been converted on the Install Guide, with the conversion sprint running for another twelve hours or so. Thank you to everyone who has taken the time to grab a section and do a conversion, and to all those people who have given their +1 to a patch. I can't wait to see all our shiny new books up on docs.openstack.org :)

Progress towards Liberty

  • User Guides information architecture overhaul
    • Waiting on the RST conversion of the Cloud Admin Guide to be complete
  • Greater focus on helping out devs with docs in their repo
    • Work has stalled on the Ironic docs, we need to pick this up again. Contact me if you want to know more, or are willing to help out.
  • Improve how we communicate with and support our corporate contributors
    • I have been brainstorming ideas with Foundation, watch this space!
  • Improve communication with Docs Liaisons
    • I'm very pleased to see liaisons getting more involved in our bugs and reviews. Keep up the good work!
  • Clearing out old bugs
    • Sadly, no progress on the spotlight bugs from last week. I'll hold them over for another week, so now is your chance to jump in and grab them!

RST Migration

The next books we are focusing on for RST conversion are the Install Guide, Cloud Admin Guide, HA Guide, and the Security Guide. If you would like to assist, please get in touch with the appropriate speciality team:

For books that are now being converted, don't forget that any change you make to the XML must also be made to the RST version until conversion is complete. Our lovely team of cores will be keeping an eye out to make sure loose changes to XML don't pass the gate, but try to help them out by pointing out both patches in your reviews.

HA Guide Works

With the RST conversion on the HA Guide wrapping up, the HA Guide speciality team are looking for people to help out with the reorganisation and writing the new content. They have quite a few bugs to get through, and they need your help! Contact Matt Griffin, or any other member of the HA Guide Speciality Team, or join their weekly IRC meeting. Details here: https://wiki.openstack.org/wiki/Documentation/HA_Guide_Update

Docs Tools

While they're not strictly docs tools, I wanted to mention review dashboards here today. Did you know that we maintain a list of custom OpenStack review dashboards for you to use? They're customised to show only the reviews you care about, which can save you a lot of time and needless clicking. All you need to do is pick the dashboard you want to use, copy the URL, and save it to your bookmarks. Anne has just updated the Docs Review Inbox dashboard to include DocImpact reviews, so it's worth checking out: http://ghostcloud.net/openstack_gerrit_dashboards/dashboard_doc-program.html You can see the full list here: http://ghostcloud.net/openstack_gerrit_dashboards/

APAC Docs Swarm

The APAC team have been working on holding another doc swarm, this time working on the Architecture Design Guide. It's to be held at the Red Hat office in Brisbane, on 13-14 August. Check out http://openstack-swarm.rhcloud.com/ for all the info.

Doc team meeting

The APAC docs meeting was held this week, catch up on the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-07-22

The next meetings are: US: Wednesday 29 July, 14:00:00 UTC APAC: Wednesday 5 August, 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

Spotlight bugs for this week

Giving these three poor old bugs some extra oxygen:

https://bugs.launchpad.net/openstack-manuals/+bug/1241116 Using policies for protected properties

https://bugs.launchpad.net/openstack-manuals/+bug/1241179 Add notifications for groups and roles

https://bugs.launchpad.net/openstack-manuals/+bug/1251060 Xenapi: Allow windows builds with xentools 6.1 and 6.2

--

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

17 July 2015

Hi everyone,

I'm very pleased to announce that we finally have a name for our M release: Mitaka (三鷹)! Accordingly, the Tokyo Summit for the Mitaka release is only just over 100 days away. CFP closed a couple of days ago, and I've noticed that the first round of ATC discount codes have gone out. If you haven't got yours yet, then keep patching Liberty and sit tight. The discount codes will come out in stages after every snapshot. This week, we've had some great discussions about networking scenarios in the Install Guide, and the best way to include RST files in our newly converted books. We also have both the HA Guide and the Cloud Admin Guide conversions in their final stages, and the Install Guide conversion sprint coming up. Very exciting!

Progress towards Liberty

  • User Guides information architecture overhaul
    • Waiting on the RST conversion of the Cloud Admin Guide to be complete
  • Greater focus on helping out devs with docs in their repo
    • Work has stalled on the Ironic docs, we need to pick this up again. Contact me if you want to know more, or are willing to help out.
  • Improve how we communicate with and support our corporate contributors
    • I have been brainstorming ideas with Foundation, watch this space!
  • Improve communication with Docs Liaisons
    • I'm very pleased to see liaisons getting more involved in our bugs and reviews. Keep up the good work!
  • Clearing out old bugs
    • A small amount of progress on the old bugs we held over from last week. New ones to check out in this newsletter!

RST Migration

The next books we are focusing on for RST conversion are the Install Guide, Cloud Admin Guide, HA Guide, and the Security Guide. If you would like to assist, please get in touch with the appropriate speciality team:

For books that are now being converted, don't forget that any change you make to the XML must also be made to the RST version until conversion is complete. Our lovely team of cores will be keeping an eye out to make sure loose changes to XML don't pass the gate, but try to help them out by pointing out both patches in your reviews.

Install Guide RST Conversion Sprint

In order to kick off the RST conversion of the Install Guide, the speciality team have decided to run a virtual conversion sprint over two days on July 22-24. For more information, see the https://wiki.openstack.org/wiki/VirtualSprints#Installation_guide_conversion_from_DocBook_to_RST wiki page, and the https://etherpad.openstack.org/p/installguide-rst-virtual-sprint etherpad.

HA Guide Works

With the RST conversion on the HA Guide wrapping up, the HA Guide speciality team are looking for people to help out with the reorganisation and writing the new content. They have quite a few bugs to get through, and they need your help! Contact Matt Griffin, or any other member of the HA Guide Speciality Team, or join their weekly IRC meeting. Details here: https://wiki.openstack.org/wiki/Documentation/HA_Guide_Update

Docs Tools

Last week, we released openstackdocstheme 1.1.0, see http://lists.openstack.org/pipermail/openstack-announce/2015-June/000392.html. The main new features in this release are improvements for bug reporting, variable lists like the glossary are now indented, and next/prev links are now icons on the upper right part of the page.

Additionally, the stable/icehouse branch of openstack-manuals has been EOLed, no further updates will be done from it. For more information, see http://lists.openstack.org/pipermail/openstack-infra/2015-July/002888.html

Doc team meeting

The next meetings are:

APAC: Wednesday 22 July, 00:30:00 UTC

US: Wednesday 29 July, 14:00: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

Spotlight bugs for this week

We've now got people assigned to work on last week's old bugs, which is great! Here are three more rusty old bugs that could use some love:

https://bugs.launchpad.net/openstack-manuals/+bug/1241116 Using policies for protected properties

https://bugs.launchpad.net/openstack-manuals/+bug/1241179 Add notifications for groups and roles

https://bugs.launchpad.net/openstack-manuals/+bug/1251060 Xenapi: Allow windows builds with xentools 6.1 and 6.2

--

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

10 July 2015

Hi everyone,

First of all, apologies for my absence over the past couple of weeks. I took some time off to spend with my daughter while she was on school holidays, and then got ill! It never rains but it pours ;) While I was out, our M release was named, and then unnamed, and we're now waiting for a new name. We also had a great discussion about which networking scenario is the best fit for our new-and-improved Installation Guide, and planned a sprint to get the RST conversion for that book happening. More on that in this newsletter.

Progress towards Liberty

  • User Guides information architecture overhaul
    • Waiting on the RST conversion of the Cloud Admin Guide to be complete
  • Greater focus on helping out devs with docs in their repo
    • Work has started on the Ironic docs, we're now trying to resolve some issues with service name standards ("Bare Metal" or "Bare metal"?). Contact me if you want to know more, or are willing to help out.
  • Improve how we communicate with and support our corporate contributors
    • I have been brainstorming ideas with Foundation, watch this space!
  • Improve communication with Docs Liaisons
    • I'm very pleased to see liaisons getting more involved in our bugs and reviews. Keep up the good work!
  • Clearing out old bugs
    • Sadly, no progress this week.

RST Migration

The next books we are focusing on for RST conversion are the Install Guide, Cloud Admin Guide, HA Guide, and the Security Guide. If you would like to assist, please get in touch with the appropriate speciality team:

For books that are now being converted, don't forget that any change you make to the XML must also be made to the RST version until conversion is complete. Our lovely team of cores will be keeping an eye out to make sure loose changes to XML don't pass the gate, but try to help them out by pointing out both patches in your reviews.

Install Guide RST Conversion Sprint

In order to kick off the RST conversion of the Install Guide, the speciality team have decided to run a virtual conversion sprint over two days on July 22-24. For more information, see the https://wiki.openstack.org/wiki/VirtualSprints#Installation_guide_conversion_from_DocBook_to_RST wiki page, and the https://etherpad.openstack.org/p/installguide-rst-virtual-sprint etherpad.

New core team

The core team have just completed our review for July, and would like to welcome two new core contributors: Alexandra Settle, and Olena Logvinova. Congratulations to you both :)

Doc team meeting

The APAC meeting was cancelled this week, our next meetings are:

US: Wednesday 15 July, 14:00:00 UTC (note that this has NOT changed with daylight savings time) APAC: Wednesday 22 July, 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

Spotlight bugs for this week

Sadly, even with an extra week, our three spotlight bugs remain unloved. I'm going to keep them here for another week, so now is your chance to swoop in and make a difference!

https://bugs.launchpad.net/openstack-manuals/+bug/1212349 vmware documentation

https://bugs.launchpad.net/openstack-manuals/+bug/1212687 xenapi

https://bugs.launchpad.net/openstack-manuals/+bug/1239308 Add notifications for groups and roles

--

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

26 June 2015

Hi everyone,

First of all, our M release has been named! Sadly, it hasn't cleared legal yet, so we can't publicly announce it, however, here are the poll results: http://civs.cs.cornell.edu/cgi-bin/results.pl?id=E_4983776e190c8dbc It was a close-run contest!

This week, I've been continuing to dust off some old bugs, and have been chatting to a few of our docs liaisons to work out how we can best get them engaged with what we're working on. I've also been spending a lot of time on standards questions, and thinking about the future of the DocImpact flag.

Progress towards Liberty

  • User Guides information architecture overhaul
    • Waiting on the RST conversion of the Cloud Admin Guide to be complete
  • Greater focus on helping out devs with docs in their repo
    • Work has started on the Ironic docs, we're now trying to resolve some issues with service name standards ("Bare Metal" or "Bare metal"?). Contact me if you want to know more, or are willing to help out.
  • Improve how we communicate with and support our corporate contributors
    • No progress this week
  • Improve communication with Docs Liaisons
    • I'm very pleased to see liaisons getting more involved in our bugs and reviews. Keep up the good work!
  • Clearing out old bugs
    • Thanks to Yusuke-san for closing bug 1330005!

RST Migration

The next books we are focusing on for RST conversion are the Install Guide, Cloud Admin Guide, HA Guide, and the Security Guide. If you would like to assist, please get in touch with the appropriate speciality team:

For books that are now being converted, don't forget that any change you make to the XML must also be made to the RST version until conversion is complete. Our lovely team of cores will be keeping an eye out to make sure loose changes to XML don't pass the gate, but try to help them out by pointing out both patches in your reviews.

Docs Tools

Andreas and Nick just released openstack-docs-tools 0.29.1, after we discovered an RST translation bug in 0.29. Thanks for the quick turnaround on that!

Documentation Standards

There's been quite a lot of conversation this week over capitalisation of service names, with the community divided down the middle as to which we prefer! While we all enjoy a good style discussion, I've also asked Anne (in her role on the TC) to confirm the legal restrictions for us. Watch this space! In the meantime, continue to discuss this on the mailing list :)

Docs Liaisons

Don't forget that we have subject matter experts to help you with documentation questions that you might have. One of the best ways to get our liaisons' attention is to add them to a bug or a patch. Feel free to look up the liaison for the project you're working with, and add them to the cc list for your patch:

https://wiki.openstack.org/wiki/CrossProjectLiaisons#Documentation

Doc team meeting

The APAC meeting was held this week, see the minutes here to catch up: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-06-24

Next meetings are: US: Wednesday 1 July, 14:00:00 UTC (note that this has NOT changed with daylight savings time) APAC: Wednesday 8 July, 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

Spotlight bugs for this week

Of the three bugs we spotlighted last week, one of them was closed (thanks Yusuke-san!), and the other two are still up for grabs. Olga is working on a Spotlight bug from last week, too. Let's keep the momentum, with another three sad old bugs that could use some love:

https://bugs.launchpad.net/openstack-manuals/+bug/1212349 vmware documentation

https://bugs.launchpad.net/openstack-manuals/+bug/1212687 xenapi

https://bugs.launchpad.net/openstack-manuals/+bug/1239308 Add notifications for groups and roles

--

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

19 June 2015

Hi everyone,

This week, I've been working on helping out the Ironic team to sort out their Install Guide (thanks have to go to Gauvain and Nick, who have offered to help out with writing assistance here), and trying to come up with some better ways to work with the i18n team, and our docs liaisons. More on all of that further in.

Progress towards Liberty

  • User Guides information architecture overhaul
    • Waiting on the RST conversion of the Cloud Admin Guide to be complete
  • Greater focus on helping out devs with docs in their repo
    • We now have a team starting to form to work on Ironic docs. Contact me if you want to know more, or are willing to help out.
  • Improve how we communicate with and support our corporate contributors
    • No progress this week
  • Improve communication with Docs Liaisons
    • I have now reached out to liaisons. More later in this newsletter.
  • Clearing out old bugs
    • Thanks to Tom for closing bug 1195875. Let's keep up the great work!

RST Migration

The next books we are focusing on for RST conversion are the Install Guide, Cloud Admin Guide, HA Guide, and the Security Guide. If you would like to assist, please get in touch with the appropriate speciality team:

For books that are now being converted, don't forget that any change you make to the XML must also be made to the RST version until conversion is complete. Our lovely team of cores will be keeping an eye out to make sure loose changes to XML don't pass the gate, but try to help them out by pointing out both patches in your reviews.

Docs Tools

Andreas will shortly be updating openstack-docs-tools to 0.29.

Docs Liaisons

Don't forget that we have subject matter experts to help you with documentation questions that you might have. As you're working on bugs, feel free to give them a quick ping or an email to ask questions. They promise not to laugh at you!

https://wiki.openstack.org/wiki/CrossProjectLiaisons#Documentation

i18n Team

At Summit, I spent a lot of time with Ying Chun Guo (Daisy) from the translation team, to try and come up with a way we can make sure our teams are working together better. To that end, we've got a few ideas we're going to be implementing over the next few weeks. First of all, this newsletter now goes direct to the the translation mailing list, as well the dev and doc lists (hi translators!). Secondly, Daisy is going to poll her team to identify an i18n documentation liaison, who will be the go-to person for all questions about translation for docs. The other thing we're going to do is to make sure we're helping the i18n team to keep their status page up to date: https://wiki.openstack.org/wiki/I18nTeam/docs-translation#Document_categorize If you're working on a doc that is translated, please check that table and make sure the translation team know what you're up to! This will help prevent needless effort on their part, which benefits us all in the end.

Doc team meeting

The US meeting was held this week, see the minutes here to catch up: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-06-17

Apologies for the timing confusion on that one, it seems as though daylight savings changes took us by surprise. For now, the meeting will remain at 1400UTC. If you would prefer it to be at a different time, bring it up on the mailing list, or in the next US meeting.

Next meetings are: APAC: Wednesday 24 June, 00:30:00 UTC US: Wednesday 1 July, 14:00: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

Spotlight bugs for this week

Of the three bugs we spotlighted last week, one of them got marked as invalid (thanks Tom!), and another is in progress with SME assistance (thanks Olga!). That's great! Here's another three dusty old bugs that could use a polish up:

https://bugs.launchpad.net/openstack-manuals/+bug/1330005 Glance image properties and values (low hanging fruit)

https://bugs.launchpad.net/openstack-manuals/+bug/1394397 Nova notification_driver

https://bugs.launchpad.net/openstack-manuals/+bug/1205402 iPXE ISO boot support

--

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

12 June 2015

Hi everyone,

This week, I've been spending some time in the dustier corners of our bug list. Do you know we currently have over 500 bugs open?! Scroll down to the bottom of this newsletter for more on what we're going to do about that.

If you have content you would like to add, or you would like to be added to the distribution list, please email me directly at openstack@lanabrindley.com. If you want to see my early drafts and typos, or check on old newsletters, you can do so here: https://wiki.openstack.org/w/index.php?title=Documentation/WhatsUpDoc

Progress towards Liberty

  • RST conversion:
  • User Guides information architecture overhaul
    • Waiting on the RST conversion of the Cloud Admin Guide to be complete
  • Greater focus on helping out devs with docs in their repo
    • Discussion with the Ironic team was started this week. We need a Speciality Team to take on this work.
  • Improve how we communicate with and support our corporate contributors
    • No progress this week
  • Improve communication with Docs Liaisons
  • Clearing out old bugs
    • I went through and pruned a lot of two- and three-year old bugs from the list. Please review and re open any you think still require tracking.
    • As part of this effort, I will be picking out a few old bugs to be spotlighted in each newsletter. Please take a look as they come up and see what you can do to help!

RST Migration

The next books we are focusing on for RST conversion are the Install Guide, Cloud Admin Guide, HA Guide, and the Security Guide. If you would like to assist, please get in touch with the appropriate speciality team:

For books that are now being converted, don't forget that any change you make to the XML must also be made to the RST version until conversion is complete. Our lovely team of cores will be keeping an eye out to make sure loose changes to XML don't pass the gate, but try to help them out by pointing out both patches in your reviews.

RST Common Files

We're coming across some build issues in the RST books with common files. If you have a common file in the ToC of a guide, please move it into the source file of that guide to prevent build issues. Using :orphan: directive marking on the file can also prevent sphinx marking the doc as an error.

Bug triaging

This week, the core team have noticed a lot of patches that have had to be cancelled, because they were fixing untriaged bugs. If you want to work on a bug, be sure that a core reviewer has triaged it before you create a patch. This will stop you spending time on patches that might not get accepted. We should now have core team available in most timezones, so if you need a bug looked at so you can get started quickly, ping the docs IRC channel, and a core should be around to help you out.

Doc team meeting

The APAC meeting was held this week, see the minutes here to catch up: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-06-10

Next meetings are: US: Wednesday 17 June, 14:00:00 UTC APAC: Wednesday 24 June, 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

Spotlight bugs for this week

This is a way of trying to get some eyeballs on old bugs, in an attempt to pay down some of our technical debt. Kudos to Tom Fifield who helped me work out what to do about them! Each week, I'll spotlight a few old bugs here for people to go and look at and determine if they're still valid or not. Please check out these bugs, let's have a conversation (in the bug comments), and if you can close them, do so! To make this slightly more exciting, I'll be attempting to keep track of who is closing these old bugs, and will see if I can't put together a little care package to send the way of anyone who makes a real difference here.

https://bugs.launchpad.net/openstack-manuals/+bug/1195875 Controller Callbacks

https://bugs.launchpad.net/openstack-manuals/+bug/1201978 Pluggable Remote User

https://bugs.launchpad.net/openstack-manuals/+bug/1204566 Stop and delete operations


Keep on doc'ing!

Lana

5 June 2015

Hi everyone,

With our Kilo branch now cut, we're running headlong into the Liberty development cycle! And don't forget to have your say on what the M release should be called: https://wiki.openstack.org/wiki/Release_Naming/M_Proposals

If you have content you would like to add, or you would like to be added to the distribution list, please email me directly at openstack@lanabrindley.com. I've also decided to start drafting these 'in the open' (as it were). If you want to see my early drafts and typos, or check on old newsletters, you can do so here: https://wiki.openstack.org/w/index.php?title=Documentation/WhatsUpDoc

Progress towards Liberty

  • RST conversion:
  • User Guides information architecture overhaul
    • Waiting on the RST conversion of the Cloud Admin Guide to be complete
  • Greater focus on helping out devs with docs in their repo
    • No progress this week
  • Improve how we communicate with and support our corporate contributors
    • I met with Alison of Oracle to discuss how we can help out their team
  • Improve communication with Cross Team Liaisons

Kilo Branching

Thanks to Andreas, Anne, and Tom for getting the Stable/Kilo branch completed this week. With this, Kilo is now complete* and patches for the Install Guide and the Config Reference will now be against Liberty unless you specifically backport a change to Kilo. You can do this by committing to master with the line Backport: Kilo in your commit message. Remember that all other book are continuously integrated, and this isn't necessary.

[*] Anne: feel free to go have a lie down ;)

RST Migration

The next books we are focusing on for RST conversion are the Install Guide, Cloud Admin Guide, and the HA Guide. If you would like to assist, please get in touch with the appropriate speciality team.


For books that are now being converted, don't forget that any change you make to the XML must also be made to the RST version until conversion is complete. Our lovely team of cores will be keeping an eye out to make sure loose changes to XML don't pass the gate, but try to help them out by pointing out both patches in your reviews.

New Core Reviewer Process

We did our first monthly round of Core Team review this week, and would like to welcome our newest core team member, Darren Chan. We also bid a fond farewell to Summer Long and Bryan Payne, who have been great core team members and contributors, but have now moved on to other adventures. We sincerely thank them both for their commitment over the time they were core.

The new core process is documented here: https://wiki.openstack.org/wiki/Documentation/HowTo#Achieving_core_reviewer_status The next round will be around 1 July.

Doc team meeting

The US meeting was held this week, see the minutes here to catch up: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-06-03

Thanks Shilla for running the US team meeting!

Next meetings are: APAC: Wednesday 10 June, 00:30:00 UTC US: Wednesday 17 June, 14:00: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

Thanks! Lana


29 May 2015

Hi everyone,

Continuing in Anne's fine tradition, I intend to send these out every Friday. If you have content you would like to add, or you would like to be added to the distribution list, please email me directly at openstack@lanabrindley.com. I've also decided to start drafting these 'in the open' (as it were). If you want to see my early drafts and typos, or check on old newsletters, you can do so here: https://wiki.openstack.org/w/index.php?title=Documentation/WhatsUpDoc

Design Summit

The Design Summit was a great success. We had ten sessions for docs overall, including two workgroups and a contributors' meetup. Thanks to everyone who came along (or participated remotely!) and had their say on the Liberty release. I've been spending time gathering my thoughts after the Summit, and have summarised the etherpad notes on the wiki here: https://wiki.openstack.org/w/index.php?title=Documentation/Liberty You can also see the original etherpads here: https://wiki.openstack.org/wiki/Design_Summit/Liberty/Etherpads#Documentation

In short, the main things I would like us to achieve for Liberty are:

  • RST conversion: Install Guide, Cloud Admin Guide, HA Guide
  • User Guides information architecture overhaul.
  • Greater focus on helping out devs with docs in their repo
  • Improve how we communicate with and support our corporate contributors


If you have a burning issue that didn't get addressed during the Summit, or that you think I've forgotten, now would be your chance to tell me about it! Look out for Blueprints and Specs for this work over the next couple of weeks.

RST Migration

The next books we are focusing on for RST conversion are the Install Guide, Cloud Admin Guide, and the HA Guide. If you would like to assist, please get in touch with the appropriate speciality team.


New Core Reviewer Process

One of the simpler changes I was asked to implement at the Design Summit was a new core reviewer process, with the aim of making it a more balanced approach to selecting core team members. We decided on a process that combines a monthly statistics-based selection process with a continuous nomination-based process. I've written up the details on the HowTo here: https://wiki.openstack.org/wiki/Documentation/HowTo#Achieving_core_reviewer_status and will implement the first round on 1 June.

Doc team meeting

APAC meeting was held this week, see the minutes here to catch up: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-05-27

Thanks to Joe for holding the APAC fort while I was travelling!

Next meetings are: US: Wednesday 3 June, 14:00:00 UTC APAC: Wednesday 10 June, 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

Thanks! Lana

Retrieved from "https://wiki.openstack.org/w/index.php?title=Documentation/WhatsUpDoc_Archive&oldid=89565"