Jump to: navigation, search

Difference between revisions of "Documentation/WhatsUpDoc"

(→‎25 September 2015)
(→‎Progress towards Liberty)
Line 30: Line 30:
 
534 bugs closed so far for this release.
 
534 bugs closed so far for this release.
  
−
The main areas of focus we had during Liberty were the RST migration, paying down some of our technical debt, and improving our general communication issues. The RST conversion is well and truly complete, with just a couple of books waiting in the wings to be published. We have made some progress on improving our communication generally, with liaisons now more visible involved, and some improved processes. Regarding old bugs, during Liberty we spotlighted a total of 24 bugs, exactly half of which have now been closed. This is a great effort to clear out some old dusty bugs and pay down some technical debt. Thanks go out to Tom Fifield, Olga Gusarenko, Yusuke Ide, Brian Moss, Deena Cooper, and Alexandra Settle for taking some of these on! With Liberty and the Summit bearing down on us, though, let's focus back on what needs to be done for release. At Summit, we'll discuss how to expand and improve on this effort in future releases.
+
The main areas of focus we had during Liberty were the RST migration, paying down some of our technical debt, and improving our general communication issues.  
 +
The RST conversion is well and truly complete, with just a couple of books waiting in the wings to be published. We have made some progress on improving our communication generally, with liaisons now more visible involved, and some improved processes. Regarding old bugs, during Liberty we spotlighted a total of 24 bugs, exactly half of which have now been closed.
  
 
== Mitaka Summit Prep ==
 
== Mitaka Summit Prep ==

Revision as of 04:47, 25 September 2015

Documentation Newsletters

This is where I draft the 'What's Up, Doc?' documentation newsletters. The newsletter is distributed every Friday (ish), to the openstack-docs mailing list. If you want to be added to the distribution list, or have content to add, please edit these sections:

You can see older newsletters here: Documentation/WhatsUpDoc_Archive

Distribution List

Your suggestions for content

25 September 2015

Hi everyone,

First of all, thank you to everyone who has suggested sessions for docs at Tokyo. I'll keep the etherpad open for another week or so, just to give everyone a chance, and will start working on a draft schedule next week. I have spent most of this week on bug triage, which is repetitive work, but it's gratifying to see the numbers drop a little!

Progress towards Liberty

19 days to go

534 bugs closed so far for this release.

The main areas of focus we had during Liberty were the RST migration, paying down some of our technical debt, and improving our general communication issues. The RST conversion is well and truly complete, with just a couple of books waiting in the wings to be published. We have made some progress on improving our communication generally, with liaisons now more visible involved, and some improved processes. Regarding old bugs, during Liberty we spotlighted a total of 24 bugs, exactly half of which have now been closed.

Mitaka Summit Prep

The schedule app for your phone is now available. This is a great tool once you're on the ground at Summit: https://itunes.apple.com/WebObjects/MZStore.woa/wa/viewSoftware?id=987216292&mt=8 (Apple) and https://play.google.com/store/apps/details?id=org.sched.openstacksummitmay2015vancouver (Android)

Docs have been allocated two fishbowls, four workrooms, and a half day meetup, so now is the time to start gathering ideas for what you would like to see us cover. Add your ideas to the etherpad here: https://etherpad.openstack.org/p/Tokyo-DocsSessions I'll create a draft session based on this feedback next week.

Doc team meeting

The US meeting was held this week. The minutes are here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-09-23

The next meetings will be the final meetings before the Liberty release: APAC: Wednesday 30 September, 00:30:00 UTC US: Wednesday 7 October, 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

--

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

18 September 2015

Hi everyone,

First of all, with PTL candidacy now closed, it appears that I will be continuing to hold the docs reins through to Mitaka. Thank you to all of you who contacted me personally over the last week or so, expressing their support. I'm very honoured to be leading such a great team, and I'm looking forward to continuing to serve you. As always, my door will continue to be open to ideas, comments, and criticism, so please keep telling me what you do and don't like!

We're less than a month away from the Liberty release now, and with the Mitaka PTL question settled, I'll be working on Design Summit session planning over the next few weeks. I've created an etherpad to gather your ideas, more on that in this newsletter. In other news, testing is now well underway on the Install Guide, I've knocked our existing blueprints into order, been doing some thinking about the DocImpact script, and worked with the speciality teams on determining the final work items for Liberty.

Progress towards Liberty

26 days to go

514 bugs closed so far for this release.

  • RST conversion:
    • Done.
  • User Guides information architecture overhaul
    • Underway. Some tasks to be held over to Mitaka.
  • Greater focus on helping out devs with docs in their repo
    • A certain amount of progress has been made here, and some wrinkles sorted out which will improve this process for the future.
  • Improve how we communicate with and support our corporate contributors
    • I'm still trying to come up with great ideas for this, please let me know what you think.
  • 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
    • Great work this week, with two bugs from the last two weeks closed (thanks Deena and Tom!). Three new bugs this week.

Mitaka Summit Prep

The schedule app for your phone is now available. This is a great tool once you're on the ground at Summit: https://itunes.apple.com/WebObjects/MZStore.woa/wa/viewSoftware?id=987216292&mt=8 (Apple) and https://play.google.com/store/apps/details?id=org.sched.openstacksummitmay2015vancouver (Android)

Docs have been allocated two fishbowls, four workrooms, and a half day meetup, so now is the time to start gathering ideas for what you would like to see us cover. Add your ideas to the etherpad here: https://etherpad.openstack.org/p/Tokyo-DocsSessions

