-
-
Couldn't load subscription status.
- Fork 13
Closed
Description
Versioned platform docs do work locally, but not online.
The github actions (build, deploy) uses the local-antora-playbook.yml to build the docs for the website. This means it builds from the local github repo inside of the action. The checkout step in the action only fetches the latest commit, so the tags/commits are missing. Using a local path instead of a URL also activates author mode, but it seems to be without consequences in our case.
Solution:
- deploy action - For the deploy action I'd use
make PLAYBOOK=antora-playbook.ymlto use the other playbook. This other playbook specifies a URL for the documentation repository, so documentation will be pulled from there. This is a simple change in the action yaml file. - build action - The build action is used in every PR to check if the docs build correctly. In there its important to build from the local branch, so using the
local-antora-playbook.yamlactually makes sense. To include the tags I'd change the checkout action to check out all of the history, instead of just the latest commit (which is the default). This is also a simple change in the action file.
Acceptance criteria:
- deploy action file adapted to use other playbook
- build action file adapted to use full commit history
- online docs show 22.06 and nightly version
Metadata
Metadata
Assignees
Labels
No labels