[Starlingx-discuss] [docs] [meeting] Docs team notes 06-Oct-21
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 ========== 06-Oct-21 All -- reviews merged since last meeting: 10 https://review.opendev.org/q/project:starlingx/docs+status:merged All -- bug status -- 18 total - team agrees to defer all low priority LP until the upstreaming effort is completed. 1 new LP against the Build Guide: https://bugs.launchpad.net/starlingx/+bug/1946118 Mary will create review Status/questions/opens Theme issues with Heading1 in index files. This one is OK: https://docs.starlingx.io/node_management/index.html But these are not: https://docs.starlingx.io/node_management/kubernetes/index.html and https://docs.starlingx.io/node_management/openstack/index.html Maybe that's a clue? It seems like the recent theme updates to fix the double heading may be causing this? Confirmed that the headings are in the HTML. For example: <h1>Manual software updates<a class="headerlink" href="#manual-software-updates" title="Permalink to this headline">¶</a></h1> Probably need help from Jeremy or someone on the theme team to help fix this for the long-term. Openstack theme version - if we roll it back, then we get the double-headings back again. Not a great plan. One workaround would be to add Ron's Python script to the STX tox to fix it in post-processing. Ron will look and see if there is more of a pattern to figure out a workaround. Zuul is having issues. Juanita has a review number for us to look at. Gerrit updates coming this weekend. The OpenDev team will be performing a Gerrit 3.3 upgrade on Sunday October 10, 2021 from 21:00UTC to 23:00UTC. Then on Friday October 15, 2021 from 18:00UTC to 19:00UTC we will be renaming a number of projects in Gerrit. Both of these actions require Gerrit service downtime on review.opendev.org. We expect the outages will be shorter than the allotted time but this gives us some flexibility. If there are issues, they will be posted here: https://wiki.openstack.org/wiki/Infrastructure_Status AR Mary fix landing and install landing pages to reference R 5.0.1 as latest release. Questions for Ghada, Greg, Scott: New features are being cherrypicked into 5.0 branch so that downstream docs can be built successfully. This isn't the expected workflow process. Juanita will bring up with Ghada & Greg in Friday meeting. Ron will talk to Scott about this, there was an old suggestion to create some kind of clone of the STX branch to workaround this. Team agrees that we need to fix this for R 6.0. May be a way to tag this as a future feature in Sphinx? AR Mary send email to Greg with changes to old config guides (last week's discussion).
On 2021-10-06 23:25:40 +0000 (+0000), Camp, MaryX wrote: [...]
Theme issues with Heading1 in index files. This one is OK: https://docs.starlingx.io/node_management/index.html But these are not: https://docs.starlingx.io/node_management/kubernetes/index.html and https://docs.starlingx.io/node_management/openstack/index.html Maybe that's a clue?
It seems like the recent theme updates to fix the double heading may be causing this? Confirmed that the headings are in the HTML. For example: <h1>Manual software updates<a class="headerlink" href="#manual-software-updates" title="Permalink to this headline">¶</a></h1>
Probably need help from Jeremy or someone on the theme team to help fix this for the long-term. Openstack theme version - if we roll it back, then we get the double-headings back again. Not a great plan. One workaround would be to add Ron's Python script to the STX tox to fix it in post-processing. Ron will look and see if there is more of a pattern to figure out a workaround.
I'm missing some context here, but after comparing your examples I think what you're saying is that the problem examples show more than one H1 level heading, rather than making the subheadings H2 level. Is that an accurate summary?
Zuul is having issues. Juanita has a review number for us to look at. [...]
I'm also happy to look at any Zuul problems, if you need a fresh pair of eyes. A recap of what these issues are would be cool. -- Jeremy Stanley
Thanks Jeremy for the response and advice. Regarding the theme issues for multiple H1s on an Index page, Ron is looking into your suggestions from the other email thread. The Zuul questions were more about the flow of the different jobs (check, gate, promote), what happens if you +1 Workflow before the check has completed, and entering "recheck" if a review is stuck. No issues here 😊 thanks again, Mary Camp Kelly Services Technical Writer | maryx.camp@intel.com
On 2021-10-07 15:20:49 +0000 (+0000), Camp, MaryX wrote: [...]
Regarding the theme issues for multiple H1s on an Index page, Ron is looking into your suggestions from the other email thread. [...]
Sounds good. Also for future reference, it's perfectly acceptable to discuss fixes publicly here on the starlingx-discuss mailing list rather than in private. Doing so gives other members of the community an opportunity to learn and help out as well. -- Jeremy Stanley
participants (2)
-
Camp, MaryX
-
Jeremy Stanley