Rendering errors in StarlingX Build Guide
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
StarlingX |
Fix Released
|
Medium
|
M Camp |
Bug Description
Note to Mary - this template was filled in automatically by clicking on the "bug" icon on the doc page in question. it appears to be a standard OpenStack template. We may or may not want this.
-------
This bug tracker is for errors with the documentation, use the following as a template and remove or add fields as you see fit. Convert [ ] into [x] to check boxes:
- [X] This doc is inaccurate in this way: rendering of punctuation can be inconsistent and hard to read.
- [ ] This is a doc addition request.
- [ ] I have a fix to the document that I can paste below including example: input and output.
The StarlingX build guide (and perhaps other StarlingX documents) do not render the '-', '.' or '/' consistently. In some cases these punctuation marks are rendered so dimly that it becomes hard for a user to see that they are even there, which makes users sad because without these punctuation marks, the commands in the build guide do no work (or even run).
For examples of the problem, look for commands in the Code blocks that say "bash tb.sh exec". The '.' in those code blocks are almost invisible in both Chrome and Firefox.
Other examples of running the tb script render correctly e.g. "./tb.sh exec". Which is weird and makes users sad again.
-------
Release: 3.0.1.dev134 on 2020-04-21 21:40:07
SHA: bf28c5e9ad46ff6
Source: https:/
URL: https:/
Changed in starlingx: | |
assignee: | nobody → M Camp (mcamp859) |
importance: | Undecided → Medium |
status: | New → Triaged |
Changed in starlingx: | |
status: | Triaged → In Progress |
tags: | added: stx.4.0 |
Reviewed: https:/ /review. opendev. org/736763 /git.openstack. org/cgit/ starlingx/ docs/commit/ ?id=09d65eac3f8 6654b00b9289334 ef91938184dd75
Committed: https:/
Submitter: Zuul
Branch: master
commit 09d65eac3f86654 b00b9289334ef91 938184dd75
Author: MCamp859 <email address hidden>
Date: Thu Jun 18 12:00:03 2020 -0400
[WIP] Revert pygment style setting
Update to openstackdocstheme changed code snippets display style.
Revert to previous setting for better readability.
Closes-Bug: 1883966
Change-Id: Ibdf84da05ad4f6 dbd8342c58ad215 a9a3e68d6a7
Signed-off-by: MCamp859 <email address hidden>