Change AGL Doc site to new workflow
Description
Environment
Type | Key | Summary | Priority | Story Points | Assignee | Status |
---|---|---|---|---|---|---|
![]() |
relates to
Activity
Jan-Simon Moeller April 9, 2019 at 2:13 PM
Site is live.
Clément Bénier March 18, 2019 at 2:22 PM(edited)
@Jan-Simon Moeller,
As you know, https://docs-next.iot.bzh represents the new site with the master-next branches from https://github.com/automotive-grade-linux/docs-webtemplat, https://github.com/automotive-grade-linux/docs-tools repository and https://github.com/automotive-grade-linux/docs-sources.
To have the new documentation i think a simple merge to master on these repositories would be enough to make it work as https://docs-next.iot.bzh. and change your generation script to remove multiversion patches, you just need to do now, something like:
wget https://raw.githubusercontent.com/automotive-grade-linux/docs-webtemplate/master/setupdocs.sh
mkdir docs-webtemplate
bash setupdocs.sh --directory=docs-webtemplate
make build
make push
In addition, i think there are some elements to check:
check pages with their versions, it might have some errors between versions
check that there are no divergence between the actual site and the new one
Later: remove Scott's branches from docs-webtemplates
For now, Scott pushes his work into branches that we have to indicate into section files in docwebtemplates
I think, it would be interesting that he reviews his changes as soon as the merges are done
remove the git_commit entry in these files (e.g for now it looks like git_commit: sandbox/scott29/newdocs)
Some elements that sill does not work:
Local hyperlink to the site, there was no really solution for the actual site, we discussed about one at the last documentation meeting but no implementation about it for now
multi-langage: a part was done with the old book format but not updating with the new one, the suffixes stuff
The most effect:
The way of updating a documentation,
Use section files (e.g. devguides/section_master.yml) if it is a new section to add in order to indicate the book files to download
Use book file (e.g. in docs-source app-framework-book.yml)
Switch between versions with list box.
Scott's changes
Jan-Simon Moeller March 18, 2019 at 12:20 PM(edited)
Can we summarize the required steps to take so we get '-next' into 'master' ?
@Clément Bénier - can you give us your view as your changes have the most effect.
Jan-Simon Moeller December 18, 2018 at 9:52 PM
No. This is an itermediate step.
We still need to make 'master' to be equal to -next .
The subitems are also open.
Walt Miner December 18, 2018 at 7:31 PM
@Jan-Simon Moeller Should be resolved then?
Using the workflow developed as part of the new doc site effort, switch to the new layout and workflow.