Jump to: navigation, search

Difference between revisions of "Documentation/WhatsUpDoc"

(→‎3 June 2016)
(→‎Speciality Team Reports)
Line 40: Line 40:
  
 
'''Install Guide: Lana Brindley'''
 
'''Install Guide: Lana Brindley'''
−
Specs are now merged, an blueprints created. Tasks listed here: https://wiki.openstack.org/wiki/Documentation/InstallGuideWorkItems Please go ahead and pick up work items. Need project representation in meetings. Next meeting: Tue 7 June 0600 UTC
+
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'''
 
'''Networking Guide: Edgar Magana'''
−
We did not have meeting this week. Nothing to report. Next IRC meeting: Thursday June 2nd at 1600 UTC
+
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'''
 
'''Security Guide: Nathaniel Dillon'''
Line 49: Line 49:
  
 
'''User Guides: Joseph Robinson'''
 
'''User Guides: Joseph Robinson'''
−
Action items to follow up - email meeting minutes to the mailing list to update the community.
+
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.
−
Currently, the team has two contributors. Please let me know if you're interested in working on the User Guide Team.
 
  
 
'''Ops Guide: Shilla Saebi'''
 
'''Ops Guide: Shilla Saebi'''
−
Shilla & Darren working on collecting enterprise docs to push upstream
+
No report this week.
−
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
 
−
Spec was merged: https://review.openstack.org/#/c/311998/
 
  
 
'''API Guide: Anne Gentle'''
 
'''API Guide: Anne Gentle'''
−
No report this week.
+
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'''
 
'''Config/CLI Ref: Tomoyuki Kato'''
−
A few configuration docs patches for some vendor plug-ins has been merged, with mitaka backport.
+
Closed some bugs with Mitaka backport. Fixed the incorrect RST markup at  the new options section, with generation tool update.
−
Heat CLI is marked as deprecated.
 
  
 
'''Training labs: Pranav Salunke, Roger Luethi'''
 
'''Training labs: Pranav Salunke, Roger Luethi'''
Line 69: Line 66:
  
 
'''Training Guides: Matjaz Pancur'''
 
'''Training Guides: Matjaz Pancur'''
−
Updates for Upstream training material
+
Upstream training updates, Barcelona schedule.
  
 
'''Hypervisor Tuning Guide: Blair Bethwaite
 
'''Hypervisor Tuning Guide: Blair Bethwaite
Line 75: Line 72:
  
 
'''UX/UI Guidelines: Michael Tullis, Stephen Ballard'''
 
'''UX/UI Guidelines: Michael Tullis, Stephen Ballard'''
−
No report this week.
+
The first prototype of content was presented and source information gaps were identified. A first draft will be complete by June 9.
  
 
== Site Stats ==
 
== Site Stats ==

Revision as of 04:29, 3 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

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.

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

This month, two thirds of our site visitors have been using their Mac to read the docs. Just under 30% used Windows, and Linux rounded out the remainder at 4%.

So far in the Install Guide naming poll, "OpenStack Installation Tutorial" has a commanding lead at 30%, with "Basic Install Guide" and "OpenStack Evaluation Setup Guide" (try saying that ten times fast!) tying for second place with 17% of the vote each. I'll keep the poll open for another week or so, and announce our winning name in next week's newsletter. 

https://docs.google.com/spreadsheets/d/1VlNFebI_KFobs-XIT5oRhULRymwrqON8SV9pH4uiYIQ/pubchart?oid=2070399201&format=image

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-05-25

Next meetings: APAC: Wednesday 1 June, 00:30 UTC US: Wednesday 8 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#3_June_2016

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