Difference between revisions of "Documentation/WhatsUpDoc"
(→7 August 2015) |
|||
Line 16: | Line 16: | ||
* Content | * Content | ||
* Here | * Here | ||
+ | |||
+ | = 21 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! | ||
+ | |||
+ | * RST conversion: | ||
+ | ** Install Guide: Conversion is nearly done, sign up here: https://wiki.openstack.org/wiki/Documentation/Migrate#Installation_Guide_Migration | ||
+ | ** Cloud Admin Guide: is complete! The new version will be available on docs.openstack.org very soon. | ||
+ | ** HA Guide: is also nearly done. Get in touch with Meg or Matt: https://wiki.openstack.org/wiki/Documentation/HA_Guide_Update | ||
+ | ** Security Guide: Conversion is now underway, sign up here: https://etherpad.openstack.org/p/sec-guide-rst | ||
+ | |||
+ | * 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: | ||
+ | |||
+ | * Install Guide: | ||
+ | ** Contact Karin Levenstein <karin.levenstein@rackspace.com> | ||
+ | ** Sign up here: https://wiki.openstack.org/wiki/Documentation/Migrate#Installation_Guide_Migration | ||
+ | |||
+ | * HA Guide | ||
+ | ** Contact Meg McRoberts <dreidellhasa@yahoo.com> or Matt Griffin <me@mattgriffin.com> | ||
+ | ** Blueprint: https://blueprints.launchpad.net/openstack-manuals/+spec/improve-ha-guide | ||
+ | |||
+ | * Security Guide | ||
+ | ** Contact Nathaniel Dillon <nathaniel.dillon@hp.com> | ||
+ | ** Info: https://etherpad.openstack.org/p/sec-guide-rst | ||
+ | |||
+ | 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 | ||
+ | |||
= 7 August 2015 = | = 7 August 2015 = |
Revision as of 02:03, 20 August 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
- OpenStack Docs Mailing List <Openstack-docs@lists.openstack.org>
- OpenStack Development Mailing List <openstack-dev@lists.openstack.org>
- Docs liaisons (from https://wiki.openstack.org/wiki/CrossProjectLiaisons#Documentation)
- i18n List <openstack-i18n@lists.openstack.org>
Your suggestions for content
- Add
- Your
- Content
- Here
21 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!
- RST conversion:
- Install Guide: Conversion is nearly done, sign up here: https://wiki.openstack.org/wiki/Documentation/Migrate#Installation_Guide_Migration
- Cloud Admin Guide: is complete! The new version will be available on docs.openstack.org very soon.
- HA Guide: is also nearly done. Get in touch with Meg or Matt: https://wiki.openstack.org/wiki/Documentation/HA_Guide_Update
- Security Guide: Conversion is now underway, sign up here: https://etherpad.openstack.org/p/sec-guide-rst
- 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:
- Install Guide:
- Contact Karin Levenstein <karin.levenstein@rackspace.com>
- Sign up here: https://wiki.openstack.org/wiki/Documentation/Migrate#Installation_Guide_Migration
- HA Guide
- Contact Meg McRoberts <dreidellhasa@yahoo.com> or Matt Griffin <me@mattgriffin.com>
- Blueprint: https://blueprints.launchpad.net/openstack-manuals/+spec/improve-ha-guide
- Security Guide
- Contact Nathaniel Dillon <nathaniel.dillon@hp.com>
- Info: https://etherpad.openstack.org/p/sec-guide-rst
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
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!
- RST conversion:
- Install Guide: Conversion is nearly done, sign up here: https://wiki.openstack.org/wiki/Documentation/Migrate#Installation_Guide_Migration
- Cloud Admin Guide: is complete! The new version will be available on docs.openstack.org very soon.
- HA Guide: is also nearly done. Get in touch with Meg or Matt: https://wiki.openstack.org/wiki/Documentation/HA_Guide_Update
- Security Guide: Conversion is now underway, sign up here: https://etherpad.openstack.org/p/sec-guide-rst
- 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:
- Install Guide:
- Contact Karin Levenstein <karin.levenstein@rackspace.com>
- Sign up here: https://wiki.openstack.org/wiki/Documentation/Migrate#Installation_Guide_Migration
- HA Guide
- Contact Meg McRoberts <dreidellhasa@yahoo.com> or Matt Griffin <me@mattgriffin.com>
- Blueprint: https://blueprints.launchpad.net/openstack-manuals/+spec/improve-ha-guide
- Security Guide
- Contact Nathaniel Dillon <nathaniel.dillon@hp.com>
- Info: https://etherpad.openstack.org/p/sec-guide-rst
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