Jump to: navigation, search

Difference between revisions of "Meetings/DocTeamMeeting"

(Agenda for next meeting)
(Apologies for absence)
Line 43: Line 43:
 
== Apologies for absence ==
 
== Apologies for absence ==
  
* Anne. API report:  
+
* Kato. CLI Ref report:  
  
Karen Bradshaw has been working on updates to the openstackdocstheme that would fix this bug: https://launchpad.net/bugs/1583623. The review is up at https://review.openstack.org/#/c/393890/ and getting input from the affected teams who have recognized the need because of errors building when you have multiple API versions with very similar calls, so you end up with identical headings.
+
CLI Reference:
 +
We try to recreating the single page view for the "openstack" command.
 +
I'd like to generate the reference from source code automatically.
 +
However, python-openstackclient has many plug-ins.
 +
It is difficulty, but worth to tackle it. We need your help!
  
I've had a couple of inquiries on IRC about "where did the draft/swagger files go?" but to meet their stated end goals, those particular files wouldn't have worked any way due to inaccuracies in the content and incomplete content.
+
* Anne. API report:
  
See the 100 api-ref doc patches up for review at: https://review.openstack.org/#/q/status:open+file:api-ref.
+
The App Dev Support WG is working on a survey to determine which content areas to invest in for content on http://www.openstack.org/appdev. (http://lists.openstack.org/pipermail/user-committee/2016-November/001469.html)
  
 +
* Matjaz. Training Guides reports:
  
* Matjaz. Training Guide report:
+
- BCN Upstream training article in the Superuser magazine: http://superuser.openstack.org/articles/openstack-upstream-training-revamp/
 
+
- actively looking for contributors to join the Upstream training, please see http://lists.openstack.org/pipermail/openstack-docs/2016-November/009382.html
- we changed our IRC meeting to every two weeks (on even weeks) on Tuesday at 1300 UTC in #openstack-meeting-3
+
- cleaned test entries in the Launchpad bug queue and the Sandbox repository (left from the Barcelona Upstream training)
- there will be an article published about BCN Upstream training in OpenStack’s Superuser magazine
+
- updated Training guides’ README.rst
- BCN Upstream training retrospective https://etherpad.openstack.org/p/upstream-training-barcelona-retrospective
 
 
 
 
 
* John. Networking Guide report:
 
 
 
As for my update - not much to report. A couple of new articles are close
 
to merging:
 
 
 
https://review.openstack.org/#/c/361776/ - VLAN Trunking
 
 
 
https://review.openstack.org/#/c/356013/ - Routed Provider Networks
 
 
 
Need to decide how best to track the work that¹s
 
going on for:
 
 
 
https://blueprints.launchpad.net/openstack-manuals/+spec/use-openstack-command
 
 
 
 
 
Probably a google spreadsheet or ether pad with a list of all the network
 
guide pages to be converted, and the person working on it would be best.
 
That way we can hopefully avoid duplicating efforts.
 
  
 
== Previous meetings ==
 
== Previous meetings ==

Revision as of 20:54, 1 December 2016

Documentation team meeting

Every two weeks (on even weeks) on Thursday at 2100 UTC in #openstack-meeting-alt http://www.timeanddate.com/worldclock/fixedtime.html?msg=Documentation+Team+Meeting&iso=20161117T21&p1=1440&ah=1

This meeting is used to discuss the status of the various docs speciality teams, as well as general docs updates. If you're looking to get started with documentation, or need to discuss work on a particular book, this is the place to do that.

Please feel free to add items to the agenda below and we'll cover them.

Agenda for next meeting

When starting the meeting, use #startmeeting docteam to provide consistency.

Apologies for absence

  • Kato. CLI Ref report:

CLI Reference: We try to recreating the single page view for the "openstack" command. I'd like to generate the reference from source code automatically. However, python-openstackclient has many plug-ins. It is difficulty, but worth to tackle it. We need your help!

  • Anne. API report:

The App Dev Support WG is working on a survey to determine which content areas to invest in for content on http://www.openstack.org/appdev. (http://lists.openstack.org/pipermail/user-committee/2016-November/001469.html)

  • Matjaz. Training Guides reports:

- BCN Upstream training article in the Superuser magazine: http://superuser.openstack.org/articles/openstack-upstream-training-revamp/ - actively looking for contributors to join the Upstream training, please see http://lists.openstack.org/pipermail/openstack-docs/2016-November/009382.html - cleaned test entries in the Launchpad bug queue and the Sandbox repository (left from the Barcelona Upstream training) - updated Training guides’ README.rst

Previous meetings

Previous meetings, with their notes and logs, can be found here: http://eavesdrop.openstack.org/meetings/docteam/

Running Meetings

Public meetings are run in IRC; we use MeetBot syntax to note what happens during the meeting. http://meetbot.debian.net/Manual.html

Useː

  • #startmeeting docteam
  • #topic <item>, for each agenda item that is being addressed
  • #link <url>, for relevant meeting URLs
  • #info <info> for important notes that need to be added to the minutes
  • #action <item>, to note tasks for a specific person
  • #endmeeting

After the meeting ends, edit the wiki page https://wiki.openstack.org/wiki/Documentation/MeetingLogs with links to the log and minutes (displayed in IRC at the end of each meeting).

Office hours

We no longer hold formal office hours, but if you would like to walk through documentation processes, learn about the tools, or report a doc bug, feel free to come by the IRC channel at #openstack-doc at any time. You can also open discussions by emailing the openstack-docs@lists.openstack.org mailing list.