Documentation site - bad HTML rendering
Description
Environment
is duplicated by
Activity
Stephane Desneux September 1, 2017 at 12:14 AM
Rendering seem to be correct, at least on the URL indicated in description and few others.
What happened ? Should we mark this one as resolved ?
ronan Le Martret July 13, 2017 at 9:09 AM
Fix markdown, to improve html renderer.
Used of markdownlint was very usefull
Stephane Desneux May 22, 2017 at 2:55 PM
The readme give instructions for opensuse but not for other distros (because, we initially developped the website on openSuse ). I believe there are not much specific stuff to do: only follow usual Jekyll install instructions and in that matter, I don't see why it would be so specific for Ubuntu.
Furthermore, there's no specific version of Jekyll or Kramdown absolutely required: if I summarize the versions I have on verious machines, this gives:
Jekyll 3.1.6 + Kramdown 1.13.1 (openSuse 42.1)
Jekyll 3.3.1 + Kramdown 1.12.0 (openSuse 42.1)
Jekyll 3.4.3 + Kramdown 1.13.2 (one "old" docker container Debian 8.7)
Jekyll 3.4.3 + Kramdown 1.13.2 (latest docker generic container Debian 8.8)
And I'm quite sure we had other different versions running correctly.
Using latest version Jekyll 3.4.3 + Kramdown 1.13.2 should work. But it's supposed to be those versions which are installed by the scriptlet 70_doc.
I think someone with ubuntu on his/her desktop should try to reproduce the problem.
Jan-Simon Moeller May 20, 2017 at 8:56 PM
So I fixed the jenkins slaves to install exactly what 70_doc does. The generation ran already once.
Some parts are still not fully rendered. Again, we have to work with ubuntu 16.04 on the jenkins minions.
What other versions are needed ? Please document exactly what versions are to be used to get the desired output.
This also needs to be in the readme.md of the webdoc repo then.
Jan-Simon Moeller May 19, 2017 at 2:40 PM
The instructions in https://git.automotivelinux.org/AGL/docker-worker-generator/tree/INSTALL/tasks.d/70_doc derive from what is
in the doc.
The buildslaves install the dependencies on 16.04 this way:
https://git.automotivelinux.org/ci-management/tree/packer/provision/agl_dependencies.sh#n68
What is wrong with that or what needs to be added ?
The Readme.md's never mention the use of other repositories than the distro.
Details
Details
Assignee
Stephane DesneuxReporter
Stephane DesneuxLabels
Contract ID
Components
Priority
Critical
The HTML rendering made on docs.automotivelinux has some glitches.
Compare:
http://docs.automotivelinux.org/docs/getting_started/en/dev/reference/troubleshooting.html
to:
http://docs.iot.bzh/docs/getting_started/en/dev/reference/troubleshooting.html (rendering is correct)
It may be due to differences in jekyll or kramdown versions used to generate the site. Versions used to generate the "good" site:
jekyll 3.1.6
kramdown 1.13.1