Propose updates to templates to support landing/guide pages and updated navigation (github#20273)

* Propose updates to templates

* Replace link to docs-internal

Co-authored-by: Emily Gould <[email protected]>

Author: felicitymay

content/README.md

@@ -108,7 +108,7 @@ See [`contributing/redirects`](contributing/redirects.md) for more info.
 
 ### `shortTitle`
 
-- Purpose: An abbreviated variant of the page title for use in breadcrumbs.
+- Purpose: An abbreviated variant of the page title for use in breadcrumbs and navigation elements.
 - Type: `String`
 - Optional. If omitted, `title` will be used.
 

contributing/content-model.md

@@ -36,7 +36,7 @@ Categories are usually organized around a feature or a discrete set of tasks wit
 - Task-based (begins with a gerund)
 - Describes the big-picture purpose or goal of using the feature or product
 - General or high-level enough to scale with future product enhancements
-- Category titles must be 67 characters or shorter
+- Category titles must be 67 characters or shorter and have a [`shortTitle`](https://github.com/github/docs/tree/main/content#shorttitle) less than 27 characters
 - Examples
   - [Setting up and managing your GitHub user account](https://docs.github.com/en/github/setting-up-and-managing-your-github-user-account)
   - [Installing GitHub Enterprise](https://docs.github.com/en/enterprise-server@3.0/admin/installation)
@@ -54,7 +54,7 @@ Map topics contain at least three articles. When map topics have more than eight
 - Task-based (begins with a gerund)
 - Describes a more specific task within the larger workflow of the category it’s in
 - General or high-level enough to scale with future additions to the product
-- Map topic titles must be 63 characters or shorter
+- Map topic titles must be 63 characters or shorter and have a [`shortTitle`](https://github.com/github/docs/tree/main/content#shorttitle) less than 30 characters
 - Examples
   - [Securing your account with two-factor authentication](https://docs.github.com/en/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa)
   - [Setting policies for organizations in your enterprise account](https://docs.github.com/en/github/setting-up-and-managing-your-enterprise/setting-policies-for-organizations-in-your-enterprise-account)
@@ -103,9 +103,9 @@ Titles are challenging! Use these general guidelines to help create clear, helpf
   - What specific words do we need to include in the title or intro so that folks don’t mistake it for content about a different product?
 - Think about how the title will look in production
 - Titles have hard limits for length to keep them easy to understand (and easier to render on the site): 
-  - Category titles: 67 characters
-  - Map topic titles: 63 characters
-  - Article titles: 80 characters, 60 if possible
+  - Category titles: 67 characters and [`shortTitle`](https://github.com/github/docs/tree/main/content#shorttitle) < 27 characters
+  - Map topic titles: 63 characters and [`shortTitle`](https://github.com/github/docs/tree/main/content#shorttitle) < 30 characters
+  - Article titles: 80 characters, 60 if possible, and [`shortTitle`](https://github.com/github/docs/tree/main/content#shorttitle) < 31 characters, ideally 20-25 characters
 
 ### Reusing content
 

contributing/content-templates.md

@@ -16,8 +16,12 @@ Use the [content model](/contributing/content-model.md#conceptual) for full inst
 ```
 ---
 title: About [subject]
+shortTitle: [subject] # Max 31 characters
 intro: 'Article intro. See tips for a great intro below.'
 product: '{{ optional product callout }}'
+type: overview
+topics: # One or more from list of allowed topics: https://github.com/github/docs/blob/main/data/allowed-topics.js
+  - [topic]
 versions:
 ---
 
@@ -51,8 +55,12 @@ Use the [content model](https://github.com/github/docs/blob/main/contributing/co
 ```
 ---
 title: Nouns describing your subject
+shortTitle: [subject] # Max 31 characters
 intro: 'Article intro. See tips for a great intro below.'
 product: '{{ optional product callout }}'
+type: reference
+topics: # One or more from list of allowed topics: https://github.com/github/docs/blob/main/data/allowed-topics.js
+  - [topic]
 versions:
 ---
 
@@ -86,8 +94,12 @@ Use the [content model](https://github.com/github/docs/blob/main/contributing/co
 ```
 ---
 title: Start with a gerund
+shortTitle: [subject] # Max 31 characters
 intro: 'Article intro. See tips for a great intro below.'
 product: '{{ optional product callout }}'
+type: how_to
+topics: # One or more from list of allowed topics: https://github.com/github/docs/blob/main/data/allowed-topics.js
+  - [topic]
 versions:
 ---
 
@@ -121,7 +133,11 @@ Use the [content model](https://github.com/github/docs/blob/main/contributing/co
 ```
 ---
 title: Quickstart title
+shortTitle: [subject] # Max 31 characters
 intro: 'Article intro. Highlight that the guide is quick and to the point.'
+type: quick_start
+topics: # One or more from list of allowed topics: https://github.com/github/docs/blob/main/data/allowed-topics.js
+  - [topic]
 versions:
 ---
 
@@ -170,8 +186,12 @@ Use the [content model](https://github.com/github/docs/blob/main/contributing/co
 ```
 ---
 title: Tutorial title
+shortTitle: [subject] # Max 31 characters
 intro: 'Article intro. See tips for a great intro below'
 product: '{{ optional product callout }}'
+type: tutorial
+topics: # One or more from list of allowed topics: https://github.com/github/docs/blob/main/data/allowed-topics.js
+  - [topic]
 versions:
 ---
 
@@ -233,8 +253,12 @@ Use the [tutorial content model](hhttps://github.com/github/docs/blob/main/contr
 ```
 ---
 title: Guide title
+shortTitle: [subject] # Max 31 characters
 intro: 'Article intro. See tips for a great intro below'
 product: '{{ site.data.reusables.gated-features.actions }}'
+type: tutorial
+topics: # One or more from list of allowed topics: https://github.com/github/docs/blob/main/data/allowed-topics.js
+  - [topic]
 versions:
 ---