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 vuepress #5847

Closed
wants to merge 1 commit into from
Closed

Conversation

benmccann
Copy link
Contributor

This fixes the remaining security vulnerabilities in our dependencies

@kurkle
Copy link
Member

kurkle commented Jan 13, 2019

How does it change the look of docs?

@benmccann
Copy link
Contributor Author

Not much. It looks pretty similar. The main motivation is that gitbook no longer maintains their open source project and have moved on to supporting only their commercial service. There's no way to get bug fixes, security fixes, etc. for gitbook anymore

@simonbrunel
Copy link
Member

I thought I commented this PR but apparently not. These changes break our CD because vuepress doesn't support to be deployed in a sub-folder. I figured out that issue when I started migrating this repo to vuepress a bit after do the same for the datalabels plugin.

So we need to wait vuejs/vuepress#796 to be fixed first.

@benmccann
Copy link
Contributor Author

Hmm. It's not clear to me that it's something they plan to fix. It seems like the recommendation is to use a static server: vuejs/vuepress#575 (comment). Would it be an option to deploy a static server to our production environment?

@benmccann
Copy link
Contributor Author

Actually, maybe this will be implemented soonish. See vuejs/vuepress#796 (comment)

@benmccann
Copy link
Contributor Author

I'm going to close this for now until vuepress is updated with the proper support

@kurkle
Copy link
Member

kurkle commented Apr 2, 2021

I thought I commented this PR but apparently not. These changes break our CD because vuepress doesn't support to be deployed in a sub-folder. I figured out that issue when I started migrating this repo to vuepress a bit after do the same for the datalabels plugin.

So we need to wait vuejs/vuepress#796 to be fixed first.

Interestingly its still not fixed, but we have migrated to vuepress.

@simonbrunel
Copy link
Member

Good job! The issue was mainly because of the latest alias which is not a redirection, so the base URLs are different (e.g. docs/latest vs docs/2.9.8). It also required quite a few workarounds to get the base config correctly set, which is done now but wasn't part of this PR.

@benmccann
Copy link
Contributor Author

Just FYI, we did not migrate to Vurpress, but rather to Docusaurus (React version of it)

@kurkle
Copy link
Member

kurkle commented Apr 2, 2021

We actually did migrated from docusaurus to vuepress. Just migrated the samples too!

@benmccann
Copy link
Contributor Author

Oh, interesting. Any reason for the migration?

@kurkle
Copy link
Member

kurkle commented Apr 3, 2021

@benmccann mostly because of the great work @simonbrunel did with vuepress-theme-chartjs including amazing chart-editor component.

@simonbrunel
Copy link
Member

simonbrunel commented Apr 4, 2021

Interestingly its still not fixed, but we have migrated to vuepress.

Could also be because latest is not anymore an alias but contains the docs, thus base is /docs/latest (though, it may also work with an alias). I'm not sure that's a better setup than before (when it was a symbolic link) but it seems that now it doesn't generate the docs in the "version" folder (/docs/3.0.0). I don't know if it's wanted but having docs versioned (at least for major and minor releases) was nice.

@kurkle
Copy link
Member

kurkle commented Apr 4, 2021

@simonbrunel good finding, I thought it would still be versioned. Needs to be fixed.
ping @etimberg

@etimberg
Copy link
Member

etimberg commented Apr 4, 2021

We can look at doing that. It likely requires running npm run docs twice. Once with a baseURL of /3.0.0/ and once with a baseURL of /latest

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.

4 participants