From d23584ef01add4dfd27b0dd8963df2c64ee3e7c6 Mon Sep 17 00:00:00 2001 From: danciaclara Date: Mon, 13 Apr 2026 19:06:15 +0530 Subject: [PATCH 1/3] Fixed GitHub alignment issues and notes in AI --- .../govern/integrations/github.md | 19 +++++++++++++------ docs/self-hosting/govern/plane-ai.md | 6 +++++- 2 files changed, 18 insertions(+), 7 deletions(-) diff --git a/docs/self-hosting/govern/integrations/github.md b/docs/self-hosting/govern/integrations/github.md index c5bdf44..425b7fe 100644 --- a/docs/self-hosting/govern/integrations/github.md +++ b/docs/self-hosting/govern/integrations/github.md @@ -43,9 +43,11 @@ Follow these steps to create a GitHub App, set callback URLs, and configure webh 1. Go to **Settings \> Developer Settings \> GitHub Apps** in your GitHub organization. 2. Click **New GitHub App**. + ![Create GitHub App](/images/integrations/github/create-github-app.webp#hero) 3. In the **Register new GitHub App** page, provide a **GitHub App name** and **Homepage URL**. + ![App name and homepage URL](/images/integrations/github/app-name-homepage-url.webp#hero) 4. In the **Identifying and authorizing users** section, add the following **Callback URLS**. @@ -56,11 +58,12 @@ Follow these steps to create a GitHub App, set callback URLs, and configure webh ``` These URLs allow Plane to verify and enable workspace connection with the Github App. + ![Add Callback URL](/images/integrations/github/add-callback-url.webp#hero) - :::warning - Make sure to opt out of **Expire user authorization tokens** feature. - ::: + :::warning + Make sure to opt out of **Expire user authorization tokens** feature. + ::: 5. In the **Post installation** section, add the below **Setup URL**. @@ -69,6 +72,7 @@ Follow these steps to create a GitHub App, set callback URLs, and configure webh ``` Redirects users to this URL after GitHub app installation. + ![Add setup URL](/images/integrations/github/add-setup-url.webp#hero) 6. Turn on **Redirect on update**. @@ -91,9 +95,11 @@ These steps cover hostname, callback URLs, and private key differences for on‑ 1. Go to **Settings \> Developer Settings \> GitHub Apps** in your GitHub organization. 2. Click **New GitHub App**. + ![Create GitHub App](/images/integrations/github/create-github-app.webp#hero) 3. In the **Register new GitHub App** page, provide a **GitHub App name** and **Homepage URL**. + ![App name and homepage URL](/images/integrations/github/app-name-homepage-url.webp#hero) 4. In the **Identifying and authorizing users** section, add the following **Callback URLS**. @@ -114,9 +120,9 @@ These steps cover hostname, callback URLs, and private key differences for on‑ These URLs allow Plane to verify and enable workspace connection with the Github App. ![Add Callback URL](/images/integrations/github/add-callback-url.webp#hero) - :::warning - Make sure to opt out of **Expire user authorization tokens** feature. - ::: + :::warning + Make sure to opt out of **Expire user authorization tokens** feature. + ::: 5. In the **Post installation** section, add the below **Setup URL**. @@ -160,6 +166,7 @@ These steps cover hostname, callback URLs, and private key differences for on‑ ### Set up permissions and events 1. Add repository and account permissions by setting the **Access** dropdown next to each permission, as shown in the tables below. + ![Setup permissions](/images/integrations/github/setup-permissions.webp#hero) **Repository permissions** diff --git a/docs/self-hosting/govern/plane-ai.md b/docs/self-hosting/govern/plane-ai.md index 4d87d95..f58ea62 100644 --- a/docs/self-hosting/govern/plane-ai.md +++ b/docs/self-hosting/govern/plane-ai.md @@ -41,6 +41,10 @@ Supported models: You can provide API keys for both OpenAI and Anthropic, making all models available to users. If you provide only one key, users will only have access to that provider's models. +:::tip +If you need to use an LLM that isn't from OpenAI or Anthropic — for example, an open-source model or a regional provider for compliance reasons — you can proxy it through [LiteLLM](https://docs.litellm.ai). LiteLLM exposes any LLM behind an OpenAI-compatible API, which Plane can then connect to using the `CUSTOM_LLM_*` variables with `CUSTOM_LLM_PROVIDER=openai`. +::: + #### Custom models (self-hosted or third-party) Plane AI supports custom models through two backends: @@ -51,7 +55,7 @@ Plane AI supports custom models through two backends: One custom model can be configured alongside your public provider keys. ::: warning -The custom model should have at least 100 billion parameters for all Plane AI features to work reliably. Larger, more capable models yield better results. +The custom model should have at least 1 trillion parameters for all Plane AI features to work reliably. Larger, more capable models yield better results. ::: ### Embedding models From c60fbe3d6b832a81f2c6eb53b808d70a66dcaf75 Mon Sep 17 00:00:00 2001 From: sriramveeraghanta Date: Mon, 13 Apr 2026 19:44:34 +0530 Subject: [PATCH 2/3] fix: formatting --- .../govern/integrations/github.md | 140 +++++++++--------- 1 file changed, 70 insertions(+), 70 deletions(-) diff --git a/docs/self-hosting/govern/integrations/github.md b/docs/self-hosting/govern/integrations/github.md index 425b7fe..f38fa77 100644 --- a/docs/self-hosting/govern/integrations/github.md +++ b/docs/self-hosting/govern/integrations/github.md @@ -36,130 +36,130 @@ To configure GitHub integration, you'll need to create a GitHub App within your == GitHub Cloud {#github-cloud} -Follow these steps to create a GitHub App, set callback URLs, and configure webhooks so Plane can sync PRs and commits from GitHub Cloud. + Follow these steps to create a GitHub App, set callback URLs, and configure webhooks so Plane can sync PRs and commits from GitHub Cloud. -#### GitHub Cloud + #### GitHub Cloud -1. Go to **Settings \> Developer Settings \> GitHub Apps** in your GitHub organization. + 1. Go to **Settings \> Developer Settings \> GitHub Apps** in your GitHub organization. -2. Click **New GitHub App**. + 2. Click **New GitHub App**. - ![Create GitHub App](/images/integrations/github/create-github-app.webp#hero) + ![Create GitHub App](/images/integrations/github/create-github-app.webp#hero) -3. In the **Register new GitHub App** page, provide a **GitHub App name** and **Homepage URL**. + 3. In the **Register new GitHub App** page, provide a **GitHub App name** and **Homepage URL**. - ![App name and homepage URL](/images/integrations/github/app-name-homepage-url.webp#hero) + ![App name and homepage URL](/images/integrations/github/app-name-homepage-url.webp#hero) -4. In the **Identifying and authorizing users** section, add the following **Callback URLS**. + 4. In the **Identifying and authorizing users** section, add the following **Callback URLS**. - ```bash - https:///silo/api/github/auth/callback - https:///silo/api/github/auth/user/callback - ``` + ```bash + https:///silo/api/github/auth/callback + https:///silo/api/github/auth/user/callback + ``` - These URLs allow Plane to verify and enable workspace connection with the Github App. + These URLs allow Plane to verify and enable workspace connection with the Github App. - ![Add Callback URL](/images/integrations/github/add-callback-url.webp#hero) + ![Add Callback URL](/images/integrations/github/add-callback-url.webp#hero) :::warning Make sure to opt out of **Expire user authorization tokens** feature. ::: -5. In the **Post installation** section, add the below **Setup URL**. + 5. In the **Post installation** section, add the below **Setup URL**. - ```bash - https:///silo/api/github/auth/callback - ``` + ```bash + https:///silo/api/github/auth/callback + ``` - Redirects users to this URL after GitHub app installation. + Redirects users to this URL after GitHub app installation. - ![Add setup URL](/images/integrations/github/add-setup-url.webp#hero) + ![Add setup URL](/images/integrations/github/add-setup-url.webp#hero) -6. Turn on **Redirect on update**. + 6. Turn on **Redirect on update**. -7. In the **Webhook** section, add the below **Webhook URL**. + 7. In the **Webhook** section, add the below **Webhook URL**. - ```bash - https:///silo/api/github/github-webhook - ``` + ```bash + https:///silo/api/github/github-webhook + ``` - This allows Plane to receive updates from GitHub repositories. + This allows Plane to receive updates from GitHub repositories. - ![Add Webhook URL](/images/integrations/github/add-webhook-url.webp#hero) + ![Add Webhook URL](/images/integrations/github/add-webhook-url.webp#hero) == GitHub Enterprise Server {#github-enterprise-server} -These steps cover hostname, callback URLs, and private key differences for on‑prem GitHub deployments. + These steps cover hostname, callback URLs, and private key differences for on‑prem GitHub deployments. -#### GitHub Enterprise Server + #### GitHub Enterprise Server -1. Go to **Settings \> Developer Settings \> GitHub Apps** in your GitHub organization. + 1. Go to **Settings \> Developer Settings \> GitHub Apps** in your GitHub organization. -2. Click **New GitHub App**. + 2. Click **New GitHub App**. - ![Create GitHub App](/images/integrations/github/create-github-app.webp#hero) + ![Create GitHub App](/images/integrations/github/create-github-app.webp#hero) -3. In the **Register new GitHub App** page, provide a **GitHub App name** and **Homepage URL**. + 3. In the **Register new GitHub App** page, provide a **GitHub App name** and **Homepage URL**. - ![App name and homepage URL](/images/integrations/github/app-name-homepage-url.webp#hero) + ![App name and homepage URL](/images/integrations/github/app-name-homepage-url.webp#hero) -4. In the **Identifying and authorizing users** section, add the following **Callback URLS**. + 4. In the **Identifying and authorizing users** section, add the following **Callback URLS**. - **For Plane cloud instance** + **For Plane cloud instance** - ```bash - https://silo.plane.so/api/oauth/github-enterprise/auth/callback - https://silo.plane.so/api/oauth/github-enterprise/auth/user/callback - ``` + ```bash + https://silo.plane.so/api/oauth/github-enterprise/auth/callback + https://silo.plane.so/api/oauth/github-enterprise/auth/user/callback + ``` - **For Plane self-hosted instance** + **For Plane self-hosted instance** - ```bash - https:///silo/api/oauth/github-enterprise/auth/callback - https:///silo/api/oauth/github-enterprise/auth/user/callback - ``` + ```bash + https:///silo/api/oauth/github-enterprise/auth/callback + https:///silo/api/oauth/github-enterprise/auth/user/callback + ``` - These URLs allow Plane to verify and enable workspace connection with the Github App. - ![Add Callback URL](/images/integrations/github/add-callback-url.webp#hero) + These URLs allow Plane to verify and enable workspace connection with the Github App. + ![Add Callback URL](/images/integrations/github/add-callback-url.webp#hero) :::warning Make sure to opt out of **Expire user authorization tokens** feature. ::: -5. In the **Post installation** section, add the below **Setup URL**. + 5. In the **Post installation** section, add the below **Setup URL**. - **For Plane cloud instance** + **For Plane cloud instance** - ```bash - https://silo.plane.so/api/oauth/github-enterprise/auth/callback - ``` + ```bash + https://silo.plane.so/api/oauth/github-enterprise/auth/callback + ``` - **For Plane self-hosted instance** + **For Plane self-hosted instance** - ```bash - https:///silo/api/oauth/github-enterprise/auth/callback - ``` + ```bash + https:///silo/api/oauth/github-enterprise/auth/callback + ``` - Redirects users to this URL after GitHub app installation. - ![Add setup URL](/images/integrations/github/add-setup-url.webp#hero) + Redirects users to this URL after GitHub app installation. + ![Add setup URL](/images/integrations/github/add-setup-url.webp#hero) -6. Turn on **Redirect on update**. + 6. Turn on **Redirect on update**. -7. In the **Webhook** section, add the below **Webhook URL**. + 7. In the **Webhook** section, add the below **Webhook URL**. - **For Plane cloud instance** + **For Plane cloud instance** - ```bash - https://silo.plane.so/api/github-enterprise/github-webhook - ``` + ```bash + https://silo.plane.so/api/github-enterprise/github-webhook + ``` - **For Plane self-hosted instance** + **For Plane self-hosted instance** - ```bash - https:///silo/api/github-enterprise/github-webhook - ``` + ```bash + https:///silo/api/github-enterprise/github-webhook + ``` - This allows Plane to receive updates from GitHub repositories. + This allows Plane to receive updates from GitHub repositories. - ![Add Webhook URL](/images/integrations/github/add-webhook-url.webp#hero) + ![Add Webhook URL](/images/integrations/github/add-webhook-url.webp#hero) ::: From 163e5f55446ec3bf3ed2aec4762e6a551e2ab9a4 Mon Sep 17 00:00:00 2001 From: sriramveeraghanta Date: Mon, 13 Apr 2026 19:52:15 +0530 Subject: [PATCH 3/3] fix: formatting --- .../govern/integrations/github.md | 152 +++++++++--------- 1 file changed, 76 insertions(+), 76 deletions(-) diff --git a/docs/self-hosting/govern/integrations/github.md b/docs/self-hosting/govern/integrations/github.md index f38fa77..5a80b8d 100644 --- a/docs/self-hosting/govern/integrations/github.md +++ b/docs/self-hosting/govern/integrations/github.md @@ -36,130 +36,130 @@ To configure GitHub integration, you'll need to create a GitHub App within your == GitHub Cloud {#github-cloud} - Follow these steps to create a GitHub App, set callback URLs, and configure webhooks so Plane can sync PRs and commits from GitHub Cloud. +Follow these steps to create a GitHub App, set callback URLs, and configure webhooks so Plane can sync PRs and commits from GitHub Cloud. - #### GitHub Cloud +#### GitHub Cloud - 1. Go to **Settings \> Developer Settings \> GitHub Apps** in your GitHub organization. +1. Go to **Settings \> Developer Settings \> GitHub Apps** in your GitHub organization. - 2. Click **New GitHub App**. +2. Click **New GitHub App**. - ![Create GitHub App](/images/integrations/github/create-github-app.webp#hero) + ![Create GitHub App](/images/integrations/github/create-github-app.webp#hero) - 3. In the **Register new GitHub App** page, provide a **GitHub App name** and **Homepage URL**. +3. In the **Register new GitHub App** page, provide a **GitHub App name** and **Homepage URL**. - ![App name and homepage URL](/images/integrations/github/app-name-homepage-url.webp#hero) + ![App name and homepage URL](/images/integrations/github/app-name-homepage-url.webp#hero) - 4. In the **Identifying and authorizing users** section, add the following **Callback URLS**. +4. In the **Identifying and authorizing users** section, add the following **Callback URLS**. - ```bash - https:///silo/api/github/auth/callback - https:///silo/api/github/auth/user/callback - ``` + ```bash + https:///silo/api/github/auth/callback + https:///silo/api/github/auth/user/callback + ``` - These URLs allow Plane to verify and enable workspace connection with the Github App. + These URLs allow Plane to verify and enable workspace connection with the Github App. - ![Add Callback URL](/images/integrations/github/add-callback-url.webp#hero) + ![Add Callback URL](/images/integrations/github/add-callback-url.webp#hero) - :::warning - Make sure to opt out of **Expire user authorization tokens** feature. - ::: + :::warning + Make sure to opt out of **Expire user authorization tokens** feature. + ::: - 5. In the **Post installation** section, add the below **Setup URL**. +5. In the **Post installation** section, add the below **Setup URL**. - ```bash - https:///silo/api/github/auth/callback - ``` + ```bash + https:///silo/api/github/auth/callback + ``` - Redirects users to this URL after GitHub app installation. + Redirects users to this URL after GitHub app installation. - ![Add setup URL](/images/integrations/github/add-setup-url.webp#hero) + ![Add setup URL](/images/integrations/github/add-setup-url.webp#hero) - 6. Turn on **Redirect on update**. +6. Turn on **Redirect on update**. - 7. In the **Webhook** section, add the below **Webhook URL**. +7. In the **Webhook** section, add the below **Webhook URL**. - ```bash - https:///silo/api/github/github-webhook - ``` + ```bash + https:///silo/api/github/github-webhook + ``` - This allows Plane to receive updates from GitHub repositories. + This allows Plane to receive updates from GitHub repositories. - ![Add Webhook URL](/images/integrations/github/add-webhook-url.webp#hero) + ![Add Webhook URL](/images/integrations/github/add-webhook-url.webp#hero) == GitHub Enterprise Server {#github-enterprise-server} - These steps cover hostname, callback URLs, and private key differences for on‑prem GitHub deployments. +These steps cover hostname, callback URLs, and private key differences for on‑prem GitHub deployments. - #### GitHub Enterprise Server +#### GitHub Enterprise Server - 1. Go to **Settings \> Developer Settings \> GitHub Apps** in your GitHub organization. +1. Go to **Settings \> Developer Settings \> GitHub Apps** in your GitHub organization. - 2. Click **New GitHub App**. +2. Click **New GitHub App**. - ![Create GitHub App](/images/integrations/github/create-github-app.webp#hero) + ![Create GitHub App](/images/integrations/github/create-github-app.webp#hero) - 3. In the **Register new GitHub App** page, provide a **GitHub App name** and **Homepage URL**. +3. In the **Register new GitHub App** page, provide a **GitHub App name** and **Homepage URL**. - ![App name and homepage URL](/images/integrations/github/app-name-homepage-url.webp#hero) + ![App name and homepage URL](/images/integrations/github/app-name-homepage-url.webp#hero) - 4. In the **Identifying and authorizing users** section, add the following **Callback URLS**. +4. In the **Identifying and authorizing users** section, add the following **Callback URLS**. - **For Plane cloud instance** + **For Plane cloud instance** - ```bash - https://silo.plane.so/api/oauth/github-enterprise/auth/callback - https://silo.plane.so/api/oauth/github-enterprise/auth/user/callback - ``` + ```bash + https://silo.plane.so/api/oauth/github-enterprise/auth/callback + https://silo.plane.so/api/oauth/github-enterprise/auth/user/callback + ``` - **For Plane self-hosted instance** + **For Plane self-hosted instance** - ```bash - https:///silo/api/oauth/github-enterprise/auth/callback - https:///silo/api/oauth/github-enterprise/auth/user/callback - ``` + ```bash + https:///silo/api/oauth/github-enterprise/auth/callback + https:///silo/api/oauth/github-enterprise/auth/user/callback + ``` - These URLs allow Plane to verify and enable workspace connection with the Github App. - ![Add Callback URL](/images/integrations/github/add-callback-url.webp#hero) - :::warning - Make sure to opt out of **Expire user authorization tokens** feature. - ::: + These URLs allow Plane to verify and enable workspace connection with the Github App. + ![Add Callback URL](/images/integrations/github/add-callback-url.webp#hero) + :::warning + Make sure to opt out of **Expire user authorization tokens** feature. + ::: - 5. In the **Post installation** section, add the below **Setup URL**. +5. In the **Post installation** section, add the below **Setup URL**. - **For Plane cloud instance** + **For Plane cloud instance** - ```bash - https://silo.plane.so/api/oauth/github-enterprise/auth/callback - ``` + ```bash + https://silo.plane.so/api/oauth/github-enterprise/auth/callback + ``` - **For Plane self-hosted instance** + **For Plane self-hosted instance** - ```bash - https:///silo/api/oauth/github-enterprise/auth/callback - ``` + ```bash + https:///silo/api/oauth/github-enterprise/auth/callback + ``` - Redirects users to this URL after GitHub app installation. - ![Add setup URL](/images/integrations/github/add-setup-url.webp#hero) + Redirects users to this URL after GitHub app installation. + ![Add setup URL](/images/integrations/github/add-setup-url.webp#hero) - 6. Turn on **Redirect on update**. +6. Turn on **Redirect on update**. - 7. In the **Webhook** section, add the below **Webhook URL**. +7. In the **Webhook** section, add the below **Webhook URL**. - **For Plane cloud instance** + **For Plane cloud instance** - ```bash - https://silo.plane.so/api/github-enterprise/github-webhook - ``` + ```bash + https://silo.plane.so/api/github-enterprise/github-webhook + ``` - **For Plane self-hosted instance** + **For Plane self-hosted instance** - ```bash - https:///silo/api/github-enterprise/github-webhook - ``` + ```bash + https:///silo/api/github-enterprise/github-webhook + ``` - This allows Plane to receive updates from GitHub repositories. + This allows Plane to receive updates from GitHub repositories. - ![Add Webhook URL](/images/integrations/github/add-webhook-url.webp#hero) + ![Add Webhook URL](/images/integrations/github/add-webhook-url.webp#hero) :::