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

Move core plugins docs to documentation website #4120

Merged
merged 7 commits into from Jun 12, 2019

Conversation

Projects
None yet
2 participants
@NataliaTepluhina
Copy link
Contributor

commented Jun 8, 2019

This PR is designed to move core plugins docs to CLI documentation website. This will allow us to keep documentation up-to-date with the latest release.

Plugins to move:

  • Babel
  • TypeScript
  • ESLint
  • PWA
  • Jest
  • Mocha
  • Cypress
  • Nightwatch

Close #4117

@NataliaTepluhina NataliaTepluhina changed the title [WIP] Move core plugins docs to documentation website Move core plugins docs to documentation website Jun 10, 2019

@NataliaTepluhina

This comment has been minimized.

Copy link
Contributor Author

commented Jun 10, 2019

@Akryum @sodatea @LinusBorg could you please take a look at this one?

Important note: these docs are relevant for 3.8.2 version, i.e. the latest changes to PWA doc from 4.0.0-alpha are not included. The reason is described here

@sodatea

This comment has been minimized.

Copy link
Member

commented Jun 11, 2019

Thanks for the help!
I like the idea of moving the docs to the website, it's easier for translation collaboration.

Though, as for the links on the website, I've already redirected them to v3 branch 821067f (The deployed version lies in the docs branch)

As for the developing v4 docs, instead of manually copying-and-pasting from the README files, what about writing a script to automatically generate the docs page on publishing new versions? So that it won't be out of sync.

@NataliaTepluhina

This comment has been minimized.

Copy link
Contributor Author

commented Jun 12, 2019

Ready 😅

@sodatea sodatea merged commit 20c96c4 into vuejs:dev Jun 12, 2019

7 checks passed

ci/circleci: cli-ui Your tests passed on CircleCI!
Details
ci/circleci: group-1 Your tests passed on CircleCI!
Details
ci/circleci: group-2 Your tests passed on CircleCI!
Details
ci/circleci: group-3 Your tests passed on CircleCI!
Details
ci/circleci: group-4 Your tests passed on CircleCI!
Details
ci/circleci: install Your tests passed on CircleCI!
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.