docs: replace getting started by GH integration page (#6114)

Mergifyio · Mar 4, 2025 · add55ff · add55ff
1 parent f8f650b
commit add55ff
Show file tree

Hide file tree

Showing 17 changed files with 59 additions and 64 deletions.
diff --git a/public/_redirects b/public/_redirects
@@ -54,4 +54,5 @@
 /workflow/custom-branch-protections /merge-protections 301
 /workflow/schedule-merge /merge-protections 301
 /merge-queue/speculative-checks /merge-queue/parallel-checks 301
-/merge-queue/speculative-checks/ /merge-queue/parallel-checks 301
+/merge-queue/speculative-checks/ /merge-queue/parallel-checks 301
+/getting-started /integrations/github 301
diff --git a/src/content/docs/getting-started.mdx b/src/content/docs/getting-started.mdx
diff --git a/src/content/docs/index.mdx b/src/content/docs/index.mdx
@@ -15,7 +15,7 @@ import {BsPatchQuestion, BsRocket, BsPlugin, BsStack, BsRobot, BsCommand} from '
 import {BiSolidCoinStack, BiRuler} from 'react-icons/bi';
 import {TbPackages, TbGitBranch} from 'react-icons/tb';
 import { TiFlowParallel } from "react-icons/ti";
-import {FaUserShield, FaStairs, FaCirclePlay, FaRegLightbulb, FaGear, FaTrafficLight, FaSnowflake, FaMoneyBill1, FaRegCirclePause, FaBug} from 'react-icons/fa6';
+import {FaUserShield, FaStairs, FaRegLightbulb, FaGear, FaTrafficLight, FaSnowflake, FaMoneyBill1, FaRegCirclePause, FaBug} from 'react-icons/fa6';
 import {FaShieldAlt, FaRegListAlt} from 'react-icons/fa';
 import {AiOutlinePartition, AiOutlineDeploymentUnit, AiOutlineFile, AiOutlineApi} from 'react-icons/ai';
 import {LiaShareAltSolid} from 'react-icons/lia';
@@ -30,13 +30,6 @@ Explore our guides and examples on how to integrate Mergify.
 Define advanced rules to prevent your pull requests from being merged.
 
 <DocsetGrid>
-  <Docset
-    title="Getting Started"
-    path="/getting-started"
-    icon={FaCirclePlay}
-  >
-    Learn how to deploy Mergify on your repositories.
-  </Docset>
   <Docset
     title="Enabling Merge Protections"
     path="/merge-protections"
@@ -51,13 +44,6 @@ Define advanced rules to prevent your pull requests from being merged.
 Automate your GitHub pull requests workflow.
 
 <DocsetGrid>
-  <Docset
-    title="Getting Started"
-    path="/getting-started"
-    icon={FaCirclePlay}
-  >
-    Learn how to deploy Mergify on your repositories.
-  </Docset>
   <Docset
     title="Introducing Workflow Automation"
     path="/workflow"
@@ -127,13 +113,6 @@ and adapt it to your own needs.
 ## Merge Queue
 
 <DocsetGrid>
-  <Docset
-    title="Getting Started"
-    path="/getting-started"
-    icon={FaCirclePlay}
-  >
-    Learn how to deploy Mergify on your repositories.
-  </Docset>
   <Docset
     title="Introduction to Merge Queues"
     path="/merge-queue"

diff --git a/src/content/docs/integrations/buildkite.mdx b/src/content/docs/integrations/buildkite.mdx
@@ -30,7 +30,7 @@ Before you can use Mergify with Buildkite, ensure the following:
 2. Buildkite is [configured to report build statuses to
    GitHub](https://buildkite.com/docs/integrations/github#connecting-buildkite-and-github).
 
-3. The [Mergify GitHub App](/getting-started) is installed in your repository.
+3. The [Mergify GitHub App](/integrations/github) is installed in your repository.
 
 ## Using Buildkite Status Checks in Mergify Configuration
 

diff --git a/src/content/docs/integrations/circleci.mdx b/src/content/docs/integrations/circleci.mdx
@@ -27,7 +27,7 @@ Before you can use Mergify with CircleCI, ensure the following:
    done by installing [CircleCI's GitHub
    App](https://circleci.com/docs/github-apps-integration/).
 
-3. The [Mergify GitHub App](/getting-started) is installed in your repository.
+3. The [Mergify GitHub App](/integrations/github) is installed in your repository.
 
 ## Using CircleCI Status Checks in Mergify Configuration
 

diff --git a/src/content/docs/integrations/gha.mdx b/src/content/docs/integrations/gha.mdx
@@ -29,7 +29,7 @@ Before leveraging Mergify's features with GitHub Actions, ensure the following:
 2. GitHub Actions is already configured to report job statuses to your pull
    requests.
 
-3. The [Mergify GitHub App](/getting-started) is installed in your repository.
+3. The [Mergify GitHub App](/integrations/github) is installed in your repository.
 
 ## Using GitHub Actions Status Checks in Mergify Configuration
 

diff --git a/src/content/docs/integrations/github.mdx b/src/content/docs/integrations/github.mdx
@@ -0,0 +1,34 @@
+---
+title: Integrating GitHub with Mergify
+description: Managing Mergify GitHub installation.
+---
+
+import { Image } from "astro:assets"
+import githubLogo from "../../images/integrations/github/logo.svg"
+import IntegrationLogo from "../../../components/IntegrationLogo.astro"
+import githubIntegScreenshot from"../../images/integrations/github/integrations.png"
+
+<IntegrationLogo src={githubLogo} alt="GitHub logo"/>
+
+Mergify is fully integrated with GitHub and many functionalities requires
+Mergify to be installed on your repositories.
+
+## Configuring Enabled Products
+
+You can configure the products that are enabled on your GitHub repositories by
+clicking on `Integrations` and then on `GitHub / Configure`.
+
+<Image src={githubIntegScreenshot} alt="GitHub Integration"/>
+
+First, this screens allows you to define which products are enabled by default
+for new repositories where the Mergify GitHub App is installed.
+
+Then, you can add repositories by clicking on `Add Repository` and installing
+the Mergify GitHub App on them.
+
+:::note
+  Adding repository requires GitHub admin privileges.
+:::
+
+Finally, you can enable or disable any product for any repositories by checking
+the box and saving the result.
diff --git a/src/content/docs/integrations/gitlab.mdx b/src/content/docs/integrations/gitlab.mdx
@@ -33,7 +33,7 @@ ensure:
 2. GitLab CI is [configured to report pipeline statuses to
    GitHub](https://docs.gitlab.com/ee/ci/ci_cd_for_external_repos/github_integration.html).
 
-3. You have the [Mergify GitHub App](/getting-started) integrated into your
+3. You have the [Mergify GitHub App](/integrations/github) installed into your
    repository.
 
 ## Utilizing GitLab CI Status Checks with Mergify

diff --git a/src/content/docs/integrations/index.mdx b/src/content/docs/integrations/index.mdx
@@ -14,6 +14,7 @@ import {
   SiBuildkite,
   SiSlack,
   SiGitlab,
+SiGithub,
 } from 'react-icons/si';
 import {BsStack} from 'react-icons/bs';
 import { TbBike } from 'react-icons/tb';
@@ -70,6 +71,12 @@ import Monitoring from './_monitoring.mdx'
 ## Developers Tools
 
 <DocsetGrid>
+  <Docset
+    title="GitHub"
+    description="Use GitHub and Mergify together."
+    path="github"
+    icon={SiGithub}
+  />
   <Docset
     title="Slack"
     description="Learn how you can use Slack and Mergify together."

diff --git a/src/content/docs/integrations/jenkins.mdx b/src/content/docs/integrations/jenkins.mdx
@@ -28,7 +28,7 @@ Before you can use Mergify with Jenkins, ensure the following:
    plugin](https://plugins.jenkins.io/github/) or the [GitHub Branch Source
    Plugin](https://plugins.jenkins.io/github-branch-source/).
 
-3. The [Mergify GitHub App](/getting-started) is installed in your repository.
+3. The [Mergify GitHub App](/integrations/github) is installed in your repository.
 
 ## Using Jenkins Status Checks in Mergify Configuration
 

diff --git a/src/content/docs/integrations/teamcity.mdx b/src/content/docs/integrations/teamcity.mdx
@@ -20,8 +20,8 @@ Before you start, make sure that you have:
 
 - A GitHub account;
 
-- A repository for which you have admin permissions with [Mergify
-  installed](/getting-started);
+- A GitHub repository for which you have admin permissions with [Mergify
+  installed](/integrations/github);
 
 - A TeamCity account.
 

diff --git a/src/content/docs/workflow/automerge.mdx b/src/content/docs/workflow/automerge.mdx
@@ -19,7 +19,7 @@ fast-paced development workflow.
 Before setting up automatic merges, ensure you meet the following requirements:
 
 1. **Mergify Integration**: Your repository must be [configured with
-   Mergify](/getting-started).
+   Mergify](/integrations/github).
 
 2. **Mergify Configuration File**: Automatic merging is configured using a
    [configuration file](/configuration/file-format) in your repository. This

diff --git a/src/content/docs/workflow/index.mdx b/src/content/docs/workflow/index.mdx
@@ -75,8 +75,8 @@ Mergify never evaluates rules for pull request drafts it creates to
 
 ## Getting Started
 
-To begin with Mergify, you'll need to [setup Mergify on your
-repository](/getting-started). You can then [set up rules for your
+To begin with Mergify, you'll need to [setup Mergify on your GitHub
+repository](/integrations/github). You can then [set up rules for your
 repository](writing-your-first-rule).
 
 Each rule will contain conditions (e.g., pull request state, number of reviews)

diff --git a/src/content/images/getting-started/github-app-install-repos.png b/src/content/images/getting-started/github-app-install-repos.png
diff --git a/src/content/images/integrations/github/integrations.png b/src/content/images/integrations/github/integrations.png
diff --git a/src/content/images/integrations/github/logo.svg b/src/content/images/integrations/github/logo.svg
diff --git a/src/content/navItems.tsx b/src/content/navItems.tsx
@@ -21,7 +21,6 @@ import {
 import { FaShieldAlt, FaHome, FaRegListAlt } from 'react-icons/fa';
 import {
 	FaStairs,
-	FaCirclePlay,
 	FaRegLightbulb,
 	FaGear,
 	FaTrafficLight,
@@ -42,6 +41,7 @@ import {
 	SiSnyk,
 	SiDependabot,
 	SiTeamcity,
+	SiGithub,
 	SiGithubactions,
 	SiJenkins,
 	SiCircleci,
@@ -66,7 +66,6 @@ export type NavItem = {
 
 const navItems: NavItem[] = [
 	{ title: 'Home', path: '/', icon: FaHome },
-	{ title: 'Getting Started', path: '/getting-started', icon: FaCirclePlay },
 	{
 		title: 'Merge Protections',
 		path: '/merge-protections',
@@ -204,6 +203,7 @@ const navItems: NavItem[] = [
 		icon: BsPlugin,
 		path: '/integrations',
 		children: [
+			{ title: 'GitHub', path: '/integrations/github', icon: SiGithub },
 			{ title: 'GitHub Actions', path: '/integrations/gha', icon: SiGithubactions },
 			{ title: 'CircleCI', path: '/integrations/circleci', icon: SiCircleci },
 			{ title: 'Jenkins', path: '/integrations/jenkins', icon: SiJenkins },