Skip to content

Commit 9885971

Browse files
authored
Merge pull request #3367 from tgonzalezorlandoarm/main
Update learning_objectives for the Topo Templates LP + capitalization
2 parents 2811448 + 972cb8b commit 9885971

5 files changed

Lines changed: 22 additions & 22 deletions

File tree

content/learning-paths/cross-platform/create-your-own-topo-templates/_index.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Create your own Topo templates
2+
title: Create your own Topo Templates
33

44
draft: true
55
cascade:
@@ -12,17 +12,17 @@ minutes_to_complete: 30
1212
who_is_this_for: This is an introductory topic for embedded, edge, and cloud software developers who want to create their own Topo Templates projects to be natively deployed with Topo.
1313

1414
learning_objectives:
15-
- Install Topo and verify that the host and target environments are ready for deployment
16-
- Run health checks and generate a target description to identify compatible Arm processor features and templates
17-
- Clone a Topo template and deploy a containerized workload to an Arm-based Linux target
18-
- (Optional) Deploy firmware and applications to heterogeneous Cortex-A + Cortex-M devices using remoteproc-runtime
15+
- Explain the purpose and structure of a Topo Template
16+
- Clone and deploy an existing Topo Template to validate the Template workflow
17+
- Add clone-time arguments to customize a Topo Template
18+
- Create a new Topo Template from a Docker Compose project
19+
- Add x-topo metadata for configurable arguments, deployment guidance, and hardware requirements
1920

2021
prerequisites:
2122
- This learning path builds on [Deploy containerized workloads to Arm-based Linux targets with Topo](/learning-paths/cross-platform/deploy-containerized-workloads-with-topo/).
2223
- A host machine (x86 or Arm) with Linux, macOS, or Windows
23-
- An Arm-based Linux target accessible over SSH, for example an Arm-based Linux VM, Raspberry Pi, DGX Spark, or NXP i.MX 93
24+
- (Optional) An Arm-based Linux target accessible over SSH, for example an Arm-based Linux VM, Raspberry Pi, DGX Spark, or NXP i.MX 93
2425
- Docker installed on the host and target. For installation steps, see [Install Docker](/install-guides/docker/).
25-
- lscpu installed on the target (pre-installed on most Linux distributions)
2626
- Basic familiarity with containers and CLI tools
2727

2828
author: Tomas Agustin Gonzalez Orlando
@@ -52,7 +52,7 @@ shared_between:
5252

5353
further_reading:
5454
- resource:
55-
title: Topo template format
55+
title: Topo Template format
5656
link: https://github.com/arm/topo-template-format
5757
type: documentation
5858
- resource:

content/learning-paths/cross-platform/create-your-own-topo-templates/creating-a-new-template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ RUN sed -i "s|{{CARD_MESSAGE}}|${CARD_MESSAGE}|g" /usr/share/nginx/html/index.ht
109109
RUN sed -i "s|{{ACCENT_COLOR}}|${ACCENT_COLOR}|g" /usr/share/nginx/html/index.html
110110
```
111111

112-
Topo passes configuration values to templates through Docker build arguments. The `ARG` lines define the values consumed during the image build.
112+
Topo passes configuration values to Templates through Docker build arguments. The `ARG` lines define the values consumed during the image build.
113113

114114
### Create the compose file
115115

content/learning-paths/cross-platform/create-your-own-topo-templates/hello-world-template.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ List the available Topo Templates from the curated list in Topo:
1616
topo templates
1717
```
1818

19-
The output should be similar to the following, the Hello World template should be present:
19+
The output should be similar to the following, the Hello World Template should be present:
2020

2121
```output
2222
Hello World | https://github.com/Arm-Examples/topo-welcome.git | main
@@ -34,7 +34,7 @@ Lightbulb Moment | https://github.com/Arm-Examples/topo-lightbulb-moment.git | m
3434
(...)
3535
```
3636

37-
### Clone the Hello World template
37+
### Clone the Hello World Template
3838

3939
```bash
4040
topo clone https://github.com/Arm-Examples/topo-welcome.git

content/learning-paths/cross-platform/create-your-own-topo-templates/modifying-hello-world.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ layout: learningpathall
88

99
## Modify the Hello World Template
1010

11-
In the previous section, you cloned and deployed the Hello World Template. In this section, you will modify the template so the greeting emoji can be configured when someone clones the template.
11+
In the previous section, you cloned and deployed the Hello World Template. In this section, you will modify the Template so the greeting emoji can be configured when someone clones the Template.
1212

13-
### Add a new template argument
13+
### Add a new Template argument
1414

1515
Open the Hello World Template `compose.yaml` file:
1616

@@ -82,7 +82,7 @@ Open the HTML file used by the web application. Find the line with the hard-code
8282
<span class="emoji floating">🐳</span>
8383
```
8484

85-
Replace it with the `GREETING_EMOJI` template variable:
85+
Replace it with the `GREETING_EMOJI` Template variable:
8686

8787
```html
8888
<span class="emoji floating">{{GREETING_EMOJI}}</span>
@@ -114,21 +114,21 @@ RUN sed -i "s|{{GREETING_NAME}}|${GREETING_NAME}|" /usr/share/nginx/html/index.h
114114
RUN sed -i "s|{{GREETING_EMOJI}}|${GREETING_EMOJI}|" /usr/share/nginx/html/index.html
115115
```
116116

117-
### Clone the modified template
117+
### Clone the modified Template
118118

119-
Create a new directory for a fresh clone of your modified local template:
119+
Create a new directory for a fresh clone of your modified local Template:
120120

121121
```bash
122122
mkdir ../newdir/
123123
```
124124

125-
Clone the local template into the new directory:
125+
Clone the local Template into the new directory:
126126

127127
```bash
128128
topo clone dir:/home/tomgon01/eco/topo/playground/topo-welcome ../newdir/topo-welcome
129129
```
130130

131-
Topo prompts for the configured template arguments. You should now see prompts for both `GREETING_NAME` and `GREETING_EMOJI`. Use the example values, do not accept the defaults. When cloning completes, Topo creates the new project in `../newdir/topo-welcome`:
131+
Topo prompts for the configured Template arguments. You should now see prompts for both `GREETING_NAME` and `GREETING_EMOJI`. Use the example values, do not accept the defaults. When cloning completes, Topo creates the new project in `../newdir/topo-welcome`:
132132

133133
```output
134134
┌─ Copy files ──────────────────────────────────────────

content/learning-paths/cross-platform/create-your-own-topo-templates/overview.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ layout: learningpathall
88

99
## Get started
1010

11-
Before getting started, you should complete the Learning Path [Deploy containerized workloads to Arm-based Linux targets with Topo](/learning-paths/cross-platform/deploy-containerized-workloads-with-topo/) to learn about Topo, why to use it, how to install it and how to use it for target inspection, listing templates and deployment.
11+
Before getting started, you should complete the Learning Path [Deploy containerized workloads to Arm-based Linux targets with Topo](/learning-paths/cross-platform/deploy-containerized-workloads-with-topo/) to learn about Topo, why to use it, how to install it and how to use it for target inspection, listing Templates and deployment.
1212

1313
## What is Topo?
1414

@@ -28,8 +28,8 @@ Because the Topo Templates specification is an open one, anyone can publish thei
2828

2929
A curated list of example Templates can be found either via:
3030

31-
1. the [topo templates](https://github.com/arm/topo?tab=readme-ov-file#3-find-a-template) command or
32-
2. the [topo catalog](https://github.com/arm/topo/blob/main/internal/catalog/data/templates.json).
31+
1. the [Topo Templates](https://github.com/arm/topo?tab=readme-ov-file#3-find-a-template) command or
32+
2. the [Topo catalog](https://github.com/arm/topo/blob/main/internal/catalog/data/templates.json).
3333

3434
If you create your own Template, you can [Propose Your Template to Topo](https://github.com/arm/topo-template-format#propose-your-template-to-topo)
3535

@@ -47,4 +47,4 @@ You can then share your Topo Template with the community, who will be able to de
4747

4848
You have now installed Topo on your host and confirmed it is available.
4949
You have got an understanding of what a Topo Template is and what its purpose is.
50-
Next, you'll clone your first template and modify it.
50+
Next, you'll clone your first Template and modify it.

0 commit comments

Comments
 (0)