-
Notifications
You must be signed in to change notification settings - Fork 7.5k
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: deploy docs using netlify #4774
Conversation
5410aff
to
c3713e5
Compare
Once this is merged and published, we can change |
Do legacy docs have to be in the repo? or could we pull them down on netlify before deploy? |
build/netlify-docs.js
Outdated
process.exit(1); | ||
|
||
// if we're on any other branch, we can regenerate docs | ||
else { |
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.
seems like we should have { and } here
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.
um... yes. Forgot to do so.
The legacy docs don't strictly have to be here but I think it's easier to just include them and copy them over during the deploy rather than trying to figure out how to download it. |
I just think it will add a lot of bulk to the repo during |
I don't have a problem with this. It will add something to the Changes LGTM |
Description
This adds in the legacy docs into the repo and enables automatic deployment via netlify. The
netlify-docs.js
script will error out the build on netlify on master if we're not on a tagged commit so that it won't redeploy the docs unless there's a new release. If we're not on master or on master with a tagged commit, it will process with the deploy.Also, this removes the API docs from being published with npm, fixing #4609.