Skip to content
This repository has been archived by the owner on Oct 20, 2021. It is now read-only.

Package management - make it obvious what to commit to git #216

Closed
floer32 opened this issue Jan 8, 2021 · 2 comments
Closed

Package management - make it obvious what to commit to git #216

floer32 opened this issue Jan 8, 2021 · 2 comments

Comments

@floer32
Copy link

floer32 commented Jan 8, 2021

I think the docs should answer for the user - After I do meteor add, what do I commit to version control?

I found old threads (like meteor/meteor#4866) but in my opinion it's not resolved.


In a command...

git add --all .meteor

So why wouldn't the docs include that, or something like it? I tried searching the docs as well, for 'version control', 'commit', 'git', etc, and relevant results weren't appearing.

Before I found confirmation it was clean to commit .meteor, I had a vague impression that maybe Meteor's package management was more (globally) stateful than I'd like. Even if the step is obvious to some, I think it would confuse or alienate some users.

@floer32
Copy link
Author

floer32 commented Jan 8, 2021

Maybe there's hesitation to mention one specific VCS, but that seems inconsistent. Meteor isn't shy about choosing preferred tools, and links to pretty specific external things in the guides. So in my opinion it should be fine to mention git by name (for sake of directly answering what people will probably search for -- keyword-wise), but with a note that any version control system can be used.

I just checked site:meteor.com git and site:docs.meteor.com git on a Google search. There aren't clean results from official docs. Same gist with site:meteor.com version control / site:docs.meteor.com version control. Just forum results.

One last thing. Meteor even puts a .gitignore into the .meteor directory. While that doesn't couple to git, I think it makes it fair-game to mention git in the docs.

@filipenevola
Copy link
Collaborator

Hi @hangtwenty, maybe we could have a doc about version control and what are the important files, when they update, etc.

Are you willing to write this PR in the docs repository?

See the image below with the docs menu and where I think it should go.
underscore | Meteor API Docs 2021-01-20 07-27-33

I'm closing this issue here because the docs repo is this one https://github.com/meteor/docs

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

No branches or pull requests

2 participants