ISISComputingGroup / ISISComputingGroup/IBEX
User manual: investigate missing content, anchors not working
- Dominant language
- No language data
- Stars
- 6
- Forks
- 2
- Avg merge
- 16h 40m
- Merged PRs (30d)
- 2
Description
We have noticed that the **shadow hosted** user manual seems to
a) be missing parts of information
b) not allow anchors for all sub heading types
for example:
shadow/ibex_user_manual/Create-And-Manage-Configurations if you search for "IOCs tab" the entire content below the IOCs tab subheading is missing and the "blocks tab" anchor does not work ie. https://github.com/ISISComputingGroup/ibex_user_manual/wiki/Create-And-Manage-Configurations#blocks-tab
i am slightly concerned we are missing other bits of info on there too, i can't see what is causing the blocks tab bit to be missing etc.
Some suggestions:
- There may be a git conflict on shadow itself? check this first
- gollum, the service which runs the mirror of the wiki has/had a bug or there is subtle formatting differences between github and gollum. The page above is a restructuredtext (rst) file, there is a mix and match of markdown and rst on the user manual.
- there may be a github certificate issue
may be worth modifying the wiki checks to web scrape both and check for likeness?
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.