Outstanding Specs

  • Third Party Driver Content: This spec has been outstanding for a while, and we've finally reached a consensus on how to move forward. Please take a moment to review the spec here before we go ahead merge it: https://review.openstack.org/#/c/191041/

Doc team meeting

The APAC meeting was held this week. The minutes are here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-09-16

The next meetings are: US: Wednesday 23 September, 14:00:00 UTC APAC: Wednesday 30 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 show these three that we're never going to give them up, never going to let them down:

https://bugs.launchpad.net/openstack-manuals/+bug/1293328 Review Identity & LDAP integration

https://bugs.launchpad.net/openstack-manuals/+bug/1294726 Update Cloud Administration Guide for OpenDaylight ML2 MechanismDriver

https://bugs.launchpad.net/openstack-manuals/+bug/1300960 Making DB sanity checking be optional for DB migration

--

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

11 September 2015

Hi everyone,

Things are really starting to heat up now! Summit preparations are well underway, PTL elections just opened, and testing is proceeding apace on the Install Guide. As well as preparing my candidacy for Mitaka Docs PTL, I've been continuing to sort out the outstanding blueprints, and also planning for some announcements in Tokyo. One of the interesting things I learned while compiling a list of Liberty achievements is that we have released fixes for nearly 500 bugs since Kilo was released. What an amazing achievement!

Progress towards Liberty

33 days to go

496 bugs closed so far.

  • RST conversion:
    • Done.
  • User Guides information architecture overhaul
    • This is now well underway.
  • Greater focus on helping out devs with docs in their repo
    • A certain amount of progress has been made here, and some wrinkles sorted out which will improve this process for the future.
  • Improve how we communicate with and support our corporate contributors
    • I'm still trying to come up with great ideas for this, please let me know what you think.
  • 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
    • We've had some solid progress on last week's bugs, with two assigned, and one of those in progress. Three new bugs this week.

Mitaka Summit Prep

The schedule has now been released, congratulations to everyone who had a talk accepted this time around: https://www.openstack.org/summit/tokyo-2015/schedule/

All ATCs should have received their pass by now, so now is the time to be booking your travel and accommodation: https://www.openstack.org/summit/tokyo-2015/tokyo-and-travel/

Docs have been given their design summit session allocation, so start thinking about what you would like to see discussed. I'll send out an etherpad to start planning in the next week or two.

Conventions

A new governance patch has landed which changes the way we capitalise service names (I know almost exactly 50% of you will be happy about this!): https://wiki.openstack.org/wiki/Documentation/Conventions#Service_and_project_names Please be aware of this when editing files, and remember that the 'source of truth' for these things is the projects.yaml file: http://git.openstack.org/cgit/openstack/governance/tree/reference/projects.yaml

Doc team meeting

The US meeting was held this week. The minutes are here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-09-09

The next meetings are: APAC: Wednesday 16 September, 00:30:00 UTC US: Wednesday 23 September, 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

Let's show these three how much we care:

https://bugs.launchpad.net/openstack-manuals/+bug/1284301 Document Neutron SSL-VPN for cloudadmin

https://bugs.launchpad.net/openstack-manuals/+bug/1288044 Add user defined extra capabilities

https://bugs.launchpad.net/openstack-manuals/+bug/1292327 Make cors work better

--

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

4 September 2015

Hi everyone,

This has been a fairly busy week, with Summit preparations beginning, more newly migrated RST books going live, and testing starting on the Install Guide. I've been spending time on sorting out the Liberty blueprints still outstanding, and also working on some old bugs.

Progress towards Liberty

40 days to go!

  • RST conversion:
    • Is now completed! Well done and a huge thank you to everyone who converted pages, approved reviews, and participated in publishing the new guides. This was a truly phenomenal effort :)
  • Greater focus on helping out devs with docs in their repo
    • A certain amount of progress has been made here, and some wrinkles sorted out which will improve this process for the future.
  • 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
    • The last lot of old bugs are still languishing. I'm assuming you all hate them so very much that I've decided to give you three more to pick from. Have at it!

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/

The schedule has now been released, congratulations to everyone who had a talk accepted this time around: https://www.openstack.org/summit/tokyo-2015/schedule/

All ATCs should have received their pass by now, so now is the time to be booking your travel and accommodation: https://www.openstack.org/summit/tokyo-2015/tokyo-and-travel/

Conventions

A new governance patch has landed which changes the way we capitalise service names (I know almost exactly 50% of you will be happy about this!): https://wiki.openstack.org/wiki/Documentation/Conventions#Service_and_project_names Please be aware of this when editing files, and remember that the 'source of truth' for these things is the projects.yaml file: http://git.openstack.org/cgit/openstack/governance/tree/reference/projects.yaml

Docs Tools

openstack-doc-tools 0.30.0 and openstackdocstheme 1.2.1 have been released. openstack-doc-tools allows translation of the Install Guide. openstackdocstheme contains fixes for the inclusion of metatags, removes unused images and javascript files, and fixes the "Docs Home" link.

Doc team meeting

The APAC meeting was not held this week. The minutes from the previous US meeting are here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-08-26

The next meetings are: US: Wednesday 9 September, 14:00:00 UTC APAC: Wednesday 16 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 love:

https://bugs.launchpad.net/openstack-manuals/+bug/1280092 end user guide lacks doc on admin password injection

https://bugs.launchpad.net/openstack-manuals/+bug/1282765 Chapter 6. Block Storage in OpenStack Cloud Administrator Guide

https://bugs.launchpad.net/openstack-manuals/+bug/1284215 Driver for IBM SONAS and Storwize V7000 Unified

--

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

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