Jump to: navigation, search

Difference between revisions of "Documentation/WhatsUpDoc"

(4 September 2015)
(Your suggestions for content)
Line 16: Line 16:
 
* Content
 
* Content
 
* Here
 
* Here
* 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 a few fixes: Fix inclusion of metatags, Remove unused images and javascript files, Fix "Docs Home" link.
 
* https://review.openstack.org/#/c/216364/
 
* training guides
 
* https://www.openstack.org/summit/tokyo-2015/schedule/
 
  
 
= 4 September 2015 =
 
= 4 September 2015 =

Revision as of 06:22, 4 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

  • Add
  • Your
  • Content
  • Here

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 now 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 tyhe 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 more 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

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