Skip to content

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

Niloth-p
Copy link
Contributor

Moved from #32780, following the migration of the integration docs of the API integrations.

Updates since last review

  1. Warning note: "This integration is meant to be executed on your Git server." -> "This integration adds a post-receive hook to your Git repository on your Git server."
  2. Rewritten instruction: "Symlink the post-receive hook of your Git repository by running:" -> "If your Git server and your Zulip server are on the same machine, symlink the post-receive hook of your Git repository in your Git server by running: ...command... Otherwise, copy the post-receive hook to your Git repository's /hooks directory."
  3. Converted the tip "The post-receive hook is triggered on every push to the repository." to a line of text inside the instruction.
  4. Opened #34494 to update the installation macro.

Screenshot

img

Self-review checklist
  • Self-reviewed the changes for clarity and maintainability
    (variable names, code reuse, readability, etc.).

Communicate decisions, questions, and potential concerns.

  • Explains differences from previous plans (e.g., issue description).
  • Highlights technical choices and bugs encountered.
  • Calls out remaining decisions and concerns.
  • Automated tests verify logic where appropriate.

Individual commits are ready for review (see commit discipline).

  • Each commit is a coherent idea.
  • Commit message(s) explain reasoning and motivation for changes.

Completed manual review and testing of the following:

  • Visual appearance of the changes.
  • Responsiveness and internationalization.
  • Strings and tooltips.
  • End-to-end functionality of buttons, interactions and flows.
  • Corner cases, error conditions, and easily imagined bugs.

Sorry, something went wrong.

@Niloth-p
Copy link
Contributor Author

@laurynmm Could you please review this?

Copy link

@laurynmm laurynmm left a 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.

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!}

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.

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?

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

Successfully merging this pull request may close these issues.

None yet

3 participants