Skip to content

Commit

Permalink
docs: reorganize installation documentation structure
Browse files Browse the repository at this point in the history
  • Loading branch information
mrT23 committed Jan 23, 2025
1 parent 1cb21c6 commit ee8cdcf
Show file tree
Hide file tree
Showing 6 changed files with 58 additions and 17 deletions.
2 changes: 1 addition & 1 deletion docs/docs/installation/azure.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 /<command> <args> comment on the relevant PR. Note that for the "Pull request commented on" trigger, only API v2.0 is supported.
Expand Down
4 changes: 0 additions & 4 deletions docs/docs/installation/bitbucket.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
12 changes: 6 additions & 6 deletions docs/docs/installation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,18 @@
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"}]
2. A Git personal access token, with the repo scope (GitHub token can be issued from for example [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.
See [here](https://qodo-merge-docs.qodo.ai/installation/qodo_merge/) for more details.
49 changes: 49 additions & 0 deletions docs/docs/installation/pr_agent.md
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/)
File renamed without changes.
8 changes: 2 additions & 6 deletions docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down

0 comments on commit ee8cdcf

Please sign in to comment.