From c7d42665a9797f2fb4be73e8d06b295d9ac38f88 Mon Sep 17 00:00:00 2001 From: Niloth P <20315308+Niloth-p@users.noreply.github.com> Date: Thu, 14 Nov 2024 17:28:15 +0530 Subject: [PATCH] integration-docs: Update Codebase for new doc format. Part of zulip#29592. --- templates/zerver/integrations/codebase.md | 38 +++++++++++++++-------- 1 file changed, 25 insertions(+), 13 deletions(-) diff --git a/templates/zerver/integrations/codebase.md b/templates/zerver/integrations/codebase.md index 2cd864bff0..790f96f886 100644 --- a/templates/zerver/integrations/codebase.md +++ b/templates/zerver/integrations/codebase.md @@ -1,9 +1,16 @@ +# Zulip Codebase integration + Get Codebase notifications in Zulip! -1. First, create the streams you’d like to use for Codebase notifications. There - will be two types of messages: commit-related updates and issue-related - updates. We recommend naming the streams `codebase` and `tickets`, respectively. - After creating these streams, make sure to subscribe all interested parties. +{start_tabs} + +1. [Create the channels](/help/create-a-channel) you’d like to use for + Codebase notifications. There will be two types of messages: + commit-related updates and issue-related updates. + + !!! tip "" + + We recommend naming the channels `codebase` and `tickets`, respectively. 1. {!create-an-incoming-webhook.md!} @@ -11,8 +18,10 @@ Get Codebase notifications in Zulip! 1. {!change-zulip-config-file.md!} - You may also need to update the value of `ZULIP_TICKETS_STREAM_NAME` and - `ZULIP_COMMITS_STREAM_NAME`. + ``` + ZULIP_TICKETS_STREAM_NAME = "" + ZULIP_COMMITS_STREAM_NAME = "" + ``` 1. Go to your Codebase settings, and click on **My Profile**. Under **API Credentials**, you will find your API key and username. @@ -24,16 +33,19 @@ Get Codebase notifications in Zulip! CODEBASE_API_KEY = 0123456789abcdef0123456789abcdef ``` - Before your first run of the script, you may also want to configure the - integration to mirror some number of hours of prior Codebase activity: + !!! tip "" - ``` - CODEBASE_INITIAL_HISTORY_HOURS = 10 - ``` + Before your first run of the script, you may also want to configure the + integration to mirror some number of hours of prior Codebase activity: `CODEBASE_INITIAL_HISTORY_HOURS = 10` 1. Run the `/usr/local/share/zulip/integrations/codebase/zulip_codebase_mirror` - script. If needed, this script may be restarted, and it will automatically - resume from when it was last running. + script. + + !!! tip "" + + On restarts, this script will automatically resume from last runtime. + +{end_tabs} {!congrats.md!}