Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make release version visible in the loading page to validate after deployment #556

Open
Reshrahim opened this issue May 2, 2023 · 3 comments
Labels
enhancement New feature or request triaged

Comments

@Reshrahim
Copy link
Contributor

Reshrahim commented May 2, 2023

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.

Screenshot 2024-03-13 at 11 34 24 AM

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:

Screenshot 2024-03-13 at 11 34 11 AM

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

AB#7769

@AaronCrawfis
Copy link
Contributor

@Reshrahim not following this request. What site do you mean, and what loading page?

@Reshrahim
Copy link
Contributor Author

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

@Reshrahim
Copy link
Contributor Author

Removing nov-release label as this item is not blocking

@jasonviviano jasonviviano added the enhancement New feature or request label Oct 27, 2023
@jasonviviano jasonviviano self-assigned this Mar 13, 2024
@jasonviviano jasonviviano removed their assignment Mar 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request triaged
Projects
None yet
Development

No branches or pull requests

4 participants