mirror of
https://github.com/zulip/zulip.git
synced 2025-11-02 13:03:29 +00:00
integrations: Document Zulip Onyx integration.
The integration with Onyx is via the Zulip Connector of Onyx.
This commit is contained in:
BIN
static/images/integrations/bot_avatars/onyx.png
Normal file
BIN
static/images/integrations/bot_avatars/onyx.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 4.5 KiB |
BIN
static/images/integrations/logos/onyx.png
Normal file
BIN
static/images/integrations/logos/onyx.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 17 KiB |
34
templates/zerver/integrations/onyx.md
Normal file
34
templates/zerver/integrations/onyx.md
Normal file
@@ -0,0 +1,34 @@
|
||||
# Zulip Onyx Integration
|
||||
|
||||
Export discussions from Zulip channels and topics to your Onyx knowledge
|
||||
base!
|
||||
|
||||
{start_tabs}
|
||||
|
||||
1. {!create-a-generic-bot.md!}
|
||||
|
||||
1. [Subscribe the bot][subscribe-channels] to the Zulip channels that you
|
||||
want to export.
|
||||
|
||||
1. Copy the bot's credentials by clicking the **copy**
|
||||
(<i class="zulip-icon zulip-icon-copy"></i>) icon under the bot's name.
|
||||
|
||||
1. In Onyx, open the **Admin Dashboard** and select the **Zulip Connector**.
|
||||
|
||||
1. Under **Provide Credentials**, paste the credentials that you copied
|
||||
above, and click **Update**.
|
||||
|
||||
1. Set **Realm name** to the name of your Zulip organization, set
|
||||
**Realm URL** to `{{ zulip_url }}`, and click **Connect**.
|
||||
|
||||
{end_tabs}
|
||||
|
||||
Congrats, you're done! You should be able to index Zulip from your Onyx
|
||||
**Connectors Dashboard**!
|
||||
|
||||
### Related documentation
|
||||
|
||||
* [Zulip Connector documentation](https://docs.onyx.app/connectors/zulip)
|
||||
* [About Onyx Connectors](https://docs.onyx.app/connectors/overview)
|
||||
|
||||
[subscribe-channels]: /help/manage-user-channel-subscriptions#subscribe-a-user-to-a-channel
|
||||
@@ -588,6 +588,12 @@ INTEGRATIONS: dict[str, Integration] = {
|
||||
doc="zerver/integrations/openshift.md",
|
||||
stream_name="deployments",
|
||||
),
|
||||
"onyx": Integration(
|
||||
"onyx",
|
||||
["productivity"],
|
||||
logo="images/integrations/logos/onyx.png",
|
||||
doc="zerver/integrations/onyx.md",
|
||||
),
|
||||
"perforce": Integration("perforce", ["version-control"], doc="zerver/integrations/perforce.md"),
|
||||
"phabricator": Integration(
|
||||
"phabricator", ["version-control"], doc="zerver/integrations/phabricator.md"
|
||||
|
||||
Reference in New Issue
Block a user