Community redirect update to camel case and adding documentation (git…

…hub#21979) * update to camel case * add documentation on communityRedirect
jakeboone02 · Oct 7, 2021 · 4727433 · 4727433
1 parent b9a3683
commit 4727433
Show file tree

Hide file tree

Showing 9 changed files with 18 additions and 14 deletions.
diff --git a/components/context/MainContext.tsx b/components/context/MainContext.tsx
@@ -62,7 +62,7 @@ export type MainContextT = {
     article?: BreadcrumbT
   }
   activeProducts: Array<ProductT>
-  community_redirect: {
+  communityRedirect: {
     name: string
     href: string
   }
@@ -114,7 +114,7 @@ export const getMainContext = (req: any, res: any): MainContextT => {
   return {
     breadcrumbs: req.context.breadcrumbs || {},
     activeProducts: req.context.activeProducts,
-    community_redirect: req.context.page?.community_redirect || {},
+    communityRedirect: req.context.page?.communityRedirect || {},
     currentProduct: req.context.productMap[req.context.currentProduct] || null,
     currentLayoutName: req.context.currentLayoutName,
     isHomepageVersion: req.context.page?.documentType === 'homepage',

diff --git a/components/page-footer/Support.tsx b/components/page-footer/Support.tsx
@@ -7,21 +7,19 @@ import { useMainContext } from 'components/context/MainContext'
 export const Support = () => {
   const { isEnterprise } = useVersion()
   const { t } = useTranslation('support')
-  const { community_redirect } = useMainContext()
+  const { communityRedirect } = useMainContext()
 
   return (
     <div>
       <h2 className="mb-3 f4">{t`still_need_help`}</h2>
       <div className="mb-2">
         <a
           id="ask-community"
-          href={community_redirect.href || 'https://github.community/'}
+          href={communityRedirect.href || 'https://github.community/'}
           className="Link—secondary text-bold"
         >
           <PeopleIcon size="small" className="octicon mr-1" />
-          {Object.keys(community_redirect).length === 0
-            ? t`ask_community`
-            : community_redirect.name}
+          {Object.keys(communityRedirect).length === 0 ? t`ask_community` : communityRedirect.name}
         </a>
       </div>
       <div>

diff --git a/content/README.md b/content/README.md
@@ -28,6 +28,7 @@ See the [contributing docs](/CONTRIBUTING.md) for general information about work
   - [`type`](#type)
   - [`topics`](#topics)
   - [`contributor`](#contributor)
+  - [`communityRedirect`](#communityRedirect)
   - [Escaping single quotes](#escaping-single-quotes)
 - [Autogenerated mini TOCs](#autogenerated-mini-tocs)
 - [Versioning](#versioning)
@@ -264,6 +265,11 @@ includeGuides:
 - Type: `Object`. Properties are `name` and `URL`.
 - Optional.
 
+### `communityRedirect`
+- Purpose: Set a custom link and link name for `Ask the GitHub community` link in the footer.
+- Type: `Object`. Properties are `name` and `href`.
+- Optional.
+
 Example:
 
 ```yaml

diff --git a/content/codespaces/index.md b/content/codespaces/index.md
@@ -24,7 +24,7 @@ featuredLinks:
     - /codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account
   popularHeading: Set up your project
 product_video: 'https://www.youtube-nocookie.com/embed/_W9B7qc9lVc'
-community_redirect: 
+communityRedirect: 
   name: 'Provide GitHub Feedback'
   href: 'https://github.com/github/feedback/discussions/categories/codespaces-feedback'
 redirect_from:

diff --git a/content/discussions/index.md b/content/discussions/index.md
@@ -28,7 +28,7 @@ product_video: 'https://www.youtube-nocookie.com/embed/IpBw2SJkFyk'
 layout: product-landing
 versions:
   fpt: '*'
-community_redirect: 
+communityRedirect: 
   name: 'Provide GitHub Feedback'
   href: 'https://github.com/github/feedback/discussions/categories/discussions-feedback'
 children:

diff --git a/...ositories/releasing-projects-on-github/automatically-generated-release-notes.md b/...ositories/releasing-projects-on-github/automatically-generated-release-notes.md
@@ -7,7 +7,7 @@ versions:
 topics:
   - Repositories
 shortTitle: Automated release notes
-community_redirect:
+communityRedirect:
   name: 'Provide GitHub Feedback'
   href: 'https://github.com/github/feedback/discussions/categories/releases-feedback'
 ---

diff --git a/content/sponsors/index.md b/content/sponsors/index.md
@@ -28,7 +28,7 @@ featuredLinks:
 layout: product-landing
 versions:
   fpt: '*'
-community_redirect: 
+communityRedirect: 
   name: 'Provide GitHub Feedback'
   href: 'https://github.com/github/feedback/discussions/categories/sponsors-feedback'
 children:

diff --git a/lib/frontmatter.js b/lib/frontmatter.js
@@ -149,7 +149,7 @@ export const schema = {
     interactive: {
       type: 'boolean',
     },
-    community_redirect: {
+    communityRedirect: {
       type: 'object',
       properties: {
         name: 'string',

diff --git a/lib/page.js b/lib/page.js
@@ -195,14 +195,14 @@ class Page {
     context.relativePath = this.relativePath
     const html = await renderContent(this.markdown, context)
 
-    // Adding community_redirect for Discussions, Sponsors, and Codespaces - request from Product
+    // Adding communityRedirect for Discussions, Sponsors, and Codespaces - request from Product
     if (
       this.parentProduct &&
       (this.parentProduct.id === 'discussions' ||
         this.parentProduct.id === 'sponsors' ||
         this.parentProduct.id === 'codespaces')
     ) {
-      this.community_redirect = {
+      this.communityRedirect = {
         name: 'Provide GitHub Feedback',
         href: `https://github.com/github/feedback/discussions/categories/${this.parentProduct.id}-feedback`,
       }