-
Notifications
You must be signed in to change notification settings - Fork 987
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
Prerelease docs site #306
Prerelease docs site #306
Conversation
Could we consider adding |
@clrcrl I decided to add a warning banner in lieu of interpolating the word "Prerelease" in arbitrary places. Let me know if you had something quite different in mind! |
Very nice! We'll have to remember to remove this when we merge into master :) Also I noticed that this PR is against I think we should also have a Let me fuss around with it and see how far I get with things. |
The banner dynamically populates, using Netlify context variables, based on whether the branch being deployed is named
My goal in merging this into
Great idea! I think most community-contributed docs should still be against |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I just added some notes on how to release this.
Once this is merged in we should:
- Change the default branch to
current
, and put branch protection on it. Also edit existing PRs to be against thecurrent
branch - Put branch protection on the
next
branch too. I'm not sure how that will work when we need to rebasenext
fromcurrent
, but ¯_(ツ)_/¯
REPO SYNC - Public to Private
I added Netlify config (
netlify.toml
) for branch-based deployment of the long-livednext
branch, which will serve prerelease docs.Here's the site: https://next--docs-getdbt-com.netlify.app/
For prettiness' sake, we'll want to CNAME this to
docs-next.getdbt.com
, but that's not actually a blocker.I defined two new environment variables:
ALGOLIA_INDEX_NAME
:dbt
normally,dbt-next
for prerelease docsDISCLAIMER
: I just added the word "Prerelease " in some prominent places. We could/should add a bright warning banner to the top of the homepage / every page as well.Also:
X-robots-tag = "noindex"
as a header for thenext
deploymentmaster
ornext
. So the only deployments we'll have aremaster
(production),next
(prerelease), and previews of PRs that target either of those two branches.My thinking is that we can merge this commit into
master
with absolutely zero effect, so that the two branches can stay even. Then, I'll merge #302 into thenext
branch.