Updated structure (concepts / glossary) (#73)

score-spec · Mar 12, 2024 · 3ab8362 · 3ab8362
2 parents 286d142 + 42cdfe9
commit 3ab8362
Show file tree

Hide file tree

Showing 31 changed files with 35 additions and 273 deletions.
diff --git a/content/en/docs/concepts/_index.md b/content/en/docs/concepts/_index.md
diff --git a/content/en/docs/concepts/configuration-management.md b/content/en/docs/concepts/configuration-management.md
diff --git a/content/en/docs/concepts/container.md b/content/en/docs/concepts/container.md
diff --git a/content/en/docs/concepts/dependencies.md b/content/en/docs/concepts/dependencies.md
diff --git a/content/en/docs/concepts/environment-configuration.md b/content/en/docs/concepts/environment-configuration.md
diff --git a/content/en/docs/concepts/score.md b/content/en/docs/concepts/score.md
diff --git a/content/en/docs/concepts/workload.md b/content/en/docs/concepts/workload.md
diff --git a/content/en/docs/dependencies/_index.md b/content/en/docs/dependencies/_index.md
@@ -4,6 +4,8 @@ linkTitle: "Declare dependencies"
 weight: 6
 description: >
   Describes how to set Workloads that are dependent on additional resources.
+aliases:
+- /docs/concepts/dependencies
 ---
 
 The Score Specification has a `resources` section that is used to describe Workload's dependencies. This mechanism can be used to spin-up multiservice setups.
@@ -157,5 +159,4 @@ compose-service-b-1  | service-b: Hello World!
 
 For more information, see the following links.
 
-- Review the [Workload dependencies]({{< relref "../concepts/dependencies" >}} "Workload dependencies") page.
-- Review the [resource section]({{< relref "../reference/score-spec-reference.md#resources-definition" >}} "Resource definition") of the Score Specification reference.
+- Review the [resource section]({{< relref "/docs/reference/score-spec-reference.md#resources-definition" >}} "Resource definition") of the Score Specification reference.
diff --git a/content/en/docs/environment variables/_index.md b/content/en/docs/environment variables/_index.md
@@ -10,10 +10,14 @@ description: >
 
 You can pass environment-specific configuration to the container during a deployment. The Score Specification enables a special environment resource type to be used to support such use cases.
 
-Environment configurations are set within the [`resource`]({{< relref "../reference/score-spec-reference.md" >}} "Container") section of your Score Specification file. These act as environment variables when you're deploying a {{< glossary_tooltip text="Workload" term_id="workload" >}}.
+Environment configurations are set within the [`resource`]({{< relref "/docs/reference/score-spec-reference.md" >}} "Container") section of your Score Specification file. These act as environment variables when you're deploying a Workload.
 
 Values for those variables can be either hard-coded (not recommended) or sourced from the resources properties through substitutions (recommended) such as `${resources.my-db.host}`.
 
 The Score Specification supports declaring environment variables in a configurations files or as a shell value.
 
-For more information, see [Environment specific configuration]({{< relref "../concepts/environment-configuration" >}})
+For more information, see
+
+- [Environment variables in score-compose]({{< relref "/docs/environment variables/environment-variables-compose" >}})
+- [Environment variables in score-helm]({{< relref "/docs/environment variables/environment-variables-helm" >}}) 
+- [Environment variables in score-humanite]({{< relref "/docs/environment variables/environment-variables-humanitec" >}})
diff --git a/content/en/docs/environment variables/environment-variables-helm.md b/content/en/docs/environment variables/environment-variables-helm.md
@@ -38,7 +38,7 @@ resources:
 > Resources need to map to the resource structure.
 > To declare environment variables in a Score file, the variable name, `resources.env.NAME` must map to the structure in `resource` section.
 
-For more information, see the [Resource section]({{< relref "/content/en/docs/reference/score-spec-reference.md#referencing-resources" >}}) in the Score Specification reference.
+For more information, see the [Resource section]({{< relref "/docs/reference/score-spec-reference.md#referencing-resources" >}}) in the Score Specification reference.
 
 {{% /alert %}}
 

diff --git a/content/en/docs/environment variables/environment-variables-humanitec.md b/content/en/docs/environment variables/environment-variables-humanitec.md
@@ -36,7 +36,7 @@ resources:
 > Resources need to map to the resource structure.
 > To declare environment variables in a Score file, the variable name, `resources.env.NAME` must map to the structure in `resource` section.
 
-For more information, see the [Resource section]({{< relref "/content/en/docs/reference/score-spec-reference.md#referencing-resources" >}}) in the Score Specification reference.
+For more information, see the [Resource section]({{< relref "/docs/reference/score-spec-reference.md#referencing-resources" >}}) in the Score Specification reference.
 
 {{% /alert %}}
 

diff --git a/content/en/docs/extensions/_index.md b/content/en/docs/extensions/_index.md
@@ -22,7 +22,7 @@ Score supports extension files.
 
 <!-- Routes Management in Applications -->
 
-Applications that consist of multiple microservices typically need a routing controller that redirects incoming requests to a proper {{< glossary_tooltip text="Workload" term_id="workload" >}} at run time.
+Applications that consist of multiple microservices typically need a routing controller that redirects incoming requests to a proper Workload at run time.
 
 For example, a common scenario is to deploy an API Gateway, Ingress controller, or Service mesh as part of your application.
 Maintaining and updating routing tables after new service deployments is a point of friction as the application scales.
@@ -35,9 +35,9 @@ Routes convert into resource definitions, so proper routes can be provisioned at
 
 {{% alert %}}
 
-> The Score Specification file has a concept of a {{< glossary_tooltip text="Workload specification" term_id="workload-spec" >}} that defines the requirements to run a Workload, but isn't used to manage Target Configuration or to provision any of the dependencies.
+> The Score Specification file has a concept of a Workload specification that defines the requirements to run a Workload, but isn't used to manage Target Configuration or to provision any of the dependencies.
 
-For more information, see [Score Specification]({{< relref "../concepts/score.md" >}} "Score Specification").
+For more information, see [Score Specification]({{< relref "/docs/reference/score-spec-reference" >}} "Score Specification").
 
 {{% /alert %}}
 

diff --git a/content/en/docs/extensions/implement-ports-volumes.md b/content/en/docs/extensions/implement-ports-volumes.md
@@ -5,7 +5,7 @@ weight: 4
 draft: false
 ---
 
-Using files and volumes or serving incoming requests on selected ports helps to build real world {{< glossary_tooltip text="Workloads" term_id="workload" >}} and applications.
+Using files and volumes or serving incoming requests on selected ports helps to build real world Workloads and applications.
 
 In such a scenario, you'd want to express this in your `score.yaml` file.
 
@@ -38,7 +38,7 @@ resources:
 
 Paired with the `score.yaml` file is the extension file, `humanitec.score.yaml`, which contains additional hints for the score-humanitec CLI tool.
 
-The extension file helps the CLI tool add proper routes to Humanitec's {{< glossary_tooltip text="Deployment Delta" term_id="deployment-delta" >}}, so that the service is available to the outer world.
+The extension file helps the CLI tool add proper routes to Humanitec's Deployment Delta, so that the service is available to the outer world.
 
 The following is an implementation of the `humanitec.score.yaml` file.
 
@@ -127,4 +127,4 @@ The generated JSON can then be used as a payload for a [Humanitec API call](http
 
 When deploying this service with `Humanitec`, make sure that the shared application value called `MESSAGE` is set for the target environment.
 
-For more information, see the [Humanitec extension reference]({{< relref "/content/en/docs/reference/humanitec-extension.md" >}}).
+For more information, see the [Humanitec extension reference]({{< relref "/docs/reference/humanitec-extension.md" >}}).
diff --git a/content/en/docs/get started/_index.md b/content/en/docs/get started/_index.md
@@ -6,4 +6,4 @@ weight: 2
 
 ## Overview
 
-The primary goal of the Score file is to quickly and easily describe a {{< glossary_tooltip text="Workloads" term_id="workload" >}} runtime requirements. The following covers what you need to know to compose a Score file and run a Workload via a Score Implementation CLI.
+The primary goal of the Score file is to quickly and easily describe a Workloads's runtime requirements. The following covers what you need to know to compose a Score file and run a Workload via a Score Implementation CLI.
diff --git a/content/en/docs/get started/install.md b/content/en/docs/get started/install.md
@@ -100,7 +100,7 @@ To upgrade the Score implementation (CLI), download the latest binary version an
 
 <!-- ### macOS
 
-We recommend installing the {{< glossary_tooltip text="Score implementation (CLI)" term_id="score" >}} with [Homebrew](https://brew.sh/index.html).
+We recommend installing the Score implementation with [Homebrew](https://brew.sh/index.html).
 With Homebrew, you can access an extensive selection of libraries and applications, with their dependencies managed for you.
 
 ### Prerequisites
@@ -116,7 +116,7 @@ Install Homebrew according to the [official Homebrew installation instructions](
 
 On the Linux operating systems, use the built-in package manager to install Score:
 
-1. Open a terminal and run these commands to install the latest {{< glossary_tooltip text="Score implementation (CLI)" term_id="score" >}} from the officially maintained package archives:
+1. Open a terminal and run these commands to install the latest Score implementation (CLI) from the officially maintained package archives:
 
    ```shell
    apt-add-repository ppa:score-compose

diff --git a/content/en/docs/glossary/config-management-tool.md b/content/en/docs/glossary/config-management-tool.md
diff --git a/content/en/docs/glossary/configuration-management.md b/content/en/docs/glossary/configuration-management.md
diff --git a/content/en/docs/glossary/deployment-delta.md b/content/en/docs/glossary/deployment-delta.md
diff --git a/content/en/docs/glossary/environment-variables.md b/content/en/docs/glossary/environment-variables.md
diff --git a/content/en/docs/glossary/environment.md b/content/en/docs/glossary/environment.md
diff --git a/content/en/docs/glossary/index.md b/content/en/docs/glossary/index.md
@@ -3,10 +3,11 @@ title: Glossary
 layout: glossary
 filter_text: Filter tags
 noedit: true
+draft: true
 weight: 10
 hide_summary: true
 card:
   name: reference
   weight: 10
   title: Glossary
----
+---
diff --git a/content/en/docs/glossary/resource.md b/content/en/docs/glossary/resource.md