Tripleo-docs: Conditional web page rendering out of order

Bug #1779515 reported by Bernd Bausch
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
tripleo
Incomplete
Medium
Bernd Bausch

Bug Description

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:

All tripleo-docs pages that I have seen feature a small header labeled "Limit Environment Specific Content" that looks like a drop-down menu. Clicking on it has no effect.

Given the many possible combinations of platforms (Centos, RHEL), versions (Newton to Queens plus master) and other options that influence the installation process, it would be very useful if the reader had the possibility to select some options and hide others. The documents currently include all options, which makes them close to unreadable. In spite of all the colour coding and labeling, it's very easy to run an incorrect command or download the wrong files.

Why doesn't this selection menu work? It's coded in a file named _layouts.html, which all pages include. _layouts.html itself includes Javascript files that are not found anywhere. I believe this is where the problem lies. I speculate that the conditional page rendering feature got lost in the conversion of those pages to REStructured Text. I would like to try it out on the original tripleo.org, but this site is (currently or permanently) down.

RST and Sphinx do have conditional rendering. The installation guide makes use of this feature, why not Tripleo?

- [ ] This is a doc addition request.
- [ ] I have a fix to the document that I can paste below including example: input and output.

If you have a troubleshooting or support issue, use the following resources:

 - Ask OpenStack: http://ask.openstack.org
 - The mailing list: http://lists.openstack.org
 - IRC: 'openstack' channel on Freenode

-----------------------------------
Release: 0.0.1.dev843 on 2018-06-29 11:44
SHA: aa1b71890e9c9cc36435b501eb66eac7cc2772ce
Source: https://git.openstack.org/cgit/openstack/tripleo-docs/tree/doc/source/install/installation/installation.rst
URL: https://docs.openstack.org/tripleo-docs/latest/install/installation/installation.html

Changed in tripleo:
status: New → Confirmed
importance: Undecided → Medium
milestone: none → rocky-3
Changed in tripleo:
assignee: nobody → Bernd Bausch (berndbausch)
Revision history for this message
Bernd Bausch (berndbausch) wrote :

I noticed that _templates/layout.html refers to CSS and Javascript files in a directory named _static. It turns out that these files exist, but the directory is named _custom. A quick fix, I thought, and replaced _static with _custom.

As a result, I can now see the option menu (Centos vs RHEL, Newton/Ocata/stable etc). Unfortunately it is always displayed and can't be collapsed. Furthermore, the option settings are not remembered when I change pages, and finally, setting/unsetting menu options has no effect.

In short, it's not that simple.

Changed in tripleo:
status: Confirmed → Triaged
Changed in tripleo:
milestone: rocky-3 → rocky-rc1
Changed in tripleo:
milestone: rocky-rc1 → stein-1
Changed in tripleo:
milestone: stein-1 → stein-2
Changed in tripleo:
milestone: stein-2 → stein-3
Changed in tripleo:
milestone: stein-3 → train-1
Changed in tripleo:
milestone: train-1 → train-2
Changed in tripleo:
milestone: train-2 → train-3
Changed in tripleo:
milestone: train-3 → ussuri-1
Changed in tripleo:
milestone: ussuri-1 → ussuri-2
wes hayutin (weshayutin)
Changed in tripleo:
milestone: ussuri-2 → ussuri-3
wes hayutin (weshayutin)
Changed in tripleo:
status: Triaged → Incomplete
wes hayutin (weshayutin)
Changed in tripleo:
milestone: ussuri-3 → ussuri-rc3
wes hayutin (weshayutin)
Changed in tripleo:
milestone: ussuri-rc3 → victoria-1
Changed in tripleo:
milestone: victoria-1 → victoria-3
Changed in tripleo:
milestone: victoria-3 → wallaby-1
Changed in tripleo:
milestone: wallaby-1 → wallaby-2
Changed in tripleo:
milestone: wallaby-2 → wallaby-3
Revision history for this message
Marios Andreou (marios-b) wrote :

This is an automated action. Bug status has been set to 'Incomplete' and target milestone has been removed due to inactivity. If you disagree please re-set these values and reach out to us on freenode #tripleo

Changed in tripleo:
milestone: wallaby-3 → none
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.