[Starlingx-discuss] [docs] [meeting] Docs team notes 06-Jan-2021

Camp, MaryX maryx.camp at intel.com
Mon Jan 11 05:36:27 UTC 2021


Hello all,
Here are this week's docs team meeting minutes (short form). Details in [2].
Join us if you have interest in StarlingX docs! We meet on Wednesdays 12:30 PST.

  [1]   Call logistics: https://wiki.openstack.org/wiki/Starlingx/Meetings 
  [2]   Tracking Etherpad: https://etherpad.openstack.org/p/stx-documentation 

thanks,
Mary Camp
==========

2021-01-06
All -- reviews merged since last meeting:  8
All -- bug status -- 17 total - team agrees to defer all low priority LP until the upstreaming effort is completed. 
13 LP are WIP against API documentation, which is generated from source code (low priority). Those reviews are here: https://review.opendev.org/#/q/project:starlingx/config

Status/questions/opens

Upstreaming high-level status: Ron estimates 3 outstanding docs, most are done. This does not include install guides, they will be addressed later. 
Juanita has 1 and Kean has 2, both are WIP.  None of the OpenStack portions of any of the guides are done yet. 

Upstreaming Plan
1. Complete the 3 guides that are currently WIP.
2. Evaluate the upstreamed content against latest release of WRCP and make updates. This is because the upstreamed content was a snapshot from August. When complete, all the core Kubernetes content will be upstreamed and current.
3. Convert the OpenStack portions of upstream content. This step requires a new snapshot and then conversion activity. penStack content will need to be upleveled for readability. 
4. Convert the Install guides. The install guides are complex and require disentangling the process from upstream/downstream actions. The WindRiver install guides point upstream for many things and then describe WRCP minor exceptions (something like: in step 5, use the WR link instead of the STX link.) Requires some more planning to figure out how to do it properly.

Release 5 features/updates, such as the SNMP v2 to v3 change
Some will be included in the upstreaming effort because they are already covered in the WR documentation. 
AR Mary get the latest features list from release mtg notes and bring to next week's docs meeting for discussion.

Strings file
Ron recommends splitting into 2 files. One file that is "common common" containing the rubrics & abbreviations that both upstream & downstream need. We will still have the reuse factor but not as unwieldy as 1 big file. Team agreed. 

Future requests
Figure out breadcrumbs -- look at css/templates to see how we can show reader where they are in the documentation.
Mary to follow up with Intel folks to ask for help with the version drop-down.




More information about the Starlingx-discuss mailing list