Move deploy keys from deployments to keys in rest pages (github#26166)

* move deploy keys from deployments to keys in rest pages

* move minitocs above intro

* Update content/rest/reference/keys.md

Co-authored-by: Sarah Edwards <[email protected]>

* add to banner, add redirects from deployments

* remove deploy keys from deployments intro

* update data/reusables name

* update - to _

* update script and add redirects for subcategories turned categories

Co-authored-by: Sarah Edwards <[email protected]>

Author: gracepark

components/page-header/RestBanner.tsx

@@ -7,6 +7,7 @@ const restRepoDisplayPages = [
   'branches',
   'collaborators',
   'commits',
+  'deploy_keys',
   'deployments',
   'pages',
   'releases',
@@ -19,6 +20,7 @@ const restRepoCategoryExceptionsTitles = {
   branches: 'Branches',
   collaborators: 'Collaborators',
   commits: 'Commits',
+  deploy_keys: 'Deploy Keys',
   deployments: 'Deployments',
   pages: 'GitHub Pages',
   releases: 'Releases',

components/rest/RestReferencePage.tsx

@@ -68,7 +68,8 @@ export const RestReferencePage = ({
     if (
       hash &&
       (pathname.endsWith('/rest/reference/repos') ||
-        pathname.endsWith('/rest/reference/enterprise-admin'))
+        pathname.endsWith('/rest/reference/enterprise-admin') ||
+        pathname.endsWith('/rest/reference/deployments'))
     ) {
       setLoadClientsideRedirectExceptions(true)
     }
@@ -160,9 +161,6 @@ export const RestReferencePage = ({
             {page.introPlainText}
           </Lead>
         )}
-        <div key={`restCategory-introContent`}>
-          <div dangerouslySetInnerHTML={{ __html: introContent }} />
-        </div>
         <div className="my-3 d-flex">
           <div className="pr-3 mt-1">
             <Circle className="color-fg-on-emphasis color-bg-emphasis">
@@ -185,6 +183,9 @@ export const RestReferencePage = ({
             )}
           </div>
         </div>
+        <div key={`restCategory-introContent`}>
+          <div dangerouslySetInnerHTML={{ __html: introContent }} />
+        </div>
         <MarkdownContent>
           {subcategories.map((subcategory, index) => (
             <div key={`restCategory-${index}`}>

content/rest/reference/deploy_keys.md

@@ -0,0 +1,17 @@
+---
+title: Deploy Keys
+intro: 'The Deploy Keys API allows to create an SSH key that is stored on your server and grants access to a GitHub repository.'
+allowTitleToDifferFromFilename: true
+versions:
+  fpt: '*'
+  ghes: '*'
+  ghae: '*'
+  ghec: '*'
+topics:
+  - API
+miniTocMaxHeadingLevel: 3
+---
+
+<!--
+  Operations are automatically generated below. Markdown for subcategories is located in data/reusables/rest-reference/keys
+-->

content/rest/reference/deployments.md

@@ -1,6 +1,6 @@
 ---
 title: Deployments
-intro: 'The deployments API allows you to create and delete deploy keys, deployments, and deployment environments.'
+intro: 'The deployments API allows you to create and delete deployments and deployment environments.'
 allowTitleToDifferFromFilename: true
 versions:
   fpt: '*'

content/rest/reference/index.md

@@ -22,6 +22,7 @@ children:
   - /collaborators
   - /commits
   - /dependabot
+  - /deploy_keys
   - /deployments
   - /emojis
   - /enterprise-admin

data/reusables/rest-reference/deployments/keys.md renamed to data/reusables/rest-reference/deploy_keys/deploy_keys.md

@@ -1,5 +1,3 @@
-## Deploy keys
-
 {% data reusables.repositories.deploy-keys %}
 
 Deploy keys can either be setup using the following API endpoints, or by using GitHub. To learn how to set deploy keys up in GitHub, see "[Managing deploy keys](/developers/overview/managing-deploy-keys)."

lib/redirects/static/client-side-rest-api-redirects.json

@@ -25,10 +25,16 @@
   "/rest/reference/repos#list-repository-invitations": "/rest/reference/collaborators#list-repository-invitations",
   "/rest/reference/repos#update-a-repository-invitation": "/rest/reference/collaborators#update-a-repository-invitation",
   "/rest/reference/repos#delete-a-repository-invitation": "/rest/reference/collaborators#delete-a-repository-invitation",
-  "/rest/reference/repos#list-deploy-keys": "/rest/reference/deployments#list-deploy-keys",
-  "/rest/reference/repos#create-a-deploy-key": "/rest/reference/deployments#create-a-deploy-key",
-  "/rest/reference/repos#get-a-deploy-key": "/rest/reference/deployments#get-a-deploy-key",
-  "/rest/reference/repos#delete-a-deploy-key": "/rest/reference/deployments#delete-a-deploy-key",
+  "/rest/reference/repos#list-deploy-keys": "/rest/reference/deploy_keys#list-deploy-keys",
+  "/rest/reference/repos#create-a-deploy-key": "/rest/reference/deploy_keys#create-a-deploy-key",
+  "/rest/reference/repos#get-a-deploy-key": "/rest/reference/deploy_keys#get-a-deploy-key",
+  "/rest/reference/repos#delete-a-deploy-key": "/rest/reference/deploy_keys#delete-a-deploy-key",
+  "/rest/reference/repos#deploy-keys": "/rest/reference/deploy_keys",
+  "/rest/reference/deployments#list-deploy-keys": "/rest/reference/deploy_keys#list-deploy-keys",
+  "/rest/reference/deployments#create-a-deploy-key": "/rest/reference/deploy_keys#create-a-deploy-key",
+  "/rest/reference/deployments#get-a-deploy-key": "/rest/reference/deploy_keys#get-a-deploy-key",
+  "/rest/reference/deployments#delete-a-deploy-key": "/rest/reference/deploy_keys#delete-a-deploy-key",
+  "/rest/reference/deployments#deploy-keys": "/rest/reference/deploy_keys",
   "/rest/reference/repos#get-a-github-pages-site": "/rest/reference/pages#get-a-github-pages-site",
   "/rest/reference/repos#create-a-github-pages-site": "/rest/reference/pages#create-a-github-pages-site",
   "/rest/reference/repos#update-information-about-a-github-pages-site": "/rest/reference/pages#update-information-about-a-github-pages-site",