Jump to: navigation, search

Difference between revisions of "Documentation/WhatsUpDoc"

(→‎17 June 2016)
Line 18: Line 18:
 
==== Looking for older editions? ====
 
==== Looking for older editions? ====
 
You can see older newsletters here: [[Documentation/WhatsUpDoc_Archive]]
 
You can see older newsletters here: [[Documentation/WhatsUpDoc_Archive]]
 +
 +
= 24 June 2016 =
 +
 +
Hi everyone,
 +
 +
This week I've very pleased to announce that we have our first project-specific Install Guide published! Petr Kovar got Heat over the line in first place, and it's looking great:  http://docs.openstack.org/project-install-guide/orchestration/draft/index.html Well done Petr, and of course all the wonderful docs people who helped us get to this point. We're also expecting to see Trove published very soon. I've been using the lessons learned from these early projects to flesh out our instructions a little more, so it should be even easier for projects to get their Install Guides up and running. We still need to create the central index, but it's all starting to come together now.
 +
 +
I'm also excited to announce that, for the very first time, we have a specific Ops Cross-Project Liaison. Please welcome Robert Starmer to the CPL family :)
 +
 +
== Progress towards Newton ==
 +
 +
110 days to go!
 +
 +
Bugs closed so far: 185
 +
 +
Newton deliverables: https://wiki.openstack.org/wiki/Documentation/NewtonDeliverables
 +
Feel free to add more detail and cross things off as they are achieved throughout the release.
 +
 +
Also, just a note that the CFP for Barcelona is open now, until 13 July. If you want to brainstorm some documentation-related ideas, please get in touch!
 +
 +
== Speciality Team Reports ==
 +
 +
'''HA Guide: Bogdan Dobrelya'''
 +
No report this week.
 +
 +
'''Install Guide: Lana Brindley'''
 +
Orchestration is done! Well done, Petr :) Working on updating instructions in the Contributor Guide. Instructions: http://docs.openstack.org/contributor-guide/project-install-guide.html Next meeting: Tue 21 June 0600 UTC
 +
 +
'''Networking Guide: Edgar Magana'''
 +
No report this week.
 +
 +
'''Security Guide: Nathaniel Dillon'''
 +
No report this week.
 +
 +
'''User Guides: Joseph Robinson'''
 +
Began a consistency and IA plan, and held the US meeting. Emailing one new interested contributor.
 +
 +
'''Ops Guide: Darren Chan'''
 +
Some architecture content moved from the Ops Guide to the draft Arch Guide. Patches will be submitted to remove old content from the Ops Guide. Team is currently reviewing enterprise ops documentation to incorporate into the Ops Guide.
 +
 +
'''API Guide: Anne Gentle'''
 +
Check out all the open reviews for api-ref: https://review.openstack.org/#/q/status:open+file:api-ref Nice.
 +
Went to weekly team meeting for swift, landed build patch for swift's api-ref, responding to reviews.
 +
Noodling with Karen Bradshaw about API navigation, https://review.openstack.org/#/c/329508/ (though I can't take any credit for the work!)
 +
 +
'''Config/CLI Ref: Tomoyuki Kato'''
 +
Closed many bugs continuously. Started working on the common configurations for shared services and libraries.
 +
 +
'''Training labs: Pranav Salunke, Roger Luethi'''
 +
No report this week.
 +
 +
'''Training Guides: Matjaz Pancur'''
 +
No report this week.
 +
 +
