Skip to content

Commit

Permalink
Fixing aliases, removing glossary links and relative links
Browse files Browse the repository at this point in the history
  • Loading branch information
TobiasBabin committed Mar 12, 2024
1 parent e438ec6 commit 67d49e6
Show file tree
Hide file tree
Showing 13 changed files with 43 additions and 28 deletions.
5 changes: 2 additions & 3 deletions content/en/docs/dependencies/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ weight: 6
description: >
Describes how to set Workloads that are dependent on additional resources.
aliases:
- ../concepts/dependencies/
- /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.
Expand Down Expand Up @@ -159,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.
8 changes: 6 additions & 2 deletions content/en/docs/environment variables/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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" >}})
Original file line number Diff line number Diff line change
Expand Up @@ -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 %}}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 %}}

Expand Down
6 changes: 3 additions & 3 deletions content/en/docs/extensions/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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 %}}

Expand Down
6 changes: 3 additions & 3 deletions content/en/docs/extensions/implement-ports-volumes.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -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" >}}).
2 changes: 1 addition & 1 deletion content/en/docs/get started/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
4 changes: 2 additions & 2 deletions content/en/docs/get started/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
13 changes: 13 additions & 0 deletions content/en/docs/glossary/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: Glossary
layout: glossary
filter_text: Filter tags
noedit: true
draft: true
weight: 10
hide_summary: true
card:
name: reference
weight: 10
title: Glossary
---
2 changes: 1 addition & 1 deletion content/en/docs/override/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Alternatively, use the `--property` flag to specify individual properties to ove

## Overview

If an `overrides.score.yaml` file is found, the {{< glossary_tooltip text="Score implementation (CLI)" term_id="score" >}} applies overrides on the output. This occurs whether a flag is provided or not.
If an `overrides.score.yaml` file is found, the Score implementation (CLI) applies overrides on the output. This occurs whether a flag is provided or not.

Any property of Score segment can be overridden.

Expand Down
15 changes: 7 additions & 8 deletions content/en/docs/overview/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,12 @@ Focus_Keyword: "Learn about the Score Specification"
description: >
Learn about Score, the Score implementation (CLI), and how to eliminate configuration mismanagement.
aliases:
- ../concepts
- ../concepts/container
- ../concepts/dependencies
- ../concepts/environment-configuration
- ../concepts/score
- ../concepts/workload
- ../glossary
- /docs/concepts
- /docs/concepts/container
- /docs/concepts/environment-configuration
- /docs/concepts/score
- /docs/concepts/workload
- /docs/glossary
---

## What is Score?
Expand All @@ -28,7 +27,7 @@ The _Score implementation (CLI)_ is a conversion tool (such as score-compose or

Developers use the Score Specification to describe their Workload, including its resource and service dependencies.

Then they run a {{< glossary_tooltip text="Score Implementation (CLI)" term_id="score" >}} to generate required resources in an environment of choice.
Then they run a Score Implementation (CLI) to generate required resources in an environment of choice.

For example, the same Score Specification can be used to generate a docker compose file for local development, Kubernetes manifests for deployment to a shared development environment and to a serverless platform such as Google Cloud Run for integration tests.

Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/reference/score-cli/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: >

The _Score implementation (CLI)_ is a command-line tool used to interact with a Score Specification. Use a Score implementation (CLI) to transform your `score.yaml` file into multiple configuration files for the platform of your choice.

- [How to install the Score implementation (CLI)]({{< relref "/content/en/docs/Get started/install.md" >}} "Install")
- [How to install the Score implementation (CLI)]({{< relref "/docs/Get started/install.md" >}} "Install")
- [Set environment-specific configuration to run Workloads in a target environment]({{< relref "/docs/environment%20variables/_index.md" >}} "Set environment-specific configuration to run Workloads in a target environment.")

## The Score implementation (CLI)
Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/reference/score-spec-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ The Resource section of the Score Specification allows users to describe the rel

Resources can be anything and Score doesn't differentiate resources by types. The resource section can be used to provision multiservice setups with platforms like Docker Compose.

It is up to {{< glossary_tooltip text="Score implementation (CLI)" term_id="score" >}} to resolve the resource by name, type, or any other meta information available.
It is up to the Score implementation (CLI) to resolve the resource by name, type, or any other meta information available.

### Resources

Expand Down Expand Up @@ -194,7 +194,7 @@ service:

## Container definition

The {{< glossary_tooltip text="Workload" term_id="workload" >}} container’s specification describes how the Workload's tasks are executed.
The Workload container’s specification describes how the Workload's tasks are executed.

```yaml
image: string
Expand Down

0 comments on commit 67d49e6

Please sign in to comment.