repo sync

content/README.md

@@ -15,7 +15,7 @@ See the [contributing docs](/CONTRIBUTING.md) for general information about work
   - [`permissions`](#permissions)
   - [`product`](#product)
   - [`layout`](#layout)
-  - [`mapTopic`](#maptopic)
+  - [`children`](#children)
   - [`featuredLinks`](#featuredlinks)
   - [`showMiniToc`](#showminitoc)
   - [`miniTocMaxHeadingLevel`](#minitocmaxheadinglevel)
@@ -35,6 +35,7 @@ See the [contributing docs](/CONTRIBUTING.md) for general information about work
 - [Whitespace control](#whitespace-control)
 - [Links and image paths](#links-and-image-paths)
   - [Preventing transformations](#preventing-transformations)
+- [Index pages](#index-pages)
 - [Creating new sublanding pages](#creating-new-sublanding-pages)
 
 ## Frontmatter
@@ -143,11 +144,11 @@ shortTitle: Contributing to projects
 For a layout named `layouts/article.html`, the value would be `article`.
 - Optional. If omitted, `layouts/default.html` is used.
 
-### `mapTopic`
+### `children`
 
-- Purpose: Indicates whether a page is a map topic. See [Map Topic Pages](#map-topic-pages) for more info.
-- Type: `Boolean`. Default is `false`.
-- Optional.
+- Purpose: Lists the relative links that belong to the product/category/map topic. See [Index pages](#index-pages) for more info.
+- Type: `Array`. Default is `false`.
+- Required on `index.md` pages.
 
 ### `featuredLinks`
 
@@ -312,8 +313,6 @@ Just add a hyphen on either the left, right, or both sides to indicate that ther
 {%- if currentVersion == 'free-pro-team@latest' %}
 ```
 
-These characters are especially important in [index pages](#index-pages) comprised of list items.
-
 ## Links and image paths
 
 Local links must start with a product ID (like `/actions` or `/admin`), and image paths must start with `/assets`. The links to Markdown pages undergo some transformations on the server side to match the current page's language and version. The handling for these transformations lives in [`lib/render-content/plugins/rewrite-local-links`](lib/render-content/plugins/rewrite-local-links.js).
@@ -344,6 +343,11 @@ Sometimes you want to link to a Dotcom-only article in Enterprise content and yo
 
 Sometimes the canonical home of content moves outside the docs site. None of the links included in [`lib/redirects/external-sites.json`](/lib/redirects/external-sites.json) get rewritten. See  [`contributing/redirects.md`](/contributing/redirects.md) for more info about this type of redirect.
 
+### Index pages
+
+Index pages are the Table of Contents files for the docs site. Every product, category, and map topic subdirectory has an `index.md` that serves as the landing page. Each `index.md` must contain a `children` frontmatter property with a list of relative links to the child pages of the product, category, or map topic.
+
+**Important note**: The site only knows about paths included in `children` frontmatter. If a directory or article exists but is **not** included in `children`, its path will 404.
 
 ### Creating new sublanding pages
 

content/actions/creating-actions/index.md

@@ -11,17 +11,16 @@ versions:
   free-pro-team: '*'
   enterprise-server: '>=2.22'
   github-ae: '*'
+children:
+  - /about-actions
+  - /creating-a-docker-container-action
+  - /creating-a-javascript-action
+  - /creating-a-composite-run-steps-action
+  - /metadata-syntax-for-github-actions
+  - /dockerfile-support-for-github-actions
+  - /setting-exit-codes-for-actions
+  - /publishing-actions-in-github-marketplace
 ---
-
 {% data reusables.actions.enterprise-beta %}
 {% data reusables.actions.enterprise-github-hosted-runners %}
 {% data reusables.actions.ae-beta %}
-
-{% link_in_list /about-actions %}
-{% link_in_list /creating-a-docker-container-action %}
-{% link_in_list /creating-a-javascript-action %}
-{% link_in_list /creating-a-composite-run-steps-action %}
-{% link_in_list /metadata-syntax-for-github-actions %}
-{% link_in_list /dockerfile-support-for-github-actions %}
-{% link_in_list /setting-exit-codes-for-actions %}
-{% link_in_list /publishing-actions-in-github-marketplace %}

content/actions/guides/index.md

@@ -73,40 +73,41 @@ includeGuides:
   - /actions/guides/moving-assigned-issues-on-project-boards
   - /actions/guides/removing-a-label-when-a-card-is-added-to-a-project-board-column
   - /actions/guides/managing-github-actions-with-github-cli
-
+children:
+  - /about-continuous-integration
+  - /setting-up-continuous-integration-using-workflow-templates
+  - /building-and-testing-nodejs
+  - /building-and-testing-net
+  - /building-and-testing-powershell
+  - /building-and-testing-python
+  - /building-and-testing-ruby
+  - /building-and-testing-java-with-maven
+  - /building-and-testing-java-with-gradle
+  - /building-and-testing-java-with-ant
+  - /building-and-testing-swift
+  - /installing-an-apple-certificate-on-macos-runners-for-xcode-development
+  - /building-and-testing-xamarin-applications
+  - /about-packaging-with-github-actions
+  - /publishing-nodejs-packages
+  - /publishing-java-packages-with-maven
+  - /publishing-java-packages-with-gradle
+  - /publishing-docker-images
+  - /storing-workflow-data-as-artifacts
+  - /caching-dependencies-to-speed-up-workflows
+  - /about-service-containers
+  - /creating-redis-service-containers
+  - /creating-postgresql-service-containers
+  - /deploying-to-amazon-elastic-container-service
+  - /deploying-to-azure-app-service
+  - /deploying-to-google-kubernetes-engine
+  - /deploying-to-google-kubernetes-engine
+  - /using-github-actions-for-project-management
+  - /closing-inactive-issues
+  - /scheduling-issue-creation
+  - /adding-labels-to-issues
+  - /commenting-on-an-issue-when-a-label-is-added
+  - /moving-assigned-issues-on-project-boards
+  - /removing-a-label-when-a-card-is-added-to-a-project-board-column
+  - /managing-github-actions-with-github-cli
 ---
-<!-- {% link_in_list /about-continuous-integration %} -->
-<!-- {% link_in_list /setting-up-continuous-integration-using-workflow-templates %} -->
-<!-- {% link_in_list /building-and-testing-nodejs %} -->
-<!-- {% link_in_list /building-and-testing-net %} -->
-<!-- {% link_in_list /building-and-testing-powershell %} -->
-<!-- {% link_in_list /building-and-testing-python %} -->
-<!-- {% link_in_list /building-and-testing-ruby %} -->
-<!-- {% link_in_list /building-and-testing-java-with-maven %} -->
-<!-- {% link_in_list /building-and-testing-java-with-gradle %} -->
-<!-- {% link_in_list /building-and-testing-java-with-ant %} -->
-<!-- {% link_in_list /building-and-testing-swift %}-->
-<!-- {% link_in_list /installing-an-apple-certificate-on-macos-runners-for-xcode-development %} -->
-<!-- {% link_in_list /building-and-testing-xamarin-applications %} -->
-<!-- {% link_in_list /about-packaging-with-github-actions %} -->
-<!-- {% link_in_list /publishing-nodejs-packages %} -->
-<!-- {% link_in_list /publishing-java-packages-with-maven %} -->
-<!-- {% link_in_list /publishing-java-packages-with-gradle %} -->
-<!-- {% link_in_list /publishing-docker-images %} -->
-<!-- {% link_in_list /storing-workflow-data-as-artifacts %} -->
-<!-- {% link_in_list /caching-dependencies-to-speed-up-workflows %} -->
-<!-- {% link_in_list /about-service-containers %} -->
-<!-- {% link_in_list /creating-redis-service-containers %} -->
-<!-- {% link_in_list /creating-postgresql-service-containers %} -->
-<!-- {% link_in_list /deploying-to-amazon-elastic-container-service %} -->
-<!-- {% link_in_list /deploying-to-azure-app-service %} -->
-<!-- {% link_in_list /deploying-to-google-kubernetes-engine %} -->
-<!-- {% link_in_list /deploying-to-google-kubernetes-engine %} -->
-<!-- {% link_in_list /using-github-actions-for-project-management %} -->
-<!-- {% link_in_list /closing-inactive-issues %} -->
-<!-- {% link_in_list /scheduling-issue-creation %} -->
-<!-- {% link_in_list /adding-labels-to-issues %} -->
-<!-- {% link_in_list /commenting-on-an-issue-when-a-label-is-added %} -->
-<!-- {% link_in_list /moving-assigned-issues-on-project-boards %} -->
-<!-- {% link_in_list /removing-a-label-when-a-card-is-added-to-a-project-board-column %} -->
-<!-- {% link_in_list /managing-github-actions-with-github-cli %} -->
+

content/actions/hosting-your-own-runners/index.md

@@ -8,19 +8,18 @@ versions:
   free-pro-team: '*'
   enterprise-server: '>=2.22'
   github-ae: '*'
+children:
+  - /about-self-hosted-runners
+  - /adding-self-hosted-runners
+  - /configuring-the-self-hosted-runner-application-as-a-service
+  - /using-a-proxy-server-with-self-hosted-runners
+  - /using-labels-with-self-hosted-runners
+  - /using-self-hosted-runners-in-a-workflow
+  - /managing-access-to-self-hosted-runners-using-groups
+  - /monitoring-and-troubleshooting-self-hosted-runners
+  - /removing-self-hosted-runners
 ---
-
 {% data reusables.actions.ae-self-hosted-runners-notice %}
 {% data reusables.actions.enterprise-beta %}
 {% data reusables.actions.enterprise-github-hosted-runners %}
 {% data reusables.actions.ae-beta %}
-
-{% link_in_list /about-self-hosted-runners %}
-{% link_in_list /adding-self-hosted-runners %}
-{% link_in_list /configuring-the-self-hosted-runner-application-as-a-service %}
-{% link_in_list /using-a-proxy-server-with-self-hosted-runners %}
-{% link_in_list /using-labels-with-self-hosted-runners %}
-{% link_in_list /using-self-hosted-runners-in-a-workflow %}
-{% link_in_list /managing-access-to-self-hosted-runners-using-groups %}
-{% link_in_list /monitoring-and-troubleshooting-self-hosted-runners %}
-{% link_in_list /removing-self-hosted-runners %}

content/actions/index.md

@@ -22,9 +22,9 @@ featuredLinks:
     - /actions/reference/environment-variables
     - /actions/reference/encrypted-secrets
 changelog:
-  label: 'actions'
+  label: actions
   prefix: 'GitHub Actions: '
-product_video: https://www.youtube-nocookie.com/embed/cP0I9w2coGU
+product_video: 'https://www.youtube-nocookie.com/embed/cP0I9w2coGU'
 redirect_from:
   - /articles/automating-your-workflow-with-github-actions/
   - /articles/customizing-your-project-with-github-actions/
@@ -37,13 +37,14 @@ versions:
   free-pro-team: '*'
   enterprise-server: '>=2.22'
   github-ae: '*'
+children:
+  - /quickstart
+  - /guides
+  - /learn-github-actions
+  - /managing-workflow-runs
+  - /creating-actions
+  - /using-github-hosted-runners
+  - /hosting-your-own-runners
+  - /reference
 ---
 
-<!-- {% link_with_intro /quickstart %} -->
-<!-- {% link_with_intro /guides %} -->
-<!-- {% link_with_intro /learn-github-actions %} -->
-<!-- {% link_with_intro /managing-workflow-runs %} -->
-<!-- {% link_with_intro /creating-actions %} -->
-<!-- {% link_with_intro /using-github-hosted-runners %} -->
-<!-- {% link_with_intro /hosting-your-own-runners %} -->
-<!-- {% link_with_intro /reference %} -->

content/actions/learn-github-actions/index.md

@@ -29,16 +29,17 @@ versions:
   free-pro-team: '*'
   enterprise-server: '>=2.22'
   github-ae: '*'
+children:
+  - /introduction-to-github-actions
+  - /finding-and-customizing-actions
+  - /essential-features-of-github-actions
+  - /managing-complex-workflows
+  - /sharing-workflows-with-your-organization
+  - /security-hardening-for-github-actions
+  - /migrating-from-azure-pipelines-to-github-actions
+  - /migrating-from-circleci-to-github-actions
+  - /migrating-from-gitlab-cicd-to-github-actions
+  - /migrating-from-jenkins-to-github-actions
+  - /migrating-from-travis-ci-to-github-actions
 ---
 
-{% link_with_intro /introduction-to-github-actions %}
-{% link_with_intro /finding-and-customizing-actions %}
-{% link_with_intro /essential-features-of-github-actions %}
-{% link_with_intro /managing-complex-workflows %}
-{% link_with_intro /sharing-workflows-with-your-organization %}
-{% link_with_intro /security-hardening-for-github-actions %}
-{% link_with_intro /migrating-from-azure-pipelines-to-github-actions %}
-{% link_with_intro /migrating-from-circleci-to-github-actions %}
-{% link_with_intro /migrating-from-gitlab-cicd-to-github-actions %}
-{% link_with_intro /migrating-from-jenkins-to-github-actions %}
-{% link_with_intro /migrating-from-travis-ci-to-github-actions %}

content/actions/managing-workflow-runs/index.md

@@ -14,24 +14,24 @@ versions:
   free-pro-team: '*'
   enterprise-server: '>=2.22'
   github-ae: '*'
+children:
+  - /using-the-visualization-graph
+  - /viewing-workflow-run-history
+  - /using-workflow-run-logs
+  - /manually-running-a-workflow
+  - /re-running-a-workflow
+  - /canceling-a-workflow
+  - /approving-workflow-runs-from-public-forks
+  - /reviewing-deployments
+  - /disabling-and-enabling-a-workflow
+  - /deleting-a-workflow-run
+  - /viewing-job-execution-time
+  - /downloading-workflow-artifacts
+  - /removing-workflow-artifacts
+  - /enabling-debug-logging
+  - /adding-a-workflow-status-badge
 ---
-
 {% data reusables.actions.enterprise-beta %}
 {% data reusables.actions.enterprise-github-hosted-runners %}
 {% data reusables.actions.ae-beta %}
-
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %}{% link_in_list /using-the-visualization-graph %}{% endif %}
-{% link_in_list /viewing-workflow-run-history %}
-{% link_in_list /using-workflow-run-logs %}
-{% link_in_list /manually-running-a-workflow %}
-{% link_in_list /re-running-a-workflow %}
-{% link_in_list /canceling-a-workflow %}
-{% link_in_list /approving-workflow-runs-from-public-forks %}
-{% link_in_list /reviewing-deployments %}
-{% link_in_list /disabling-and-enabling-a-workflow %}
-{% link_in_list /deleting-a-workflow-run %}
-{% link_in_list /viewing-job-execution-time %}
-{% link_in_list /downloading-workflow-artifacts %}
-{% link_in_list /removing-workflow-artifacts %}
-{% link_in_list /enabling-debug-logging %}
-{% link_in_list /adding-a-workflow-status-badge %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %}{% endif %}

content/actions/reference/index.md

@@ -7,52 +7,37 @@ versions:
   free-pro-team: '*'
   enterprise-server: '>=2.22'
   github-ae: '*'
+children:
+  - /workflow-syntax-for-github-actions
+  - /context-and-expression-syntax-for-github-actions
+  - /workflow-commands-for-github-actions
+  - /events-that-trigger-workflows
+  - /authentication-in-a-workflow
+  - /encrypted-secrets
+  - /environments
+  - /environment-variables
+  - /usage-limits-billing-and-administration
 ---
-
 {% data reusables.actions.enterprise-beta %}
 {% data reusables.actions.enterprise-github-hosted-runners %}
 {% data reusables.actions.ae-beta %}
-
 ### Workflow syntax
-
 The workflow file is written in YAML. In the YAML workflow file, you can use expression syntax to evaluate contextual information, literals, operators, and functions. Contextual information includes workflow, environment variables, secrets, and the events that triggered the workflow. When you use [`run`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepsrun) in a workflow step to run shell commands, you can use specific workflow command syntax to set environment variables, set output parameters for subsequent steps, and set error or debug messages.
-
-{% link_in_list /workflow-syntax-for-github-actions %}
-{% link_in_list /context-and-expression-syntax-for-github-actions %}
-{% link_in_list /workflow-commands-for-github-actions %}
-
 ### Events
 
 You can configure workflows to run when specific GitHub events occur, at a scheduled time, manually, or when events outside of GitHub occur.
 
-{% link_in_list /events-that-trigger-workflows %}
-
 ### Authentication and secrets
 
 {% data variables.product.prodname_dotcom %} provides a token that you can use to authenticate on behalf of {% data variables.product.prodname_actions %}. You can also store sensitive information as a secret in your organization{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %}, repository, or environments{% else %} or repository{% endif %}. {% data variables.product.prodname_dotcom %} encrypts all secrets.
 
-{% link_in_list /authentication-in-a-workflow %}
-{% link_in_list /encrypted-secrets %}
-
 {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %}
 ### Environments
-
 Workflow jobs can reference environments that have protection rules or environment-specific secrets.
-
-{% link_in_list /environments %}
 {% endif %}
-
 ### Environment variables
-
 {% data variables.product.prodname_dotcom %} sets default environment variables for each {% data variables.product.prodname_actions %} workflow run. You can also set custom environment variables in your workflow file.
-
-{% link_in_list /environment-variables %}
-
 {% if currentVersion == "free-pro-team@latest" %}
 ### Administration
-
 When you run workflows on {% data variables.product.prodname_dotcom %}-hosted runners, there are usage limits and potential usage charges. You can also disable or restrict the usage of {% data variables.product.prodname_actions %} in a repository and organization.
-
-{% link_in_list /usage-limits-billing-and-administration %}
-
 {% endif %}

content/actions/using-github-hosted-runners/index.md

@@ -5,16 +5,15 @@ versions:
   free-pro-team: '*'
   enterprise-server: '>=2.22'
   github-ae: '*'
+children:
+  - /about-github-hosted-runners
+  - /customizing-github-hosted-runners
+  - /about-ae-hosted-runners
+  - /adding-ae-hosted-runners
+  - /using-ae-hosted-runners-in-a-workflow
+  - /using-labels-with-ae-hosted-runners
+  - /using-groups-to-manage-access-to-ae-hosted-runners
+  - /creating-custom-images
 ---
-
 {% data reusables.actions.enterprise-beta %}
 {% data reusables.actions.enterprise-github-hosted-runners %}
-
-{% link_in_list /about-github-hosted-runners %}
-{% link_in_list /customizing-github-hosted-runners %}
-{% link_in_list /about-ae-hosted-runners %}
-{% link_in_list /adding-ae-hosted-runners %}
-{% link_in_list /using-ae-hosted-runners-in-a-workflow %}
-{% link_in_list /using-labels-with-ae-hosted-runners %}
-{% link_in_list /using-groups-to-manage-access-to-ae-hosted-runners %}
-{% link_in_list /creating-custom-images %}