'''Hypervisor Tuning Guide: Blair Bethwaite
 +
No report this week.
 +
 +
'''UX/UI Guidelines: Michael Tullis, Stephen Ballard'''
 +
No report this week.
 +
 +
== Training Guides/Labs Core Team Changes ==
 +
 +
We've adjusted the training guides and labs core teams so that speciality team leads are core in their own repos, and the docs core team is an 'included group' in both repos. This is intended to stop the core teams for these groups drifting out of date too quickly. Note that it is expected that docs cores will not be the primary reviewers/mergers for training repos, but are there as backup in case extra eyes are needed. That responsibility will continue to lie with the training teams themselves, as they know the codebase the best.
 +
 +
You can see the updated core team lists here:
 +
Training Guides: https://review.openstack.org/#/admin/groups/uuid-3490bf37012cb344104cb315f3dd5c76dabea62f,members
 +
Training Labs: https://review.openstack.org/#/admin/groups/1118,members
 +
 +
== Site Stats ==
 +
 +
During May the top viewed book was the Mitaka Ubuntu Install Guide, followed closely by the Mitaka RDO Install Guide. Rolling into third place was the Admin Guide.
 +
 +
Also, apologies for an error I made in this section last week. The correct number for the total number of views in May was 2,365,626.
 +
 +
== Doc team meeting ==
 +
 +
Next meetings:
 +
 +
The APAC meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-06-15
 +
 +
Next meetings:
 +
US: Wednesday 22 June, 19:00 UTC
 +
APAC: Wednesday 29 June, 00:30 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
 +
 +
--
 +
 +
Keep on doc'ing!
 +
 +
Lana
 +
 +
https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#24_June_2016
  
 
= 17 June 2016 =
 
= 17 June 2016 =

Revision as of 04:24, 24 June 2016

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:

Distribution List

Content Sources

Speciality team reports are gathered here: https://etherpad.openstack.org/p/Speciality_Team_Reports

  • Your
  • Content
  • Here

Looking for older editions?

You can see older newsletters here: Documentation/WhatsUpDoc_Archive

24 June 2016

Hi everyone,

This week I've very pleased to announce that we have our first project-specific Install Guide published! Petr Kovar got Heat over the line in first place, and it's looking great: http://docs.openstack.org/project-install-guide/orchestration/draft/index.html Well done Petr, and of course all the wonderful docs people who helped us get to this point. We're also expecting to see Trove published very soon. I've been using the lessons learned from these early projects to flesh out our instructions a little more, so it should be even easier for projects to get their Install Guides up and running. We still need to create the central index, but it's all starting to come together now.

I'm also excited to announce that, for the very first time, we have a specific Ops Cross-Project Liaison. Please welcome Robert Starmer to the CPL family :)

Progress towards Newton

110 days to go!

Bugs closed so far: 185

Newton deliverables: https://wiki.openstack.org/wiki/Documentation/NewtonDeliverables Feel free to add more detail and cross things off as they are achieved throughout the release.

Also, just a note that the CFP for Barcelona is open now, until 13 July. If you want to brainstorm some documentation-related ideas, please get in touch!

Speciality Team Reports

HA Guide: Bogdan Dobrelya No report this week.

Install Guide: Lana Brindley Orchestration is done! Well done, Petr :) Working on updating instructions in the Contributor Guide. Instructions: http://docs.openstack.org/contributor-guide/project-install-guide.html Next meeting: Tue 21 June 0600 UTC

Networking Guide: Edgar Magana No report this week.

Security Guide: Nathaniel Dillon No report this week.

User Guides: Joseph Robinson Began a consistency and IA plan, and held the US meeting. Emailing one new interested contributor.

Ops Guide: Darren Chan Some architecture content moved from the Ops Guide to the draft Arch Guide. Patches will be submitted to remove old content from the Ops Guide. Team is currently reviewing enterprise ops documentation to incorporate into the Ops Guide.

API Guide: Anne Gentle Check out all the open reviews for api-ref: https://review.openstack.org/#/q/status:open+file:api-ref Nice. Went to weekly team meeting for swift, landed build patch for swift's api-ref, responding to reviews. Noodling with Karen Bradshaw about API navigation, https://review.openstack.org/#/c/329508/ (though I can't take any credit for the work!)

Config/CLI Ref: Tomoyuki Kato Closed many bugs continuously. Started working on the common configurations for shared services and libraries.

Training labs: Pranav Salunke, Roger Luethi No report this week.

Training Guides: Matjaz Pancur No report this week.

Hypervisor Tuning Guide: Blair Bethwaite No report this week.

UX/UI Guidelines: Michael Tullis, Stephen Ballard No report this week.

Training Guides/Labs Core Team Changes

We've adjusted the training guides and labs core teams so that speciality team leads are core in their own repos, and the docs core team is an 'included group' in both repos. This is intended to stop the core teams for these groups drifting out of date too quickly. Note that it is expected that docs cores will not be the primary reviewers/mergers for training repos, but are there as backup in case extra eyes are needed. That responsibility will continue to lie with the training teams themselves, as they know the codebase the best.

You can see the updated core team lists here: Training Guides: https://review.openstack.org/#/admin/groups/uuid-3490bf37012cb344104cb315f3dd5c76dabea62f,members Training Labs: https://review.openstack.org/#/admin/groups/1118,members

Site Stats

During May the top viewed book was the Mitaka Ubuntu Install Guide, followed closely by the Mitaka RDO Install Guide. Rolling into third place was the Admin Guide.

Also, apologies for an error I made in this section last week. The correct number for the total number of views in May was 2,365,626.

Doc team meeting

Next meetings:

The APAC meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-06-15

Next meetings: US: Wednesday 22 June, 19:00 UTC APAC: Wednesday 29 June, 00:30 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

--

Keep on doc'ing!

Lana

https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#24_June_2016

17 June 2016

Hi everyone,

This week I've very pleased to announce that we have our first project-specific Install Guide published! Petr Kovar got Heat over the line in first place, and it's looking great: http://docs.openstack.org/project-install-guide/orchestration/draft/index.html Well done Petr, and of course all the wonderful docs people who helped us get to this point. We're also expecting to see Trove published very soon. I've been using the lessons learned from these early projects to flesh out our instructions a little more, so it should be even easier for projects to get their Install Guides up and running. We still need to create the central index, but it's all starting to come together now.

I'm also excited to announce that, for the very first time, we have a specific Ops Cross-Project Liaison. Please welcome Robert Starmer to the CPL family :)

Progress towards Newton

110 days to go!

Bugs closed so far: 185

Newton deliverables: https://wiki.openstack.org/wiki/Documentation/NewtonDeliverables Feel free to add more detail and cross things off as they are achieved throughout the release.

Also, just a note that the CFP for Barcelona is open now, until 13 July. If you want to brainstorm some documentation-related ideas, please get in touch!

Speciality Team Reports

HA Guide: Bogdan Dobrelya No report this week.

Install Guide: Lana Brindley Orchestration is done! Well done, Petr :) Working on updating instructions in the Contributor Guide. Instructions: http://docs.openstack.org/contributor-guide/project-install-guide.html Next meeting: Tue 21 June 0600 UTC

Networking Guide: Edgar Magana No report this week.

Security Guide: Nathaniel Dillon No report this week.

User Guides: Joseph Robinson Began a consistency and IA plan, and held the US meeting. Emailing one new interested contributor.

Ops Guide: Darren Chan Some architecture content moved from the Ops Guide to the draft Arch Guide. Patches will be submitted to remove old content from the Ops Guide. Team is currently reviewing enterprise ops documentation to incorporate into the Ops Guide.

API Guide: Anne Gentle Check out all the open reviews for api-ref: https://review.openstack.org/#/q/status:open+file:api-ref Nice. Went to weekly team meeting for swift, landed build patch for swift's api-ref, responding to reviews. Noodling with Karen Bradshaw about API navigation, https://review.openstack.org/#/c/329508/ (though I can't take any credit for the work!)

Config/CLI Ref: Tomoyuki Kato Closed many bugs continuously. Started working on the common configurations for shared services and libraries.

Training labs: Pranav Salunke, Roger Luethi No report this week.

Training Guides: Matjaz Pancur No report this week.

Hypervisor Tuning Guide: Blair Bethwaite No report this week.

UX/UI Guidelines: Michael Tullis, Stephen Ballard No report this week.

Training Guides/Labs Core Team Changes

We've adjusted the training guides and labs core teams so that speciality team leads are core in their own repos, and the docs core team is an 'included group' in both repos. This is intended to stop the core teams for these groups drifting out of date too quickly. Note that it is expected that docs cores will not be the primary reviewers/mergers for training repos, but are there as backup in case extra eyes are needed. That responsibility will continue to lie with the training teams themselves, as they know the codebase the best.

You can see the updated core team lists here: Training Guides: https://review.openstack.org/#/admin/groups/uuid-3490bf37012cb344104cb315f3dd5c76dabea62f,members Training Labs: https://review.openstack.org/#/admin/groups/1118,members

Site Stats

During May the top viewed book was the Mitaka Ubuntu Install Guide, followed closely by the Mitaka RDO Install Guide. Rolling into third place was the Admin Guide.

Also, apologies for an error I made in this section last week. The correct number for the total number of views in May was 2,365,626.

Doc team meeting

Next meetings:

The APAC meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-06-15

Next meetings: US: Wednesday 22 June, 19:00 UTC APAC: Wednesday 29 June, 00:30 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

--

Keep on doc'ing!

Lana

https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#17_June_2016

10 June 2016

Hi everyone,

My week has been spent on the Install Guide, and a big thanks to Andreas for getting the Infra patch up and documenting the new process. The Install Guide team meeting was well attended this week, and I've been following up on the actions from that. I also contacted the cross project liaisons with the information they need to get their content moved, and I'm looking forward to seeing some of these start work next week.

In other news, Joseph has been busy reviewing the User Guides, and could use a little help working on the information architecture, and getting a few new projects documented. User Guide meetings are held in US and APAC timezones and volunteers are essential to get this effort complete for Newton. Get all the info here: https://wiki.openstack.org/wiki/User_Guides

Progress towards Newton

117 days to go!

Bugs closed so far: 163

Newton deliverables: https://wiki.openstack.org/wiki/Documentation/NewtonDeliverables Feel free to add more detail and cross things off as they are achieved throughout the release.

Speciality Team Reports

HA Guide: Bogdan Dobrelya No report this week.

Install Guide: Lana Brindley Infra patch: https://review.openstack.org/#/c/326039/ Instructions: http://docs.openstack.org/contributor-guide/project-install-guide.html Next meeting: Tue 21 June 0600 UTC

Networking Guide: Edgar Magana No meeting this week. Working on a better ToC for the guide that may impact of the of scenarios. Moving more networking content from other guides into the Networking one in order to keep everything in one central point and better updated.

Security Guide: Nathaniel Dillon No report this week.

User Guides: Joseph Robinson Outstanding Tasks - Contacting more project teams for inclusion status, IA plans for the new guide. Some team discussion on fixing old links - contact me if anyone is interested in contributing more content to the User Guides team.

Ops Guide: Shilla Saebi Ops tasks are documented here: https://etherpad.openstack.org/p/ops-arch-tasks OpenStack ops guide reorg in progress & documented here: https://etherpad.openstack.org/p/ops-guide-reorg Working on posting enterprise docs for cleanup. Looking for volunteers in ops/arch docs group to attend ops specific meetings to find additional info and help.

API Guide: Anne Gentle Call for help for unified all-OpenStack API navigation design: http://lists.openstack.org/pipermail/openstack-docs/2016-June/008730.html Discussing project-level organization in https://review.openstack.org/312259 Discussing source organization in https://review.openstack.org/314819 Redirects and deletions in api-site are welcomed! For example, see https://review.openstack.org/327399 Updated README for api-site: https://review.openstack.org/327395

Config/CLI Ref: Tomoyuki Kato Closed a few bugs continuously. Cleaned up many bugs about tool-generated configuration options that are already released for Mitaka. **We need folks for vendor plug-in docs from each vendor.**

Training labs: Pranav Salunke, Roger Luethi Working on the training-labs landing page to make it look much better. Reintroducing the tooling to build zip files. Working on PXE support for baremetal provisioning. Working on Python port of training-labs.

Training Guides: Matjaz Pancur No report this week.

Hypervisor Tuning Guide: Blair Bethwaite No report this week.

UX/UI Guidelines: Michael Tullis, Stephen Ballard No report this week.

Site Stats

During May, the docs.openstack.org site had 620 sessions, with just under 20% by new users. The average time of all sessions for the month was about 5 and a half minutes, looking at an average of 3 and a half pages.

Doc team meeting

Next meetings:

The US meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-06-08

Next meetings: APAC: Wednesday 15 June, 00:30 UTC US: Wednesday 22 June, 19: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

--

Keep on doc'ing!

Lana

https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#10_June_2016

3 June 2016

Hi everyone,

I'm very pleased to be able to announce the results of our Install Guide naming poll this week. We ended up with 31 responses, and a very clear winner in "OpenStack Installation Tutorial". Thank you to everyone who voted! Also, just a note that I'm still very much in need of representatives from the various project teams to pitch in and help us get things running. Please make sure your project is represented by coming along to meetings, or at least contacting us through the mailing list.

This week I've also spent some time with the Upstream training team, identifying gaps in the current material, and preparing for Barcelona.

Progress towards Newton

124 days to go!

Bugs closed so far: 134

Newton deliverables https://wiki.openstack.org/wiki/Documentation/NewtonDeliverables Feel free to add more detail and cross things off as they are achieved throughout the release.

Speciality Team Reports

HA Guide: Bogdan Dobrelya No report this week.

Install Guide: Lana Brindley Poll concluded, winner is "OpenStack Installation Tutorial". Connected with CPLs this week to encourage more participation. Next meeting: Tue 7 June 0600 UTC.

Networking Guide: Edgar Magana Moved DHCP HA chapter to Networking Guide for better maintenance and updates. Planning to move more sections and focus on DVR HA. Suffering of very low attendance for the IRC meeting.

Security Guide: Nathaniel Dillon No report this week.

User Guides: Joseph Robinson Some contact with the Magnum team. Held meetings, brought up the link changes, which is something I most need some assistance with. IA plan still forthcoming.

Ops Guide: Shilla Saebi No report this week.

API Guide: Anne Gentle New layout for API reference docs from additions to openstackdocs theme. Also already added four-color scheme for GET/PUT/POST/DELETE Thanks Graham Hayes! Work in progress here: https://api.os.gra.ham.ie/compute/ Reviews: https://review.openstack.org/#/q/project:openstack/openstackdocstheme+status:open and https://review.openstack.org/#/q/project:openstack/os-api-ref+status:open Discussion on SDKs and FirstApp audience happening on user-committee list: http://lists.openstack.org/pipermail/user-committee/2016-May/000889.html

Config/CLI Ref: Tomoyuki Kato Closed some bugs with Mitaka backport. Fixed the incorrect RST markup at the new options section, with generation tool update.

Training labs: Pranav Salunke, Roger Luethi No report this week.

Training Guides: Matjaz Pancur Upstream training updates, Barcelona schedule.

Hypervisor Tuning Guide: Blair Bethwaite No report this week.

UX/UI Guidelines: Michael Tullis, Stephen Ballard The first prototype of content was presented and source information gaps were identified. A first draft will be complete by June 9.

Site Stats

In the Install Guide naming poll, "OpenStack Installation Tutorial" finished with 29% of the vote, well ahead of "OpenStack Evaluation Setup Guide" at 19%, and "Basic Install Guide" at 16%. And, because charts are fun, here are the final results: https://docs.google.com/spreadsheets/d/1VlNFebI_KFobs-XIT5oRhULRymwrqON8SV9pH4uiYIQ/pubchart?oid=2070399201&format=image

I personally thought "OpenStack from Scratch" was the most creative title. And the potentially confusing "Manual Install Guide" ("Guided Install Manual"?) had a small following at just under 10% of the vote. Thanks for all the great suggestions :)

Doc team meeting

Next meetings:

The APAC meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-06-01

Next meetings: US: Wednesday 8 June, 19:00 UTC APAC: Wednesday 15 June, 00:30 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

--

Keep on doc'ing!

Lana

https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#3_June_2016

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