diff --git a/docs/docs/installation/azure.md b/docs/docs/installation/azure.md index 4f38698a..a4ec632b 100644 --- a/docs/docs/installation/azure.md +++ b/docs/docs/installation/azure.md @@ -80,7 +80,7 @@ org = "https://dev.azure.com/YOUR_ORGANIZATION/" # pat = "YOUR_PAT_TOKEN" needed only if using PAT for authentication ``` -### Azure DevOps Webhook +## Azure DevOps Webhook To trigger from an Azure webhook, you need to manually [add a webhook](https://learn.microsoft.com/en-us/azure/devops/service-hooks/services/webhooks?view=azure-devops). Use the "Pull request created" type to trigger a review, or "Pull request commented on" to trigger any supported comment with / comment on the relevant PR. Note that for the "Pull request commented on" trigger, only API v2.0 is supported. diff --git a/docs/docs/installation/bitbucket.md b/docs/docs/installation/bitbucket.md index 58978473..39ce54f1 100644 --- a/docs/docs/installation/bitbucket.md +++ b/docs/docs/installation/bitbucket.md @@ -27,10 +27,6 @@ You can get a Bitbucket token for your repository by following Repository Settin Note that comments on a PR are not supported in Bitbucket Pipeline. -## Run using CodiumAI-hosted Bitbucket app 💎 - -Please contact visit [Qodo Merge](https://www.codium.ai/pricing/) if you're interested in a hosted BitBucket app solution that provides full functionality including PR reviews and comment handling. It's based on the [bitbucket_app.py](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/git_providers/bitbucket_provider.py) implementation. - ## Bitbucket Server and Data Center diff --git a/docs/docs/installation/index.md b/docs/docs/installation/index.md index b5956936..a697ebdf 100644 --- a/docs/docs/installation/index.md +++ b/docs/docs/installation/index.md @@ -1,21 +1,17 @@ # Installation ## Self-hosted PR-Agent -If you choose to host your own PR-Agent, you first need to acquire two tokens: - -1. An OpenAI key from [here](https://platform.openai.com/api-keys){:target="_blank"}, with access to GPT-4 (or a key for other [language models](https://qodo-merge-docs.qodo.ai/usage-guide/changing_a_model/), if you prefer). -2. A GitHub\GitLab\BitBucket personal access token (classic), with the repo scope. [GitHub from [here](https://github.com/settings/tokens){:target="_blank"}] There are several ways to use self-hosted PR-Agent: - [Locally](./locally.md) -- [GitHub](./github.md) -- [GitLab](./gitlab.md) -- [BitBucket](./bitbucket.md) -- [Azure DevOps](./azure.md) +- [GitHub integration](./github.md) +- [GitLab integration](./gitlab.md) +- [BitBucket integration](./bitbucket.md) +- [Azure DevOps integration](./azure.md) ## Qodo Merge 💎 Qodo Merge, an app hosted by QodoAI for GitHub\GitLab\BitBucket, is also available.
-With Qodo Merge, installation is as simple as signing up and adding the Qodo Merge app to your relevant repo. -See [here](https://qodo-merge-docs.qodo.ai/installation/pr_agent_pro/) for more details. +With Qodo Merge, installation is as simple as adding the Qodo Merge app to your relevant repo. +See [here](https://qodo-merge-docs.qodo.ai/installation/qodo_merge/) for more details. diff --git a/docs/docs/installation/locally.md b/docs/docs/installation/locally.md index 04c4e29b..cd60f076 100644 --- a/docs/docs/installation/locally.md +++ b/docs/docs/installation/locally.md @@ -1,3 +1,9 @@ +To run PR-Agent locally, you first need to acquire two keys: + +1. An OpenAI key from [here](https://platform.openai.com/api-keys){:target="_blank"}, with access to GPT-4 (or a key for other [language models](https://qodo-merge-docs.qodo.ai/usage-guide/changing_a_model/), if you prefer). +2. A personal access token from your Git platform (GitHub, GitLab, BitBucket) with repo scope. GitHub token, for example, can be issued from for example [here](https://github.com/settings/tokens){:target="_blank"} + + ## Using Docker image A list of the relevant tools can be found in the [tools guide](../tools/ask.md). diff --git a/docs/docs/installation/pr_agent.md b/docs/docs/installation/pr_agent.md new file mode 100644 index 00000000..cb6a4092 --- /dev/null +++ b/docs/docs/installation/pr_agent.md @@ -0,0 +1,49 @@ +# PR-Agent Installation Guide + +PR-Agent can be deployed in various environments and platforms. Choose the installation method that best suits your needs: + +## 🖥️ Local Installation + +Learn how to run PR-Agent locally using: + +- Docker image +- pip package +- CLI from source code + +[View Local Installation Guide →](https://qodo-merge-docs.qodo.ai/installation/locally/) + +## 🐙 GitHub Integration + +Set up PR-Agent with GitHub as: + +- GitHub Action +- Local GitHub App + +[View GitHub Integration Guide →](https://qodo-merge-docs.qodo.ai/installation/github/) + +## 🦊 GitLab Integration + +Deploy PR-Agent on GitLab as: + +- GitLab pipeline job +- Local GitLab webhook server + +[View GitLab Integration Guide →](https://qodo-merge-docs.qodo.ai/installation/gitlab/) + +## 🟦 BitBucket Integration + +Implement PR-Agent in BitBucket as: + +- BitBucket pipeline job +- Local BitBucket server + +[View BitBucket Integration Guide →](https://qodo-merge-docs.qodo.ai/installation/bitbucket/) + +## 🔷 Azure DevOps Integration + +Configure PR-Agent with Azure DevOps as: + +- Azure DevOps pipeline job +- Local Azure DevOps webhook + +[View Azure DevOps Integration Guide →](https://qodo-merge-docs.qodo.ai/installation/azure/) \ No newline at end of file diff --git a/docs/docs/installation/pr_agent_pro.md b/docs/docs/installation/qodo_merge.md similarity index 99% rename from docs/docs/installation/pr_agent_pro.md rename to docs/docs/installation/qodo_merge.md index 0e6a7f01..2d9b9bf6 100644 --- a/docs/docs/installation/pr_agent_pro.md +++ b/docs/docs/installation/qodo_merge.md @@ -31,7 +31,7 @@ Qodo Merge for Bitbucket Cloud is available for installation through the followi ### Bitbucket Server -To use Qodo Merge application on your private Bitbucket Server, you will need to contact us for starting an [Enterprise](https://www.codium.ai/pricing/) trial. +To use Qodo Merge application on your private Bitbucket Server, you will need to contact us for starting an [Enterprise](https://www.qodo.ai/pricing/) trial. ## Install Qodo Merge for GitLab (Teams & Enterprise) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 5d2d55d6..42ad14df 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -9,12 +9,8 @@ nav: - Data Privacy: 'overview/data_privacy.md' - Installation: - 'installation/index.md' - - Locally: 'installation/locally.md' - - GitHub: 'installation/github.md' - - GitLab: 'installation/gitlab.md' - - BitBucket: 'installation/bitbucket.md' - - Azure DevOps: 'installation/azure.md' - - 💎 Qodo Merge: 'installation/pr_agent_pro.md' + - PR-Agent: 'installation/pr_agent.md' + - 💎 Qodo Merge: 'installation/qodo_merge.md' - Usage Guide: - 'usage-guide/index.md' - Introduction: 'usage-guide/introduction.md'