Online documentation site migration to hextra#89
Merged
slawr merged 9 commits intoCOVESA:mainfrom Mar 20, 2026
Merged
Conversation
The existing online documentation site that uses the Hugo HTML static generator and Learn template is located in /docs/docs-gen/ The project is migrating to use Hugo and the Hextra template for the doc site. The template move gives us the opportunity to update to a later Hugo version and start afresh. As a step towards that create a new Hugo project in the directory /docs/docs-site/ and enable the Hextra template. Signed-off-by: Stephen Lawrence <stephen.lawrence@renesas.com>
Populate the new site in /docs/docs-site/ with draft content: * Configure hugo.yaml for CDSP and the Hextra template * Add the documentation from the previous site to docs-site/content/ and make some adjustments to the markdown. Mainly fixing links. Signed-off-by: Stephen Lawrence <stephen.lawrence@renesas.com>
slawr
force-pushed
the
doc-site-migrate-to-hextra
branch
from
030da3d to
d194ff3
Compare
Collaborator
Author
|
Rebased working branch on updated main branch after merge of #86 |
Signed-off-by: Stephen Lawrence <stephen.lawrence@renesas.com>
Collaborator
Author
|
Hi @chrizmc I am currently testing this to check the site is working as expected. Do you want to review when done, or shall I just go ahead and merge? |
The Hugo template created a placeholder home page. Modify the content so it states something sensible for CDSP for people who end up here, although currently the docs root page is a better landing page. Signed-off-by: Stephen Lawrence <stephen.lawrence@renesas.com>
Hextra v0.12 introduced click-to-zoom support for Markdown images [1].
Testing showed that click-to-zoom for markdown using the form
{{< figure src=<file> title=<text> >}} was not working. However it does
work for the markdown form . So convert image
links to use the second working form.
[1] https://imfing.github.io/hextra/blog/v0.12/#image-zoom
Signed-off-by: Stephen Lawrence <stephen.lawrence@renesas.com>
Add the Hextra example github workflow for building the new Hugo Hextra documentation site and deploying it to github pages. Signed-off-by: Stephen Lawrence <stephen.lawrence@renesas.com>
Tell the Hugo build where to find the doc site source tree Signed-off-by: Stephen Lawrence <stephen.lawrence@renesas.com>
slawr
force-pushed
the
doc-site-migrate-to-hextra
branch
from
0b05f22 to
99d6947
Compare
slawr
changed the title
Collaborator
Author
|
Successfully tested site and github workflow deployment locally. Removing WIP from PR. Ready for review/merge. |
Remove the content for the old doc site in /docs/docs-gen/ that used the Learn Hugo theme and old Hugo version. Signed-off-by: Stephen Lawrence <stephen.lawrence@renesas.com>
Remove the github action build_check.yaml that despite its name only build the old doc site. The new doc site uses an updated action called pages.yaml Signed-off-by: Stephen Lawrence <stephen.lawrence@renesas.com>
4 tasks
Collaborator
Author
|
Change is self-contained and we need to get it merged to allow others to extend the documentation. Merging. |
github-project-automation
Bot
moved this from In Progress
to Done
in Central Data Service Playground
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Implementing enhancement #90