Add topic property and filter to guides page (github#17328)

Co-authored-by: Emily Gould <[email protected]>
JohnnyMengistu · Jan 29, 2021 · 4038e9c · 4038e9c
1 parent 4f3f3b0
commit 4038e9c
Show file tree

Hide file tree

Showing 49 changed files with 351 additions and 83 deletions.
diff --git a/content/actions/creating-actions/about-actions.md b/content/actions/creating-actions/about-actions.md
@@ -11,6 +11,9 @@ versions:
   free-pro-team: '*'
   enterprise-server: '>=2.22'
 type: 'overview'
+topics:
+  - 'Action development'
+  - 'Fundamentals'
 ---
 
 {% data reusables.actions.enterprise-beta %}

diff --git a/content/actions/creating-actions/creating-a-composite-run-steps-action.md b/content/actions/creating-actions/creating-a-composite-run-steps-action.md
@@ -6,6 +6,8 @@ versions:
   free-pro-team: '*'
   enterprise-server: '>=2.22'
 type: 'tutorial'
+topics:
+  - 'Action development'
 ---
 
 {% data reusables.actions.enterprise-beta %}
@@ -32,7 +34,7 @@ Before you begin, you'll create a {% data variables.product.product_name %} repo
   ```
 
 2. In the `hello-world-composite-run-steps-action` repository, create a new file called `goodbye.sh`, and add the following example code:
-  
+
   ```bash
   echo "Goodbye"
   ```
@@ -65,12 +67,12 @@ Before you begin, you'll create a {% data variables.product.product_name %} repo
         required: true
         default: 'World'
     outputs:
-      random-number: 
+      random-number:
         description: "Random number"
         value: ${{ steps.random-number-generator.outputs.random-id }}
     runs:
       using: "composite"
-      steps: 
+      steps:
         - run: echo Hello ${{ inputs.who-to-greet }}.
           shell: bash
         - id: random-number-generator
@@ -82,7 +84,7 @@ Before you begin, you'll create a {% data variables.product.product_name %} repo
     {% endraw %}
   This file defines the `who-to-greet` input, maps the random generated number to the `random-number` output variable, and runs the `goodbye.sh` script. It also tells the runner how to execute the composite run steps action.
 
-  For more information about managing outputs, see "[`outputs` for a composite run steps](/actions/creating-actions/metadata-syntax-for-github-actions#outputs-for-composite-run-steps-actions)". 
+  For more information about managing outputs, see "[`outputs` for a composite run steps](/actions/creating-actions/metadata-syntax-for-github-actions#outputs-for-composite-run-steps-actions)".
 
   For more information about how to use `github.action_path`, see "[`github context`](/actions/reference/context-and-expression-syntax-for-github-actions#github-context)".
 
@@ -122,7 +124,7 @@ jobs:
       uses: actions/hello-world-composite-run-steps-action@v1
       with:
         who-to-greet: 'Mona the Octocat'
-    - run: echo random-number ${{ steps.foo.outputs.random-number }} 
+    - run: echo random-number ${{ steps.foo.outputs.random-number }}
       shell: bash
 ```
 {% endraw %}

diff --git a/content/actions/creating-actions/creating-a-docker-container-action.md b/content/actions/creating-actions/creating-a-docker-container-action.md
@@ -11,6 +11,9 @@ versions:
   free-pro-team: '*'
   enterprise-server: '>=2.22'
 type: 'tutorial'
+topics:
+  - 'Action development'
+  - 'Docker'
 ---
 
 {% data reusables.actions.enterprise-beta %}
@@ -93,7 +96,7 @@ This metadata defines one `who-to-greet`  input and one `time` output parameter.
 
 You can choose any base Docker image and, therefore, any language for your action. The following shell script example uses the `who-to-greet` input variable to print "Hello [who-to-greet]" in the log file.
 
-Next, the script gets the current time and sets it as an output variable that actions running later in a job can use. In order for {% data variables.product.prodname_dotcom %} to recognize output variables, you must use a workflow command in a specific syntax: `echo "::set-output name=<output name>::<value>"`. For more information, see "[Workflow commands for {% data variables.product.prodname_actions %}](/actions/reference/workflow-commands-for-github-actions#setting-an-output-parameter)." 
+Next, the script gets the current time and sets it as an output variable that actions running later in a job can use. In order for {% data variables.product.prodname_dotcom %} to recognize output variables, you must use a workflow command in a specific syntax: `echo "::set-output name=<output name>::<value>"`. For more information, see "[Workflow commands for {% data variables.product.prodname_actions %}](/actions/reference/workflow-commands-for-github-actions#setting-an-output-parameter)."
 
 1. Create a new `entrypoint.sh` file in the `hello-world-docker-action` directory.
 
@@ -102,7 +105,7 @@ Next, the script gets the current time and sets it as an output variable that ac
   **entrypoint.sh**
   ```shell{:copy}
   #!/bin/sh -l
-  
+
   echo "Hello $1"
   time=$(date)
   echo "::set-output name=time::$time"

diff --git a/content/actions/creating-actions/creating-a-javascript-action.md b/content/actions/creating-actions/creating-a-javascript-action.md
@@ -11,6 +11,9 @@ versions:
   free-pro-team: '*'
   enterprise-server: '>=2.22'
 type: 'tutorial'
+topics:
+  - 'Action development'
+  - 'JavaScript'
 ---
 
 {% data reusables.actions.enterprise-beta %}

diff --git a/content/actions/guides/about-continuous-integration.md b/content/actions/guides/about-continuous-integration.md
@@ -11,11 +11,14 @@ versions:
   free-pro-team: '*'
   enterprise-server: '>=2.22'
 type: 'overview'
+topics:
+  - 'CI'
+  - 'CD'
 ---
 
 {% data reusables.actions.enterprise-beta %}
 {% data reusables.actions.enterprise-github-hosted-runners %}
- 
+
 ### About continuous integration
 
 Continuous integration (CI) is a software practice that requires frequently committing code to a shared repository. Committing code more often detects errors sooner and reduces the amount of code a developer needs to debug when finding the source of an error. Frequent code updates also make it easier to merge changes from different members of a software development team. This is great for developers, who can spend more time writing code and less time debugging errors or resolving merge conflicts.

diff --git a/content/actions/guides/about-packaging-with-github-actions.md b/content/actions/guides/about-packaging-with-github-actions.md
@@ -9,6 +9,8 @@ versions:
   free-pro-team: '*'
   enterprise-server: '>=2.22'
 type: 'overview'
+topics:
+  - 'Packaging'
 ---
 
 {% data reusables.actions.enterprise-beta %}

diff --git a/content/actions/guides/about-service-containers.md b/content/actions/guides/about-service-containers.md
@@ -9,6 +9,9 @@ versions:
   free-pro-team: '*'
   enterprise-server: '>=2.22'
 type: 'overview'
+topics:
+  - 'Containers'
+  - 'Docker'
 ---
 
 {% data reusables.actions.enterprise-beta %}

diff --git a/content/actions/guides/building-and-testing-java-with-ant.md b/content/actions/guides/building-and-testing-java-with-ant.md
@@ -8,6 +8,10 @@ versions:
   free-pro-team: '*'
   enterprise-server: '>=2.22'
 type: 'tutorial'
+topics:
+  - 'CI'
+  - 'Java'
+  - 'Ant'
 ---
 
 {% data reusables.actions.enterprise-beta %}

diff --git a/content/actions/guides/building-and-testing-java-with-gradle.md b/content/actions/guides/building-and-testing-java-with-gradle.md
@@ -8,6 +8,10 @@ versions:
   free-pro-team: '*'
   enterprise-server: '>=2.22'
 type: 'tutorial'
+topics:
+  - 'CI'
+  - 'Java'
+  - 'Gradle'
 ---
 
 {% data reusables.actions.enterprise-beta %}

diff --git a/content/actions/guides/building-and-testing-java-with-maven.md b/content/actions/guides/building-and-testing-java-with-maven.md
@@ -8,6 +8,10 @@ versions:
   free-pro-team: '*'
   enterprise-server: '>=2.22'
 type: 'tutorial'
+topics:
+  - 'CI'
+  - 'Java'
+  - 'Maven'
 ---
 
 {% data reusables.actions.enterprise-beta %}

diff --git a/content/actions/guides/building-and-testing-nodejs.md b/content/actions/guides/building-and-testing-nodejs.md
@@ -9,6 +9,10 @@ versions:
   free-pro-team: '*'
   enterprise-server: '>=2.22'
 type: 'tutorial'
+topics:
+  - 'CI'
+  - 'Node'
+  - 'JavaScript'
 ---
 
 {% data reusables.actions.enterprise-beta %}

diff --git a/content/actions/guides/building-and-testing-powershell.md b/content/actions/guides/building-and-testing-powershell.md
@@ -8,6 +8,9 @@ versions:
 authors:
   - potatoqualitee
 type: 'tutorial'
+topics:
+  - 'CI'
+  - 'Powershell'
 ---
 
 {% data reusables.actions.enterprise-beta %}

diff --git a/content/actions/guides/building-and-testing-python.md b/content/actions/guides/building-and-testing-python.md
@@ -8,6 +8,9 @@ versions:
   free-pro-team: '*'
   enterprise-server: '>=2.22'
 type: 'tutorial'
+topics:
+  - 'CI'
+  - 'Python'
 ---
 
 {% data reusables.actions.enterprise-beta %}

diff --git a/content/actions/guides/building-and-testing-ruby.md b/content/actions/guides/building-and-testing-ruby.md
@@ -6,6 +6,9 @@ versions:
   free-pro-team: '*'
   enterprise-server: '>=2.22'
 type: 'tutorial'
+topics:
+  - 'CI'
+  - 'Ruby'
 ---
 
 {% data reusables.actions.enterprise-beta %}
@@ -83,7 +86,7 @@ Alternatively, you can check a `.ruby-version` file  into the root of your repos
 
 ### Testing with multiple versions of Ruby
 
-You can add a matrix strategy to run your workflow with more than one version of Ruby. For example, you can test your code against the latest patch releases of versions 2.7, 2.6, and 2.5. The 'x' is a wildcard character that matches the latest patch release available for a version. 
+You can add a matrix strategy to run your workflow with more than one version of Ruby. For example, you can test your code against the latest patch releases of versions 2.7, 2.6, and 2.5. The 'x' is a wildcard character that matches the latest patch release available for a version.
 
 {% raw %}
 ```yaml
@@ -316,4 +319,3 @@ jobs:
         GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"
 ```
 {% endraw %}
-
diff --git a/content/actions/guides/caching-dependencies-to-speed-up-workflows.md b/content/actions/guides/caching-dependencies-to-speed-up-workflows.md
@@ -10,6 +10,8 @@ redirect_from:
 versions:
   free-pro-team: '*'
 type: 'tutorial'
+topics:
+  - 'Workflows'
 ---
 
 ### About caching workflow dependencies

diff --git a/content/actions/guides/creating-postgresql-service-containers.md b/content/actions/guides/creating-postgresql-service-containers.md
@@ -10,6 +10,9 @@ versions:
   free-pro-team: '*'
   enterprise-server: '>=2.22'
 type: 'tutorial'
+topics:
+  - 'Containers'
+  - 'Docker'
 ---
 
 {% data reusables.actions.enterprise-beta %}

diff --git a/content/actions/guides/creating-redis-service-containers.md b/content/actions/guides/creating-redis-service-containers.md
@@ -10,6 +10,9 @@ versions:
   free-pro-team: '*'
   enterprise-server: '>=2.22'
 type: 'tutorial'
+topics:
+  - 'Containers'
+  - 'Docker'
 ---
 
 {% data reusables.actions.enterprise-beta %}

diff --git a/content/actions/guides/deploying-to-amazon-elastic-container-service.md b/content/actions/guides/deploying-to-amazon-elastic-container-service.md
@@ -6,6 +6,10 @@ versions:
   free-pro-team: '*'
   enterprise-server: '>=2.22'
 type: 'tutorial'
+topics:
+  - 'CD'
+  - 'Containers'
+  - 'Amazon ECS'
 ---
 
 {% data reusables.actions.enterprise-beta %}

diff --git a/content/actions/guides/deploying-to-azure-app-service.md b/content/actions/guides/deploying-to-azure-app-service.md
@@ -6,6 +6,10 @@ versions:
   free-pro-team: '*'
   enterprise-server: '>=2.22'
 type: 'tutorial'
+topics:
+  - 'CD'
+  - 'Containers'
+  - 'Azure App Service'
 ---
 
 {% data reusables.actions.enterprise-beta %}

diff --git a/content/actions/guides/deploying-to-google-kubernetes-engine.md b/content/actions/guides/deploying-to-google-kubernetes-engine.md
@@ -6,6 +6,10 @@ versions:
   free-pro-team: '*'
   enterprise-server: '>=2.22'
 type: 'tutorial'
+topics:
+  - 'CD'
+  - 'Containers'
+  - 'Google Kubernetes Engine'
 ---
 
 {% data reusables.actions.enterprise-beta %}

diff --git a/content/actions/guides/index.md b/content/actions/guides/index.md
@@ -25,6 +25,43 @@ learningTracks:
   - hosting_your_own_runners
   - create_actions
 layout: product-sublanding
+includeGuides:
+  - /actions/quickstart
+  - /actions/learn-github-actions/introduction-to-github-actions
+  - /actions/creating-actions/creating-a-docker-container-action
+  - /actions/guides/setting-up-continuous-integration-using-workflow-templates
+  - /actions/guides/building-and-testing-python
+  - /actions/guides/building-and-testing-nodejs
+  - /actions/guides/about-packaging-with-github-actions
+  - /actions/guides/publishing-docker-images
+  - /actions/guides/caching-dependencies-to-speed-up-workflows
+  - /actions/guides/about-continuous-integration
+  - /actions/guides/building-and-testing-powershell
+  - /actions/guides/building-and-testing-ruby
+  - /actions/guides/building-and-testing-java-with-maven
+  - /actions/guides/building-and-testing-java-with-gradle
+  - /actions/guides/building-and-testing-java-with-ant
+  - /actions/guides/publishing-nodejs-packages
+  - /actions/guides/publishing-java-packages-with-maven
+  - /actions/guides/publishing-java-packages-with-gradle
+  - /actions/guides/storing-workflow-data-as-artifacts
+  - /actions/guides/about-service-containers
+  - /actions/guides/creating-redis-service-containers
+  - /actions/guides/creating-postgresql-service-containers
+  - /actions/guides/deploying-to-amazon-elastic-container-service
+  - /actions/guides/deploying-to-azure-app-service
+  - /actions/guides/deploying-to-google-kubernetes-engine
+  - /actions/learn-github-actions/essential-features-of-github-actions
+  - /actions/learn-github-actions/security-hardening-for-github-actions
+  - /actions/creating-actions/about-actions
+  - /actions/creating-actions/creating-a-javascript-action
+  - /actions/creating-actions/creating-a-composite-run-steps-action
+  - /actions/learn-github-actions/migrating-from-azure-pipelines-to-github-actions
+  - /actions/learn-github-actions/migrating-from-circleci-to-github-actions
+  - /actions/learn-github-actions/migrating-from-gitlab-cicd-to-github-actions
+  - /actions/learn-github-actions/migrating-from-jenkins-to-github-actions
+  - /actions/learn-github-actions/migrating-from-travis-ci-to-github-actions
+
 ---
 <!-- {% link_in_list /about-continuous-integration %} -->
 <!-- {% link_in_list /setting-up-continuous-integration-using-workflow-templates %} -->

diff --git a/content/actions/guides/publishing-docker-images.md b/content/actions/guides/publishing-docker-images.md
@@ -8,6 +8,10 @@ versions:
   free-pro-team: '*'
   enterprise-server: '>=2.22'
 type: 'tutorial'
+topics:
+  - 'Packaging'
+  - 'Publishing'
+  - 'Docker'
 ---
 
 {% data reusables.actions.enterprise-beta %}

diff --git a/content/actions/guides/publishing-java-packages-with-gradle.md b/content/actions/guides/publishing-java-packages-with-gradle.md
@@ -8,6 +8,11 @@ versions:
   free-pro-team: '*'
   enterprise-server: '>=2.22'
 type: 'tutorial'
+topics:
+  - 'Packaging'
+  - 'Publishing'
+  - 'Java'
+  - 'Gradle'
 ---
 
 {% data reusables.actions.enterprise-beta %}
@@ -148,7 +153,7 @@ jobs:
 
 {% data reusables.github-actions.gradle-workflow-steps %}
 1. Runs the `gradle publish` command to publish to {% data variables.product.prodname_registry %}. The `GITHUB_TOKEN` environment variable will be set with the content of the `GITHUB_TOKEN` secret.
-   
+
    For more information about using secrets in your workflow, see "[Creating and using encrypted secrets](/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)."
 
 ### Publishing packages to the Maven Central Repository and {% data variables.product.prodname_registry %}

diff --git a/content/actions/guides/publishing-java-packages-with-maven.md b/content/actions/guides/publishing-java-packages-with-maven.md
@@ -8,6 +8,11 @@ versions:
   free-pro-team: '*'
   enterprise-server: '>=2.22'
 type: 'tutorial'
+topics:
+  - 'Packaging'
+  - 'Publishing'
+  - 'Java'
+  - 'Maven'
 ---
 
 {% data reusables.actions.enterprise-beta %}
@@ -155,7 +160,7 @@ This workflow performs the following steps:
 1. Checks out a copy of project's repository.
 1. Sets up the Java JDK, and also automatically configures the Maven _settings.xml_ file to add authentication for the `github` Maven repository to use the `GITHUB_TOKEN` environment variable.
 1. {% data reusables.github-actions.publish-to-packages-workflow-step %}
- 
+
    For more information about using secrets in your workflow, see "[Creating and using encrypted secrets](/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)."
 
 ### Publishing packages to the Maven Central Repository and {% data variables.product.prodname_registry %}