search

jquery / contribute.jquery.org

Developer documentation common to jQuery projects
https://contribute.jquery.org
Other
25 stars 76 forks source link

Websites: Clarify deploy and tag stage #119

Closed agcolom closed 9 years ago

agcolom commented 9 years ago

Fixes gh-116

agcolom commented 9 years ago

@arthurvr Yes, I think i've fixed it here

mgol commented 9 years ago

Looks fine but I have one doubt - are there more places where we describe steps for maintainers that might have the repo set up to have an origin upstream remote? This would be quite repetitive to put this same text in all those places.

agcolom commented 9 years ago

@scottgonzalez Thanks for the feedback. I've updated the PR with your comments, and put it in a warning div. @mzgol I may have missed it but I have never come across such an explanation anywhere on our sites.

mgol commented 9 years ago

@mzgol I may have missed it but I have never come across such an explanation anywhere on our sites.

I meant that this notice will make only maintainers that go to this specific site see the notice about upstream/origin, others won't. So for it to be complete it should either be everywhere or nowhere; but "everywhere" will mean either repetition or linking to a common source.

agcolom commented 9 years ago

@mzgol oh I see. I suppose we could in that case copy the same warning div to this page: http://contribute.jquery.org/repo-maintainers-guide/ where we first mention pushing to upstream. @scottgonzalez What do you think?

agcolom commented 9 years ago

Or we put the warning just before the heading http://local.contribute.jquery.org/repo-maintainers-guide/#fixing-commits (so just after we mention both origin and upstream) and say

The examples above use upstream for the repo in the jQuery organization on GitHub. Use git remote -v to ensure that you're pushing to the correct remote repo. For example, if you use orgin for the repo in the jQuery organization, and ustream for your fork, swap upstream with origin.

mgol commented 9 years ago

For example, if you use (..) ustream for your fork.

This seems weird, I doubt many people will name their forks upstream; it's more likely they'll use their own name or sth else. I'd remove that part.

That page already has this:

Assuming you have the jquery repo set as your upstream remote

so maybe here it's already covered. Are there more sites where this would be an issue?

agcolom commented 9 years ago

@mzgol indeed, that's at the top of the maintainer's guide page. So I'd agree with you, we don't need to add more on that page. I think all other pages are covered. So I think for now we only need to fix the page I'm taking care of in this PR.

mgol commented 9 years ago

I think all other pages are covered. So I think for now we only need to fix the page I'm taking care of in this PR.

LGTM then!

scottgonzalez commented 9 years ago

@scottgonzalez What do you think?

I think you should do whatever makes sense for the people who need the documentation :-)