Skip to content

Commit 0c98caa

Browse files
simplify getting started and pointers to new examples hub (#204)
Signed-off-by: Mathieu Benoit <mathieu-benoit@hotmail.fr>
1 parent d22c805 commit 0c98caa

9 files changed

Lines changed: 15 additions & 94 deletions

File tree

content/en/docs/How to/score-k8s/kind-cluster.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,5 +96,5 @@ score-k8s init \
9696

9797
## Next steps
9898

99-
- [**Explore more examples**](/docs/examples/): Check out more examples to dive into further use cases and experiment with different configurations.
99+
- [**Explore more examples**](/examples/): Check out more examples to dive into further use cases and experiment with different configurations.
100100
- [**Join the Score community**]({{< relref "/docs/community" >}}): Connect with fellow Score developers on our CNCF Slack channel or start find your way to contribute to Score.

content/en/docs/examples/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,6 @@ aliases:
1111
- /docs/how-to/environment-variables/
1212
---
1313

14-
Explore a variety of examples of Score files illustrating different features from the Score specification as well as including resources provisioning. You can find these examples in our [examples library](https://github.com/score-spec/examples).
14+
Explore a variety of examples of Score files illustrating different features from the Score specification as well as including resources provisioning. You can find these examples in our [Examples Hub](/examples/).
1515

16-
In addition to this, you can find more advanced and real-world scenarios in the list below:
16+
In addition to this, you can find more advanced and real-world scenarios in this list below:

content/en/docs/examples/backstage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,5 +77,5 @@ From here, we will now see how to deploy this exact same Score file with either
7777

7878
- [**Deploy this Backstage application into two different Frontend and Backend applications**](/docs/examples/frontend-and-backend.md): Follow the same example where this Backstage application is broken down into two containerized applications: Frontend & Backend.
7979
- [**Deep dive with the associated step-by-step guide**](https://medium.com/@mabenoit/deploy-backstage-with-score-45bb2d7c2d90): Go through the associated step-by-step guide to understand the different concepts with both: Backstage and Score.
80-
- [**Explore more examples**](/docs/examples/): Check out more examples to dive into further use cases and experiment with different configurations.
80+
- [**Explore more examples**](/examples/): Check out more examples to dive into further use cases and experiment with different configurations.
8181
- [**Join the Score community**]({{< relref "/docs/community" >}}): Connect with fellow Score developers on our CNCF Slack channel or start find your way to contribute to Score.

content/en/docs/examples/dapr.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,6 @@ From here, we will now see how to deploy this exact same Score file with either
6666

6767
## Next steps
6868

69-
- [**Explore more examples**](/docs/examples/): Check out more examples to dive into further use cases and experiment with different configurations.
69+
- [**Explore more examples**](/examples/): Check out more examples to dive into further use cases and experiment with different configurations.
7070
- [**Watch the Dapr + Score session at KubeCon EU 2025**](https://sched.co/1txGi): Mixing the Perfect Cocktail for an Enhanced Developer Experience ([video](https://youtu.be/-fGztPUuD8k?list=PLj6h78yzYM2MP0QhYFK8HOb8UqgbIkLMc) and [repository](https://github.com/kendallroden/kubecon-dapr-score-demo)), showing more advanced use cases with Dapr PubSub and Dapr Workflow.
7171
- [**Join the Score community**]({{< relref "/docs/community" >}}): Connect with fellow Score developers on our CNCF Slack channel or start find your way to contribute to Score.

content/en/docs/examples/frontend-and-backend.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,5 +131,5 @@ From here, we will now see how to deploy these exact same Score files with eithe
131131
## Next steps
132132

133133
- [**Deep dive with the associated step-by-step guide**](https://medium.com/@mabenoit/deploy-backstage-with-score-45bb2d7c2d90): Go through the associated step-by-step guide to understand the different concepts with both: Backstage and Score.
134-
- [**Explore more examples**](/docs/examples/): Check out more examples to dive into further use cases and experiment with different configurations.
134+
- [**Explore more examples**](/examples/): Check out more examples to dive into further use cases and experiment with different configurations.
135135
- [**Join the Score community**]({{< relref "/docs/community" >}}): Connect with fellow Score developers on our CNCF Slack channel or start find your way to contribute to Score.

content/en/docs/examples/microservices.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,5 +153,5 @@ From here, we will now see how to deploy this exact same Score files with either
153153

154154
## Next steps
155155

156-
- [**Explore more examples**](/docs/examples/): Check out more examples to dive into further use cases and experiment with different configurations.
156+
- [**Explore more examples**](/examples/): Check out more examples to dive into further use cases and experiment with different configurations.
157157
- [**Join the Score community**]({{< relref "/docs/community" >}}): Connect with fellow Score developers on our CNCF Slack channel or start find your way to contribute to Score.

content/en/docs/examples/nginx.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,5 +89,5 @@ From here, we will now see how to deploy this exact same Score file with either
8989

9090
## Next steps
9191

92-
- [**Explore more examples**](/docs/examples/): Check out more examples to dive into further use cases and experiment with different configurations.
92+
- [**Explore more examples**](/examples/): Check out more examples to dive into further use cases and experiment with different configurations.
9393
- [**Join the Score community**]({{< relref "/docs/community" >}}): Connect with fellow Score developers on our CNCF Slack channel or start find your way to contribute to Score.

content/en/docs/examples/nodejs-postgres.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,5 +66,5 @@ From here, we will now see how to deploy this exact same Score file with either
6666

6767
## Next steps
6868

69-
- [**Explore more examples**](/docs/examples/): Check out more examples to dive into further use cases and experiment with different configurations.
69+
- [**Explore more examples**](/examples/): Check out more examples to dive into further use cases and experiment with different configurations.
7070
- [**Join the Score community**]({{< relref "/docs/community" >}}): Connect with fellow Score developers on our CNCF Slack channel or start find your way to contribute to Score.

content/en/docs/get started/_index.md

Lines changed: 6 additions & 85 deletions
Original file line numberDiff line numberDiff line change
@@ -55,29 +55,7 @@ Initialize your current `score-compose` workspace, run the following command in
5555
score-compose init --no-sample
5656
```
5757

58-
The `init` command will create the `.score-compose` directory with the [default resource provisioners]({{< relref "/docs/score-implementation/score-compose/resources-provisioners/" >}}) available. You can learn more about the resource provisioners available by running this command:
59-
60-
```bash
61-
score-compose provisioners list
62-
```
63-
64-
The Score file example illustrated uses three resource types: `postgres`, `dns` and `route`.
65-
66-
```none
67-
+---------------+-------+------------------+--------------------------------+---------------------------------+
68-
| TYPE | CLASS | PARAMS | OUTPUTS | DESCRIPTION |
69-
+---------------+-------+------------------+--------------------------------+---------------------------------+
70-
| dns | (any) | | host | Outputs a *.localhost domain |
71-
| | | | | as the hostname |
72-
+---------------+-------+------------------+--------------------------------+---------------------------------+
73-
| postgres | (any) | | database, host, name, | Provisions a dedicated |
74-
| | | | password, port, username | database on a shared PostgreSQL |
75-
| | | | | instance |
76-
+---------------+-------+------------------+--------------------------------+---------------------------------+
77-
| route | (any) | host, path, port | | Provisions an Ingress route on |
78-
| | | | | a shared Nginx instance |
79-
+---------------+-------+------------------+--------------------------------+---------------------------------+
80-
```
58+
The `init` command will create the `.score-compose` directory with the [default resource provisioners]({{< relref "/docs/score-implementation/score-compose/resources-provisioners/" >}}) available.
8159

8260
## 4. `score-compose generate`
8361

@@ -89,69 +67,13 @@ score-compose generate score.yaml --image ghcr.io/score-spec/sample-app-gif:main
8967

9068
The `generate` command will add the input `score.yaml` workload with a particular container image to the `.score-compose/state.yaml` state file and generate the output `compose.yaml`.
9169

92-
If you want to build the container image when this `compose.yaml` will be deployed, you can run this `generate` command with the `--build` parameter instead:
93-
94-
```bash
95-
score-compose generate score.yaml --build 'main={"context":".","tags":["sample-app-gif:local"]}'
96-
```
97-
9870
See the generated `compose.yaml` by running this command:
9971

10072
```bash
10173
cat compose.yaml
10274
```
10375

104-
If you make any modifications to the `score.yaml` file, run `score-compose generate score.yaml` to regenerate the output `compose.yaml`.
105-
106-
## 5. `score-compose resources`
107-
108-
Get the information of the resources dependencies of the workload, run the following command:
109-
110-
```bash
111-
score-compose resources list
112-
```
113-
114-
```none
115-
+----------------------------+--------------------------------+
116-
| UID | OUTPUTS |
117-
+----------------------------+--------------------------------+
118-
| dns.default#sample.dns | host |
119-
+----------------------------+--------------------------------+
120-
| postgres.default#sample.db | database, host, name, |
121-
| | password, port, username |
122-
+----------------------------+--------------------------------+
123-
| route.default#sample.route | |
124-
+----------------------------+--------------------------------+
125-
```
126-
127-
At this stage, we can already see the value of the `dns` resource generated:
128-
129-
```bash
130-
score-compose resources get-outputs dns.default#sample.dns --format '{{ .host }}'
131-
```
132-
133-
```none
134-
dnsbcsqnd.localhost
135-
```
136-
137-
Same for the `postgres` resource:
138-
139-
```bash
140-
score-compose resources get-outputs postgres.default#sample.db
141-
```
142-
143-
```none
144-
{
145-
"database": "db-cHqToKGM",
146-
"host": "pg-l1fFqm",
147-
"name": "db-cHqToKGM",
148-
"password": "REDACTED",
149-
"port": 5432,
150-
"username": "REDACTED"
151-
}
152-
```
153-
154-
## 6. `docker compose up`
76+
## 5. `docker compose up`
15577

15678
Run `docker compose up` to execute the generated `compose.yaml` file:
15779

@@ -168,7 +90,7 @@ docker compose up -d
16890
✔ Container test-sample-main-1 Started
16991
```
17092

171-
## 7. `docker ps`
93+
## 6. `docker ps`
17294

17395
See the running containers:
17496

@@ -183,12 +105,12 @@ e4bdd0126d97 mirror.gcr.io/postgres:17-alpine "docker-entrypoin
183105
a03dfeea3371 mirror.gcr.io/nginx:1-alpine "/docker-entrypoint.…" 3 hours ago Up About a minute 0.0.0.0:8080->80/tcp, [::]:8080->80/tcp test-routing-avhAWY-1
184106
```
185107

186-
## 8. `curl localhost:8080`
108+
## 7. `curl localhost:8080`
187109

188110
Test the running container, run the following command:
189111

190112
```bash
191-
curl localhost:8080 -H "Host: dnsbcsqnd.localhost"
113+
curl localhost:8080
192114
```
193115

194116
```none
@@ -199,6 +121,5 @@ Congrats! You’ve successfully deploy your first Score file with the `score-com
199121

200122
## Next steps
201123

202-
- [**Try other implementations**](/docs/score-implementation/): Continue by deploying the same Score file used in the example above via the `score-k8s` CLI to generate Kubernetes manifests.
203-
- [**Explore more examples**](/docs/examples/): Check out more examples to dive into further use cases and experiment with different configurations.
124+
- [**Explore more examples**](/examples/): Check out more examples to dive into further use cases and experiment with different configurations.
204125
- [**Join the Score community**]({{< relref "/docs/community" >}}): Connect with fellow Score developers on our CNCF Slack channel or start find your way to contribute to Score.

0 commit comments

Comments
 (0)