From 1d4da0fc0d0d072516acb59503c57b8034c371b9 Mon Sep 17 00:00:00 2001 From: Hasit Mistry Date: Mon, 29 Jul 2024 16:33:40 -0700 Subject: [PATCH 1/3] Add supported git platforms page in documentation --- docs/faq.md | 2 +- docs/guides/_category_.yml | 2 +- docs/integrations/_category_.yml | 2 +- docs/platforms/_category_.yaml | 4 ++ docs/platforms/platforms.md | 38 +++++++++++++++++++ .../saas-gitlab.md | 0 .../self-hosted-github.md | 0 .../self-hosted-gitlab.md | 0 8 files changed, 45 insertions(+), 3 deletions(-) create mode 100644 docs/platforms/_category_.yaml create mode 100644 docs/platforms/platforms.md rename docs/{integrations => platforms}/saas-gitlab.md (100%) rename docs/{integrations => platforms}/self-hosted-github.md (100%) rename docs/{integrations => platforms}/self-hosted-gitlab.md (100%) diff --git a/docs/faq.md b/docs/faq.md index c77ab4ec..61c1bd24 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -2,7 +2,7 @@ title: FAQs sidebar_label: FAQs description: Frequently asked questions about CodeRabbit. -sidebar_position: 7 +sidebar_position: 8 --- ### General diff --git a/docs/guides/_category_.yml b/docs/guides/_category_.yml index 05797a2e..674b49ba 100644 --- a/docs/guides/_category_.yml +++ b/docs/guides/_category_.yml @@ -1,4 +1,4 @@ label: Guides -position: 5 +position: 6 collapsible: true collapsed: true diff --git a/docs/integrations/_category_.yml b/docs/integrations/_category_.yml index af2fcbe0..1b85855e 100644 --- a/docs/integrations/_category_.yml +++ b/docs/integrations/_category_.yml @@ -1,4 +1,4 @@ label: Integrations -position: 6 +position: 7 collapsible: true collapsed: true diff --git a/docs/platforms/_category_.yaml b/docs/platforms/_category_.yaml new file mode 100644 index 00000000..32fe7bb9 --- /dev/null +++ b/docs/platforms/_category_.yaml @@ -0,0 +1,4 @@ +label: Supported Git Platforms +position: 5 +collapsible: true +collapsed: true diff --git a/docs/platforms/platforms.md b/docs/platforms/platforms.md new file mode 100644 index 00000000..cdff1a27 --- /dev/null +++ b/docs/platforms/platforms.md @@ -0,0 +1,38 @@ +--- +title: Supported Git Platforms +sidebar_label: Supported Git Platforms +description: Overview of CodeRabbit's supported Git platforms. +sidebar_position: 1 +--- + +CodeRabbit supports various Git platforms to provide code review for your repositories. For the cloud-hosted Git platforms, you can [login][login] to CodeRabbit and adding your repositories. The following platforms are supported: + +## GitHub + +| Host | Support | +|--------------------------|------------------------------------| +| GitHub.com | [Supported][login] | +| GitHub Enterprise Server | [Supported](self-hosted-github.md) | + +## GitLab + +| Host | Support | +|---------------------|------------------------------------| +| GitLab.com | [Supported](saas-gitlab.md) | +| GitLab Self Managed | [Supported](self-hosted-gitlab.md) | + +## Azure DevOps + +| Host | Support | +|---------------------|-------------| +| Azure DevOps Cloud | Coming soon | +| Azure DevOps Server | Coming soon | + +## Bitbucket + +| Host | Support | +|-----------------------|-------------| +| Cloud | Coming soon | +| Bitbucket Data Center | Coming soon | + +[login]: https://app.coderabbit.ai/login diff --git a/docs/integrations/saas-gitlab.md b/docs/platforms/saas-gitlab.md similarity index 100% rename from docs/integrations/saas-gitlab.md rename to docs/platforms/saas-gitlab.md diff --git a/docs/integrations/self-hosted-github.md b/docs/platforms/self-hosted-github.md similarity index 100% rename from docs/integrations/self-hosted-github.md rename to docs/platforms/self-hosted-github.md diff --git a/docs/integrations/self-hosted-gitlab.md b/docs/platforms/self-hosted-gitlab.md similarity index 100% rename from docs/integrations/self-hosted-gitlab.md rename to docs/platforms/self-hosted-gitlab.md From 92f8014e9ec475e067ca52298623360edd0b0156 Mon Sep 17 00:00:00 2001 From: Hasit Mistry Date: Mon, 29 Jul 2024 16:38:44 -0700 Subject: [PATCH 2/3] Fix typo in platforms.md --- docs/platforms/platforms.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/platforms/platforms.md b/docs/platforms/platforms.md index cdff1a27..9caf84b8 100644 --- a/docs/platforms/platforms.md +++ b/docs/platforms/platforms.md @@ -5,7 +5,7 @@ description: Overview of CodeRabbit's supported Git platforms. sidebar_position: 1 --- -CodeRabbit supports various Git platforms to provide code review for your repositories. For the cloud-hosted Git platforms, you can [login][login] to CodeRabbit and adding your repositories. The following platforms are supported: +CodeRabbit supports various Git platforms to provide code review for your repositories. For the cloud-hosted Git platforms, you can [login][login] to CodeRabbit and add your repositories. The following platforms are supported: ## GitHub From 968c53a8423b46f274aa978131994818377700c2 Mon Sep 17 00:00:00 2001 From: Hasit Mistry Date: Mon, 29 Jul 2024 16:50:24 -0700 Subject: [PATCH 3/3] chore: Update redirect paths in docusaurus.config.ts --- docusaurus.config.ts | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docusaurus.config.ts b/docusaurus.config.ts index 116d8ff9..f8e84038 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -72,6 +72,18 @@ const config: Config = { from: "/guides/configure-coderabbit", to: "/configure-coderabbit", }, + { + from: "/integrations/saas-gitlab", + to: "/platforms/saas-gitlab", + }, + { + from: "/integrations/self-hosted-gitlab", + to: "/platforms/self-hosted-gitlab", + }, + { + from: "/integrations/self-hosted-github", + to: "/platforms/self-hosted-github", + }, ], }, ],