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

docs: Support staging multiple branches, remove docs front page #1783

Merged
merged 4 commits into from Mar 29, 2022

Conversation

ozamosi
Copy link
Contributor

@ozamosi ozamosi commented Mar 23, 2022

This makes the staging do actual staging - that is, for this branch, the docs are in https://staging.docs.gitops.weave.works/docs-per-branch

This also adds a little status update, which you can see by scrolling through the checks in the PR and clicking on Details for "Doc site preview" that takes you to that specific URL.

This finally removes the front page of the docs, and replaces it with a redirect to the intro. I needed to make a docs change to trigger the docs pipeline to see that the previous changes worked, and this was something @sympatheticmoose specifically requested.

@ozamosi ozamosi force-pushed the docs-per-branch branch 17 times, most recently from 2d4ef95 to e85927e Compare March 23, 2022 17:19
Robin Sonefors added 4 commits March 23, 2022 17:26
We use node 16 to build the main UI, so it seems more consistent to
just use that here, too.
This means we can have multiple PRs that affect the docs site open at
the same time, without them clobbering each other.

This also adds a status check to the github checks that take you
straight to the staged website.

Finally, it turns off the gcp cache for the uploaded docs, because the
whole point is that we want to be able to change them - the default is
a 1 hour cache.
@ozamosi ozamosi changed the title docs: Staging docs improvement docs: Support staging multiple branches, remove docs front page Mar 23, 2022
@ozamosi ozamosi marked this pull request as ready for review March 23, 2022 19:19
@sympatheticmoose
Copy link
Contributor

thanks @ozamosi !

@ozamosi ozamosi requested a review from SamLR March 29, 2022 09:38
Copy link
Contributor

@SamLR SamLR left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not keen on the sed use to rewrite the config file but I'm not sure there's a better option.

I'm also a little confused by the pre-existing 'if yarn then yarn else npm` build step but I'm inclined to leave it.

@ozamosi ozamosi merged commit 490cbdb into main Mar 29, 2022
@ozamosi ozamosi deleted the docs-per-branch branch March 29, 2022 11:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants