Added how to folder (#88)

score-spec · Apr 15, 2024 · 0709122 · 0709122
2 parents 0994c55 + 3ab9dda
commit 0709122
Show file tree

Hide file tree

Showing 21 changed files with 35 additions and 232 deletions.
diff --git a/content/en/docs/How to/_index.md b/content/en/docs/How to/_index.md
@@ -0,0 +1,10 @@
+---
+title: "How-to guides"
+linkTitle: "How to guides"
+weight: 8
+draft: false
+description: >
+  Learn how to use Score with these how-to guides.
+aliases:
+- /docs/tutorials/
+---
diff --git a/...eference/score-cli/enable-autocomplete.md → ...ent/en/docs/How to/enable-autocomplete.md b/...eference/score-cli/enable-autocomplete.md → ...ent/en/docs/How to/enable-autocomplete.md
@@ -1,9 +1,11 @@
 ---
 title: "Enable autocomplete for shell"
-linkTitle: "Enable autocomplete"
+linkTitle: "Autocompletion"
 weight: 10
 description: >
-  Enables autocomplete for the Score implementation (CLI).
+  How to autocomplete for the Score implementation (CLI)
+aliases: 
+- /docs/reference/score-cli/enable-autocomplete/
 ---
 
 <!-- By default, Homebrew install the autocompletion script. -->
@@ -53,6 +55,6 @@ For help with enabling autocomplete script for the shell, use the `--help` flag
 score-compose completion bash --help
 ```
 
-For more information, see Cobra's documentation on [Generating shell completions](https://github.com/spf13/cobra/blob/main/shell_completions.md).
+For more information, see Cobra's documentation on [Generating shell completions](https://github.com/spf13/cobra/blob/main/site/content/completions/_index.md).
 
-For information on use setting up your IDE's autocomplete for `score.yaml`` files, see [IDE linter and autocomplete for Score's JSON schema]({{< relref "/docs/score-specification/score-schema-reference" >}}).
+For information on use setting up your IDE's autocomplete for `score.yaml` files, see [IDE linter and autocomplete for Score's JSON schema]({{< relref "/docs/score specification/ide-linter-autocomplete" >}}).
diff --git a/...t/en/docs/environment variables/_index.md → ...t/en/docs/How to/environment-variables.md b/...t/en/docs/environment variables/_index.md → ...t/en/docs/How to/environment-variables.md
@@ -1,9 +1,9 @@
 ---
 title: "Define environment variables"
-linkTitle: "Environment variables"
+linkTitle: "Env variables"
 weight: 5
 description: >
-    This section describes how to define environment variables.
+    How to define environment variables in your Score specification
 aliases:
 - /docs/environment-variables/environment-variables-compose/
 - /docs/environment-variables/environment-variables-helm/

diff --git a/content/en/docs/tutorials/github.md → content/en/docs/How to/github.md b/content/en/docs/tutorials/github.md → content/en/docs/How to/github.md
@@ -1,10 +1,13 @@
 ---
 title: "Setup GitHub Actions"
 subtitle: "Setup GitHub Actions for Continuous Integration"
+linkTitle: GitHub Actions
 weight: 5
 draft: false
 description: >
-    A tutorial on how to set up Score with GitHub Actions.
+    How to set up Score with GitHub Actions
+aliases:
+- /docs/tutorials/github/
 ---
 
 You can use any Score implementation CLI in your GitHub Action workflows, for example, when you make a code change, and you want the Humanitec Platform Orchestrator to deploy your code to a new environment.

diff --git a/...cs/reference/score-cli/included/_index.md → content/en/docs/How to/included/_index.md b/...cs/reference/score-cli/included/_index.md → content/en/docs/How to/included/_index.md
diff --git a/...cluded/optional-score-configs-bash-mac.md → ...cluded/optional-score-configs-bash-mac.md b/...cluded/optional-score-configs-bash-mac.md → ...cluded/optional-score-configs-bash-mac.md
diff --git a/...i/included/optional-score-configs-fish.md → ...o/included/optional-score-configs-fish.md b/...i/included/optional-score-configs-fish.md → ...o/included/optional-score-configs-fish.md
diff --git a/...i/included/optional-score-configs-pwsh.md → ...o/included/optional-score-configs-pwsh.md b/...i/included/optional-score-configs-pwsh.md → ...o/included/optional-score-configs-pwsh.md
diff --git a/...li/included/optional-score-configs-zsh.md → ...to/included/optional-score-configs-zsh.md b/...li/included/optional-score-configs-zsh.md → ...to/included/optional-score-configs-zsh.md
diff --git a/content/en/docs/override/_index.md → content/en/docs/How to/overrides.md b/content/en/docs/override/_index.md → content/en/docs/How to/overrides.md
@@ -2,6 +2,11 @@
 title: "Specify configuration overrides"
 linkTitle: "Overrides"
 weight: 5
+description: >
+    How to define overrides for your Score specification
+aliases:
+- /docs/override/
+- /docs/override/override-parameters/
 ---
 
 An override is a way for you to customize or modify certain aspects of the `score.yaml` file. This can be achieved using either:
@@ -90,7 +95,7 @@ Set the path of the property to an empty value to remove the property.
 score-compose run -f score.yaml --property metadata.my-service=
 ```
 
-For more information, see the [Score CLI reference]({{< relref "docs/reference/score-cli/" >}}).
+For more information, see the [Score CLI reference]({{< relref "docs/score-implementation" >}}).
 
 ### Example: How to substitute a property
 

diff --git a/content/en/docs/tutorials/score-compose.md → content/en/docs/How to/score-compose.md b/content/en/docs/tutorials/score-compose.md → content/en/docs/How to/score-compose.md
diff --git a/content/en/docs/_index.md b/content/en/docs/_index.md
@@ -20,9 +20,8 @@ To get started, you'll want to:
 
 - Read through the [Overview page]({{< relref "/overview" >}} "Overview").
 - Learn how to [install the Score implementation (CLI)]({{< relref "/install" >}} "Learn to install").
-- Review the [reference material]({{< relref "reference" >}} "Reference content").
 
 Beyond the getting started section, you can learn more about Score and how to implement it into your own workflows.
 
 - [Concepts](/docs/concepts): Recommended reading for anyone consuming or operating Score.
-- [Set environment variables]({{< relref "environment%20variables/_index.md" >}}) Learn how to set and manage environment-specific variables.
+- [Set environment variables](/docs/how-to-guides/enviornment-variables) Learn how to set and manage environment-specific variables.
diff --git a/content/en/docs/reference/_index.md b/content/en/docs/reference/_index.md
diff --git a/content/en/docs/reference/score-cli/_index.md b/content/en/docs/reference/score-cli/_index.md
diff --git a/content/en/docs/reference/score-cli/errors.md b/content/en/docs/reference/score-cli/errors.md
diff --git a/content/en/docs/score implementation/_index.md b/content/en/docs/score implementation/_index.md
@@ -2,4 +2,6 @@
 title: "Score Implementation CLIs"
 linkTitle: "Score implementations"
 weight: 3
+aliases:
+- /docs/reference/score-cli/
 ---
diff --git a/content/en/docs/score implementation/score-helm.md b/content/en/docs/score implementation/score-helm.md
@@ -1,7 +1,7 @@
 ---
 title: "score-helm"
 linkTitle: "score-helm"
-description: "Translates the Score file into a Helm values file."
+description: "CLI Reference for score-helm"
 weight: 4
 aliases:
 - /docs/reference/score-cli/score-helm-run/

diff --git a/content/en/docs/score implementation/score-humanitec.md b/content/en/docs/score implementation/score-humanitec.md
@@ -1,7 +1,7 @@
 ---
 title: "score-humanitec"
 linkTitle: "score-humanitec"
-description: "Translates the Score file into a Humanitec Deployment Set"
+description: "CLI Reference for score-humanitec"
 weight: 4
 aliases:
 - /docs/get-started/score-humanitec-hello-world/

diff --git a/content/en/docs/score specification/score-schema-reference.md b/content/en/docs/score specification/score-schema-reference.md
@@ -3,7 +3,7 @@ title: "Score schema reference"
 linkTitle: "Schema reference"
 weight: 10
 description: >
-    Validate your Score file with the Score schema.
+    Validate your Score file with the Score schema
 aliases:
 - /docs/reference/score-schema-reference/
 ---

diff --git a/content/en/docs/score specification/score-spec-reference.md b/content/en/docs/score specification/score-spec-reference.md
@@ -3,7 +3,7 @@ title: "Score specification reference"
 linkTitle: "Score specification"
 weight: 9
 description: >
-    Reference implementation for the Score Specification.
+    Reference implementation for the Score Specification
 aliases:
 - /docs/dependencies
 - /docs/annotations

diff --git a/content/en/docs/tutorials/_index.md b/content/en/docs/tutorials/_index.md