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

Add a preview to the site on CI with a clickable link to visually inspect site updates #771

Open
SRodi opened this issue Sep 23, 2024 · 1 comment
Labels
area/documentation Improvements or additions to documentation area/infra Test, Release, or CI Infrastructure priority/2 P2 scope/S Change is Small type/enhancement New feature or request

Comments

@SRodi
Copy link
Member

SRodi commented Sep 23, 2024

Is your feature request related to a problem? Please describe.
When changes occur on the site, there is currently no option to visually inspect directly on a browser.

It'd be good to have a preview option in the CI to avoid checkout the branch and serve the site locally to visually check website updates.

Currently, in order to run the site locally we need the following:

# from retina project root
make docs-prod
cd site
npm run serve

Describe the solution you'd like
An automated step included in the CI that provides a clickable link with the site preview based on the most recent PR commit

Describe alternatives you've considered
An alternative is to add clear instructions under https://retina.sh/docs/Contributing/developing with how to serve the site locally.

Additional context
Some OpenSource projects use netlify, see https://github.com/istio/istio.io

FYI @nddq @ibezrukavyi

@rbtr
Copy link
Collaborator

rbtr commented Sep 23, 2024

we serve the site through github pages, I wonder if it is possible to have the CI publish to a staging location for that? <branch-name>.retina.sh or similar

@rbtr rbtr added area/documentation Improvements or additions to documentation type/enhancement New feature or request area/infra Test, Release, or CI Infrastructure priority/2 P2 scope/S Change is Small labels Sep 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation area/infra Test, Release, or CI Infrastructure priority/2 P2 scope/S Change is Small type/enhancement New feature or request
Projects
Status: No status
Development

No branches or pull requests

2 participants