From 8ccb998b82ee3f902e7a82b965b93fc30d5c254d Mon Sep 17 00:00:00 2001 From: mrT23 Date: Sun, 17 Mar 2024 13:11:08 +0200 Subject: [PATCH] Refactor PR-Agent Pro installation documentation and update navigation links --- docs/docs/installation/index.md | 9 +++++--- .../{gitlab_pro.md => pr_agent_pro.md} | 23 ++++++++++++++++++- docs/mkdocs.yml | 2 +- 3 files changed, 29 insertions(+), 5 deletions(-) rename docs/docs/installation/{gitlab_pro.md => pr_agent_pro.md} (51%) diff --git a/docs/docs/installation/index.md b/docs/docs/installation/index.md index 18b7b056..fc71ecbb 100644 --- a/docs/docs/installation/index.md +++ b/docs/docs/installation/index.md @@ -1,5 +1,6 @@ # Installation +## self-hosted PR-Agent If you choose to host you own PR-Agent, you first need to acquire two tokens: 1. An OpenAI key from [here](https://platform.openai.com/api-keys), with access to GPT-4 (or a key for [other models](../usage-guide/additional_configurations.md/#changing-a-model), if you prefer). @@ -13,7 +14,9 @@ There are several ways to use self-hosted PR-Agent: - [BitBucket](./bitbucket.md) - [Azure DevOps](./azure.md) -___ -Note that [PR-Agent Pro 💎](https://app.codium.ai/), an app for GitHub\GitLab\BitBucket hosted by CodiumAI, is also available. +## PR-Agent Pro 💎 +PR-Agent Pro, an app for GitHub\GitLab\BitBucket hosted by CodiumAI, is also available.
-With PR-Agent Pro Installation is as simple as signing up and adding the PR-Agent app to your relevant repo. \ No newline at end of file +With PR-Agent Pro Installation is as simple as signing up and adding the PR-Agent app to your relevant repo. +
+See [here](./pr_agent_pro.md) for more details. \ No newline at end of file diff --git a/docs/docs/installation/gitlab_pro.md b/docs/docs/installation/pr_agent_pro.md similarity index 51% rename from docs/docs/installation/gitlab_pro.md rename to docs/docs/installation/pr_agent_pro.md index 20902b74..d7877fb5 100644 --- a/docs/docs/installation/gitlab_pro.md +++ b/docs/docs/installation/pr_agent_pro.md @@ -1,4 +1,25 @@ -## Install Hosted PR-Agent Pro for GitLab (Teams & Enterprise) + +PR-Agent Pro is a versatile application compatible with GitHub, GitLab, and BitBucket, hosted by CodiumAI. +See [here](./https://pr-agent-docs.codium.ai/#pr-agent-pro) for more details about the benefits of using PR-Agent Pro. + +Interested parties can subscribe to PR-Agent Pro through the following [link](https://www.codium.ai/pricing/). +After subscribing, you are granted the ability to install the application across any of your repositories. + + + + + +Each user who wants to use PR-Agent pro needs to buy a seat. +Initially, CodiumAI offers a two-week trial period at no cost, after which continued access requires each user to secure a personal seat. +Once a user acquires a seat, they gain the flexibility to use PR-Agent Pro across any repository where it has been enabled. + +Users without a purchased seat who interact with a repository featuring PR-Agent Pro are entitled to receive up to five complimentary feedbacks. +Beyond this limit, PR-Agent Pro will cease to respond to their inquiries unless a seat is purchased. + + +## Install PR-Agent Pro for GitLab (Teams & Enterprise) + +Since GitLab platform does not support apps, installing PR-Agent Pro for GitLab is a bit more involved, and requires the following steps: ### Step 1 diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 8da53d48..c3e10abd 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -7,9 +7,9 @@ nav: - Locally: 'installation/locally.md' - GitHub: 'installation/github.md' - GitLab: 'installation/gitlab.md' - - 💎 GitLab Pro: 'installation/gitlab_pro.md' - BitBucket: 'installation/bitbucket.md' - Azure DevOps: 'installation/azure.md' + - 💎 PR-Agent Pro: 'installation/pr_agent_pro.md' - Usage Guide: - 'usage-guide/index.md' - Introduction: 'usage-guide/introduction.md'