-
-
Notifications
You must be signed in to change notification settings - Fork 395
Update the Git integration doc. #867
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
base: main
Are you sure you want to change the base?
Conversation
@laurynmm Could you please review this? |
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.
@Niloth-p - Thanks for moving these updates from the other repository! I had a few comments, but overall looks good. Let me know if you have any questions about my feedback!
|
||
1. {!change-zulip-config-file.md!} | ||
**Note:** This integration adds a `post-receive` hook to your Git | ||
repository on your Git server. |
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.
With the expanded instructions for step 3, it seems like we could just drop this note/warning.
|
||
The `post-receive` hook is triggered on every push to the repository. | ||
|
||
1. {!change-zulip-config-file.md!} |
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.
Noticed in the screenshot of the rendered documentation that this is the API URL and not the URL for the Zulip organization and I just wanted to be sure that's what we want shown here.
|
||
{!congrats.md!} | ||
- The message format used in your Zulip notifications by updating the | ||
`format_commit_message` function. |
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.
Does it make sense to show the default since there isn't a screenshot?
Moved from #32780, following the migration of the integration docs of the API integrations.
Updates since last review
post-receive
hook to your Git repository on your Git server."post-receive
hook of your Git repository by running:" -> "If your Git server and your Zulip server are on the same machine, symlink thepost-receive
hook of your Git repository in your Git server by running: ...command... Otherwise, copy thepost-receive
hook to your Git repository's/hooks
directory."Screenshot
Self-review checklist
(variable names, code reuse, readability, etc.).
Communicate decisions, questions, and potential concerns.
Individual commits are ready for review (see commit discipline).
Completed manual review and testing of the following: