Skip to content

Commit 4238c62

Browse files
committed
chore: add aliases, run formatter
Signed-off-by: David Karlsson <[email protected]>
1 parent 2e59bd4 commit 4238c62

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

80 files changed

+1463
-1218
lines changed

content/guides/_index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ description: Explore the Docker guides
55
params:
66
icon: developer_guide
77
layout: landing
8+
aliases:
9+
- /learning-paths/
810
---
911

1012
This section contains more advanced guides to help you learn how Docker can optimize your development workflows.

content/guides/cpp/_index.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ summary: |
1010
toc_min: 1
1111
toc_max: 2
1212
aliases:
13-
- /language/cpp/
13+
- /language/cpp/
14+
- /guides/language/cpp/
1415
languages: [cpp]
1516
levels: [beginner]
1617
params:
@@ -23,10 +24,10 @@ The C++ getting started guide teaches you how to create a containerized C++ appl
2324
>
2425
> Docker would like to thank [Pradumna Saraf](https://twitter.com/pradumna_saraf) for his contribution to this guide.
2526
26-
* Containerize and run a C++ application
27-
* Set up a local environment to develop a C++ application using containers
28-
* Configure a CI/CD pipeline for a containerized C++ application using GitHub Actions
29-
* Deploy your containerized application locally to Kubernetes to test and debug your deployment
27+
- Containerize and run a C++ application
28+
- Set up a local environment to develop a C++ application using containers
29+
- Configure a CI/CD pipeline for a containerized C++ application using GitHub Actions
30+
- Deploy your containerized application locally to Kubernetes to test and debug your deployment
3031

3132
After completing the C++ getting started modules, you should be able to containerize your own C++ application based on the examples and instructions provided in this guide.
3233

content/guides/cpp/configure-ci-cd.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@ weight: 40
55
keywords: ci/cd, github actions, c++, shiny
66
description: Learn how to configure CI/CD using GitHub Actions for your C++ application.
77
aliases:
8-
- /language/cpp/configure-ci-cd/
8+
- /language/cpp/configure-ci-cd/
9+
- /guides/language/cpp/configure-ci-cd/
910
---
1011

1112
## Prerequisites
@@ -69,27 +70,24 @@ to Docker Hub.
6970

7071
```yaml
7172
name: ci
72-
73+
7374
on:
7475
push:
7576
branches:
7677
- main
77-
78+
7879
jobs:
7980
build:
8081
runs-on: ubuntu-latest
8182
steps:
82-
-
83-
name: Login to Docker Hub
83+
- name: Login to Docker Hub
8484
uses: docker/login-action@v3
8585
with:
8686
username: ${{ vars.DOCKER_USERNAME }}
8787
password: ${{ secrets.DOCKERHUB_TOKEN }}
88-
-
89-
name: Set up Docker Buildx
88+
- name: Set up Docker Buildx
9089
uses: docker/setup-buildx-action@v3
91-
-
92-
name: Build and push
90+
- name: Build and push
9391
uses: docker/build-push-action@v6
9492
with:
9593
platforms: linux/amd64,linux/arm64
@@ -123,8 +121,9 @@ Save the workflow file and run the job.
123121
In this section, you learned how to set up a GitHub Actions workflow for your C++ application.
124122

125123
Related information:
126-
- [Introduction to GitHub Actions](/manuals/build/ci/github-actions/_index.md)
127-
- [Workflow syntax for GitHub Actions](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions)
124+
125+
- [Introduction to GitHub Actions](/manuals/build/ci/github-actions/_index.md)
126+
- [Workflow syntax for GitHub Actions](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions)
128127

129128
## Next steps
130129

content/guides/cpp/containerize.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,13 @@ weight: 10
55
keywords: C++, containerize, initialize
66
description: Learn how to containerize a C++ application.
77
aliases:
8-
- /language/cpp/containerize/
8+
- /language/cpp/containerize/
9+
- /guides/language/cpp/containerize/
910
---
1011

1112
## Prerequisites
1213

13-
* You have a [Git client](https://git-scm.com/downloads). The examples in this section use a command-line based Git client, but you can use any client.
14+
- You have a [Git client](https://git-scm.com/downloads). The examples in this section use a command-line based Git client, but you can use any client.
1415

1516
## Overview
1617

@@ -38,9 +39,10 @@ directory.
3839
```
3940

4041
To learn more about the files in the repository, see the following:
41-
- [Dockerfile](/reference/dockerfile.md)
42-
- [.dockerignore](/reference/dockerfile.md#dockerignore-file)
43-
- [compose.yml](/reference/compose-file/_index.md)
42+
43+
- [Dockerfile](/reference/dockerfile.md)
44+
- [.dockerignore](/reference/dockerfile.md#dockerignore-file)
45+
- [compose.yml](/reference/compose-file/_index.md)
4446

4547
## Run the application
4648

@@ -67,7 +69,6 @@ $ docker compose up --build -d
6769

6870
Open a browser and view the application at [http://localhost:8080](http://localhost:8080).
6971

70-
7172
In the terminal, run the following command to stop the application.
7273

7374
```console
@@ -83,7 +84,8 @@ In this section, you learned how you can containerize and run your C++
8384
application using Docker.
8485

8586
Related information:
86-
- [Docker Compose overview](/manuals/compose/_index.md)
87+
88+
- [Docker Compose overview](/manuals/compose/_index.md)
8789

8890
## Next steps
8991

content/guides/cpp/deploy.md

Lines changed: 21 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@ weight: 50
55
keywords: deploy, kubernetes, c++
66
description: Learn how to develop locally using Kubernetes
77
aliases:
8-
- /language/cpp/deploy/
8+
- /language/cpp/deploy/
9+
- /guides/language/cpp/deploy/
910
---
1011

1112
## Prerequisites
@@ -42,9 +43,9 @@ spec:
4243
service: ok-api
4344
spec:
4445
containers:
45-
- name: ok-api-service
46-
image: DOCKER_USERNAME/REPO_NAME
47-
imagePullPolicy: Always
46+
- name: ok-api-service
47+
image: DOCKER_USERNAME/REPO_NAME
48+
imagePullPolicy: Always
4849
---
4950
apiVersion: v1
5051
kind: Service
@@ -56,21 +57,21 @@ spec:
5657
selector:
5758
service: ok-api
5859
ports:
59-
- port: 8080
60-
targetPort: 8080
61-
nodePort: 30001
60+
- port: 8080
61+
targetPort: 8080
62+
nodePort: 30001
6263
```
6364
6465
In this Kubernetes YAML file, there are two objects, separated by the `---`:
6566

66-
- A Deployment, describing a scalable group of identical pods. In this case,
67-
you'll get just one replica, or copy of your pod. That pod, which is
68-
described under `template`, has just one container in it. The
69-
container is created from the image built by GitHub Actions in [Configure CI/CD for
70-
your C++ application](configure-ci-cd.md).
71-
- A NodePort service, which will route traffic from port 30001 on your host to
72-
port 8080 inside the pods it routes to, allowing you to reach your app
73-
from the network.
67+
- A Deployment, describing a scalable group of identical pods. In this case,
68+
you'll get just one replica, or copy of your pod. That pod, which is
69+
described under `template`, has just one container in it. The
70+
container is created from the image built by GitHub Actions in [Configure CI/CD for
71+
your C++ application](configure-ci-cd.md).
72+
- A NodePort service, which will route traffic from port 30001 on your host to
73+
port 8080 inside the pods it routes to, allowing you to reach your app
74+
from the network.
7475

7576
To learn more about Kubernetes objects, see the [Kubernetes documentation](https://kubernetes.io/docs/home/).
7677

@@ -133,9 +134,10 @@ To learn more about Kubernetes objects, see the [Kubernetes documentation](https
133134

134135
## Summary
135136

136-
In this section, you learned how to use Docker Desktop to deploy your C++ application to a fully-featured Kubernetes environment on your development machine.
137+
In this section, you learned how to use Docker Desktop to deploy your C++ application to a fully-featured Kubernetes environment on your development machine.
137138

138139
Related information:
139-
- [Kubernetes documentation](https://kubernetes.io/docs/home/)
140-
- [Deploy on Kubernetes with Docker Desktop](/manuals/desktop/kubernetes.md)
141-
- [Swarm mode overview](/manuals/engine/swarm/_index.md)
140+
141+
- [Kubernetes documentation](https://kubernetes.io/docs/home/)
142+
- [Deploy on Kubernetes with Docker Desktop](/manuals/desktop/kubernetes.md)
143+
- [Swarm mode overview](/manuals/engine/swarm/_index.md)

content/guides/cpp/develop.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@ weight: 20
55
keywords: C++, local, development
66
description: Learn how to develop your C++ application locally.
77
aliases:
8-
- /language/cpp/develop/
8+
- /language/cpp/develop/
9+
- /guides/language/cpp/develop/
910
---
1011

1112
## Prerequisites
@@ -66,9 +67,10 @@ Press `ctrl+c` in the terminal to stop your application.
6667
In this section, you also learned how to use Compose Watch to automatically rebuild and run your container when you update your code.
6768

6869
Related information:
69-
- [Compose file reference](/reference/compose-file/)
70-
- [Compose file watch](/manuals/compose/how-tos/file-watch.md)
71-
- [Multi-stage builds](/manuals/build/building/multi-stage.md)
70+
71+
- [Compose file reference](/reference/compose-file/)
72+
- [Compose file watch](/manuals/compose/how-tos/file-watch.md)
73+
- [Multi-stage builds](/manuals/build/building/multi-stage.md)
7274

7375
## Next steps
7476

0 commit comments

Comments
 (0)