docs
docs copied to clipboard
radius-project
Make release version visible in the loading page to validate after deployment
Description
The current Radius documentation page navbar displays the information regarding the corresponding Radius version the user is reading about by displaying either edge or latest to users.
Users should have more clarity when consulting the documentation and be displayed either edge or v0.xx to clarify the version the documentation corresponds to. Similar to this:
Definition of done
An automatic process is in place to update the navbar latest entry to a release version that follows the Radius release version.
Additional Context
The current release process for the documentation follows a script in the GitHub Actions called .github/scripts/release-docs.sh. This file updates the information found in the config.toml which is a text based file that the Hugo framework which runs our documentation follows for creating configurations as well as variables that are consumed by the actual markdown files and frontend UI we leverage. Currently the navbar UI components we use leverage the variable version to choose what name to display in the navbar.
By editing the release-docs.sh file users can impact the content of config.toml. This seems like the most straightforward way to create an automatic process but needs to be double checked to confirm changes don't have any breaking effect.
There's an older PR that can possibly also be used as reference for ideas on how to impact/create commands to impact the release-docs.sh found here: https://github.com/radius-project/docs/pull/1083/files
@Reshrahim not following this request. What site do you mean, and what loading page?
Updated the description. Meant the docs page and the home page as the loading page. This was encountered when we did the docs release and did not have an easy way to validate if the changes got in except for checking on the content
Would be good if we can indicate the release version instead of latest