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

Switch docs to Vuepress to match other chart.js repositories #8751

Merged
merged 32 commits into from
Mar 30, 2021

Conversation

etimberg
Copy link
Member

Work Done

  • Documentation moved from Docusaurus to Vuepress
  • Live editing done using the vuepress-theme-chartjs plugin

Testing Done

  • Local testing of docs using npm run docs:dev
  • Testing of deploy-docs action locally all the way until it pushes to GitHub pages

Resolves #5712

@kurkle
Copy link
Member

kurkle commented Mar 30, 2021

Tests deployment (without the conditional base): https://9b316917.chart-js.pages.dev/

@etimberg etimberg marked this pull request as ready for review March 30, 2021 12:18
@LeeLenaleee
Copy link
Collaborator

Maby its a good idea to remove links to hardcoded lines in the source files since if you add/remove lines there you will have to update that in the docs too.

For example the link to the core animations default is now a few lines short (https://9b316917.chart-js.pages.dev/configuration/animations.html#animation) or the Link in the plugin core api (https://9b316917.chart-js.pages.dev/developers/plugins.html#plugin-core-api) is wrong now (was done this way as temp fix because the list was removed from v2 -> v3 docs)

@etimberg
Copy link
Member Author

Good call @LeeLenaleee. I removed those. For the plugins, https://www.npmjs.com/package/vuepress-plugin-typedoc seems promising to get the typedocs working and we can try and build them from the .d.ts file rather than code comments

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.

lgtm

@etimberg etimberg merged commit ed2b96e into chartjs:master Mar 30, 2021
@etimberg etimberg added this to the Version 3.0 milestone Mar 30, 2021
@LeeLenaleee
Copy link
Collaborator

LeeLenaleee commented Mar 30, 2021

@etimberg @kurkle When I try to build the docs locally (as dev and as a real static build) it gives me a basic html only page with only the md file as content. The same error is happening with the deploy at the moment (https://www.chartjs.org/docs/master/)

image

@etimberg etimberg deleted the vuepress-docs branch March 30, 2021 14:40
@etimberg
Copy link
Member Author

@LeeLenaleee what node version are you using locally?

@LeeLenaleee
Copy link
Collaborator

12.16.2, after updating to the latest LTS (14.16.0) resolved the issue for me, although it seems like the master docs is still broken even though you made it build with node 14 now

@etimberg
Copy link
Member Author

I think its a combination of GitHub pages + Cloudflare caching at this point.

I got the broke page once and it loaded the old style file, https://www.chartjs.org/docs/master/assets/css/0.styles.fc8ef512.css but the latest is https://www.chartjs.org/docs/master/assets/css/0.styles.4f043ac6.css

@etimberg
Copy link
Member Author

@kurkle found that if we go to https://www.chartjs.org/docs/master/getting-started/ it works, so seems like the old index page got cached

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.

Contribution to the documentation
3 participants