-
Notifications
You must be signed in to change notification settings - Fork 74
Websites: Clarify deploy and tag stage #119
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
Conversation
`git push --tags origin master` | ||
Afterwards, make sure to push both version change commit and the tag to the main jQuery repo. | ||
|
||
<div class="warning">You'll want to check your remote setup using ```git remote -v``` and check which remote is used for the main jQuery repo.</div> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This doesn't render correctly. Check the GitHub preview of this markdown file. From the markdown spec:
Note that Markdown formatting syntax is not processed within block-level HTML tags. E.g., you can’t use Markdown-style emphasis inside an HTML block.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@arthurvr It all looks fine for me when deployed locally. Also should I use single ``` instead?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@arthurvr Yes, I think i've fixed it here |
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 |
@@ -120,8 +120,14 @@ For other sites: | |||
|
|||
To create a tag, use `npm version [major | minor | patch]`. | |||
|
|||
Afterwards, make sure to push both version change commit and the tag: | |||
`git push --tags origin master` | |||
Afterwards, make sure to push both version change commit and the tag to the main jQuery repo. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think this change is necessary, especially with the warning included.
@scottgonzalez Thanks for the feedback. I've updated the PR with your comments, and put it in a warning div. |
I meant that this notice will make only maintainers that go to this specific site see the notice about |
@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? |
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 The examples above use |
This seems weird, I doubt many people will name their forks That page already has this:
so maybe here it's already covered. Are there more sites where this would be an issue? |
@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. |
LGTM then! |
I think you should do whatever makes sense for the people who need the documentation :-) |
Fixes gh-116