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: deploy docs using netlify #4774

Merged
merged 13 commits into from
Dec 4, 2017
Merged

docs: deploy docs using netlify #4774

merged 13 commits into from
Dec 4, 2017

Conversation

gkatsev
Copy link
Member

@gkatsev gkatsev commented Nov 29, 2017

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.

@gkatsev gkatsev changed the title [WIP] docs: docs docs docs docs: deploy docs using netlify Nov 29, 2017
@gkatsev
Copy link
Member Author

gkatsev commented Nov 29, 2017

Once this is merged and published, we can change docs.videojs.com from pointing at the github pages to netlify.

@brandonocasey
Copy link
Contributor

Do legacy docs have to be in the repo? or could we pull them down on netlify before deploy?

process.exit(1);

// if we're on any other branch, we can regenerate docs
else {
Copy link
Contributor

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

Copy link
Member Author

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.

@gkatsev
Copy link
Member Author

gkatsev commented Nov 30, 2017

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.

@brandonocasey
Copy link
Contributor

I just think it will add a lot of bulk to the repo during git clone other than that I don't see why we couldn't keep it in the repo. I guess either way is fine, but maybe we should get other opinions.

@misteroneill
Copy link
Member

misteroneill commented Dec 1, 2017

I don't have a problem with this. It will add something to the git clone cost, but I don't think it's a lot. And it's a one-time cost versus adding complexity to the versioning process to download/generate old docs.

Changes LGTM

@gkatsev gkatsev added confirmed patch This PR can be added to a patch release. labels Dec 4, 2017
@gkatsev gkatsev merged commit 4dd000c into master Dec 4, 2017
@gkatsev gkatsev deleted the docs-docs-docs branch December 4, 2017 22:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
confirmed patch This PR can be added to a patch release.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants