Skip to content

Docs: Create "Installation" section out of Guide #1610

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

Merged
merged 8 commits into from
Jul 8, 2020

Conversation

afontcu
Copy link
Member

@afontcu afontcu commented Jul 7, 2020

This PR adds an Installation section in docs:

image


There are a lot of low-hanging fruits in VTU v1 docs, and I plan on tackling them in the future. Meanwhile, this PR:

  • Creates a Installation section.
  • Reduces the amount of content in the section. As Lachlan said, keeping these kind of docs up to date is a burden and none of the other Vue projects contain this kind of low level tooling info.
  • Recommends Jest as the default way to run VTU.
  • Removes snapshot testing section. This is opinionated, so I'm happy to discuss it further. Component snapshot testing creates a totally coupled tests that break on every iteration. Thus, snapshot testing should not be highlighted that much in VTU docs.
  • Adds Semantic Versioning section, just as Vue docs does.

If we agree on these changes, then we'd need to update docs in ru, zh, and ja. I can do my best by copying and pasting, but I'd need someone to review changes! 😇


Also this PR closes #1606

@lmiller1990
Copy link
Member

lmiller1990 commented Jul 7, 2020

Thanks, we should definitely keep this section lean and focused. I can fix the Japanese docs this week sometime.

Potentially unpopular opinion, but more docs (especially around tooling) means more maintenance required. I think we should straight up delete:

  • Testing Single-File Components with Mocha + webpack (just recommend jest instead)
  • Testing Single-File Components with Karma ( 🤷‍♂️ idk who uses this, they can figure it out)
  • Testing in Node.js Without a Build Step (not that common - "advanced" use case. all you need to do is import a few libraries anyway. Could include a paragraph instead of an entire page, something like "ensure jsdom is available before import vue test utils)

Maintaining these is hard, dependencies constantly changed. None of the other Vue projects contain this kind of low level tooling info - at best, they give you a paragraph or two.

@dobromir-hristov
Copy link
Contributor

Looks good to me

@afontcu
Copy link
Member Author

afontcu commented Jul 8, 2020

Potentially unpopular opinion, but more docs (especially around tooling) means more maintenance required. I think we should straight up delete:

Not that unpopular over here, hahaha. I'm up for it. Actually, while moving things around I thought we should have a single page à la vuejs.org (https://vuejs.org/v2/guide/installation.html), with some recommendations (Jest).

@lmiller1990
Copy link
Member

Great!

@lmiller1990
Copy link
Member

lmiller1990 commented Jul 8, 2020

A little worried out dated translations... 🤔 feel free to hit merge, don't think the translations should be a blocker.

@afontcu
Copy link
Member Author

afontcu commented Jul 8, 2020

A little worried out dated translations

Me too… we can always point to this PR if someone is willing to update them!

@afontcu afontcu merged commit 1d9d548 into dev Jul 8, 2020
@afontcu afontcu deleted the split-installation-section branch July 8, 2020 11:38
@Jinjiang
Copy link
Member

Jinjiang commented Jul 9, 2020

LGTM about the zh part. Thanks :-)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Unclear why documentation uses wrapper.element for snapshots
4 participants