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

Migrate from GitBook to Docusaurus #7295

Merged
merged 6 commits into from
May 5, 2020
Merged

Conversation

benmccann
Copy link
Contributor

@benmccann benmccann commented Apr 28, 2020

GitBook is now unmaintained since they are focusing on a commercial solution. Closes #7267

This fixes all but one minor security issue from dependencies. Closes #5838

Copy link
Member

@kurkle kurkle left a comment

Choose a reason for hiding this comment

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

Just a quick look.

.travis.yml Outdated Show resolved Hide resolved
Copy link
Member

@etimberg etimberg left a comment

Choose a reason for hiding this comment

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

No complaints. I don't know bash well, so it's hard to review the deploy script. Has it been tested locally?

@benmccann
Copy link
Contributor Author

I haven't tested the deploy script locally much yet. My plan was if this all looks okay then to run the deploy script locally to manually deploy the docs to https://www.chartjs.org/docs/next/ which I figured would be a good test of the deploy script and also allow me to get the docs indexed by Algolia so that I can add the search plugin.

Copy link
Member

@kurkle kurkle left a comment

Choose a reason for hiding this comment

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

Couple of comments, almost good to go!

scripts/deploy.sh Show resolved Hide resolved
cp -r $in_files $out_path/$VERSION
update_latest $out_path
function deploy_versioned_files {
local version=$1
Copy link
Member

Choose a reason for hiding this comment

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

could use $VERSION here to be consistent with update_tagged_files (or the other way)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm not sure I understand this suggestion. $VERSION is a global variable. I'm using $version here to avoid colliding with it

docs/docusaurus.config.js Outdated Show resolved Hide resolved
docs/docusaurus.config.js Outdated Show resolved Hide resolved
docs/docusaurus.config.js Outdated Show resolved Hide resolved
@benmccann
Copy link
Contributor Author

Thanks for the great review @kurkle !

@benmccann
Copy link
Contributor Author

Ok, I tested this script out by running it locally to create chartjs/chartjs.github.io#6

There were a few issues in this PR which I've fixed by pushing a couple new commits. It should all work now hopefully. It might be better to merge chartjs/chartjs.github.io#6 first and make sure the docs actually work on GitHub pages before merging this one

@etimberg
Copy link
Member

etimberg commented May 4, 2020

Shall we merge this?

@benmccann
Copy link
Contributor Author

not quite yet. It looks like the deployed version didn't work. that may just be because I hacked things to run it locally and forgot a step. I'll investigate

@benmccann
Copy link
Contributor Author

I think I skipped a step for the manual deploy and everything's fine here. Let's make sure though. Here's another attempt at the manual deploy that I think is working better: chartjs/chartjs.github.io#7

@benmccann
Copy link
Contributor Author

Ok, it looks pretty good deployed now! Let's merge this 😄

@etimberg etimberg merged commit 2851a94 into chartjs:master May 5, 2020
etimberg pushed a commit that referenced this pull request Sep 1, 2020
Migrate from GitBook to Docusaurus
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants