-
Notifications
You must be signed in to change notification settings - Fork 655
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1475 from Codium-ai/tr/docs24
docs: reorganize installation documentation structure
- Loading branch information
Showing
7 changed files
with
65 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. | ||
<br> | ||
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters