Skip to content

Commit 6efd9b1

Browse files
authored
Minor style and typo fixes to uenv documentation (#131)
1 parent a76644e commit 6efd9b1

File tree

4 files changed

+16
-16
lines changed

4 files changed

+16
-16
lines changed

docs/software/uenv/build.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ uenv build <recipe> <label>
2626
uenv build $SCRATCH/recipes/myapp myapp/v3@daint%gh200
2727
```
2828

29-
The output of the above command will print a url that links to a status page, for you to follow the progress of the build.
30-
After a successful build, the uenv can be pulled using an address from the status page:
29+
The output of the above command will print a URL that links to a status page where you can follow the progress of the build.
30+
After a successful build, the uenv can be pulled using a name from the status page:
3131

3232
```bash
3333
uenv image pull service::myapp/v3:1669479716

docs/software/uenv/configure.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,5 +56,5 @@ The default repo location for downloaded uenv images.
5656
The repo is selected according to the following process:
5757

5858
* if the `--repo` CLI arguement overrides
59-
* else if `color` is set in the config file, use that setting
59+
* else if `repo` is set in the config file, use that setting
6060
* else use the default value of `$SCRATCH/.uenv-images`

docs/software/uenv/deploy.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
# Deploying uenv
33

44
[](){#ref-uenv-deploy-versions}
5-
## Versioning and Labeling
5+
## Versioning and labeling
66

77
Uenv images have a **label** of the following form:
88

@@ -57,7 +57,7 @@ The node type (microarchitecture) that the uenv is built for.
5757

5858
## Registries
5959

60-
The following naming scheme is employed in the OCI container artifactory for uenv images:
60+
The following naming scheme is employed in the OCI container registry for uenv images:
6161

6262
```text
6363
namespace/system/uarch/name/version:tag
@@ -92,11 +92,11 @@ Specific uenv recipes are stored in `recipes/name/version/uarch/`.
9292

9393
The `cluster` is specified when building and deploying the uenv, while the `tag` is specified when deploying the uenv.
9494

95-
## uenv Deployment
95+
## uenv deployment
9696

97-
### Deployment Rules
97+
### Deployment rules
9898

99-
A recipe can be built for deployment on different vClusters, and for multiple targets.
99+
A recipe can be built for deployment on different clusters, and for multiple targets.
100100
For example:
101101

102102
* A multicore recipe could be built for `zen2` or `zen3` nodes
@@ -154,15 +154,15 @@ uenv image copy build::<SOURCE> deploy::<DESTINATION> # (1)!
154154

155155
1. `<DESTINATION>` must be fully qualified.
156156

157-
!!! example "Deploy Using Image ID"
157+
!!! example "Deploy using image ID"
158158

159159
Deploy a uenv from `build::` using the ID of the image:
160160

161161
```bash
162162
uenv image copy build::d2afc254383cef20 deploy::prgenv-nvfortran/24.11:v1@daint%gh200
163163
```
164164

165-
!!! example "Deploy Using Qualified Name"
165+
!!! example "Deploy using qualified name"
166166

167167
Deploy a uenv using the qualified name:
168168

@@ -174,7 +174,7 @@ uenv image copy build::<SOURCE> deploy::<DESTINATION> # (1)!
174174

175175
The build image uses the CI/CD pipeline ID as the tag. You will need to choose an appropriate tag.
176176

177-
!!! example "Deploy a uenv from One vCluster to Another"
177+
!!! example "Deploy a uenv from one cluster to another"
178178

179179
You can also deploy a uenv from one vCluster to another.
180180
For example, if the `uenv` for `prgenv-gnu` has been deployed on `daint`,

docs/software/uenv/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -52,14 +52,14 @@ $ uenv --version
5252

5353
On Alps clusters the most recent version 8.1.0 is installed.
5454

55-
??? warning "out of date uenv version on Eiger and Balfrin"
55+
??? warning "Out of date uenv version on Eiger and Balfrin"
5656

5757
The uenv tool available on Eiger and Balfrin is a different version than the one described below, and some commands will be different to those documented here.
5858

5959
!!! note
6060
This note only applies to the current `eigen.cscs.ch` deployment.
6161

62-
The new [`eigen.alps.cscs.ch`][ref-cluster-eiger] deployment has version 8.1.0 of uenv installed.
62+
The new [`eiger.alps.cscs.ch`][ref-cluster-eiger] deployment has version 8.1.0 of uenv installed.
6363

6464
Please refer to `uenv --help` for the correct usage on these systems.
6565

@@ -98,7 +98,7 @@ The available uenv images are stored in a registry, that can be queried using th
9898
The output above lists all of the uenv that are available on the current system ([Eiger][ref-cluster-eiger] in this case).
9999
The search can be refined by providing a [label][ref-uenv-labels].
100100

101-
??? example "using labels to refine search"
101+
??? example "Using labels to refine search"
102102
```bash
103103
# find all uenv with name prgenv-gnu
104104
uenv image find prgenv-gnu
@@ -117,7 +117,7 @@ The search can be refined by providing a [label][ref-uenv-labels].
117117
```
118118

119119
!!! info
120-
All uenv commands that take a [label][ref-uenv-labels] as an arguement use the same flexible syntax [label descriptions][ref-uenv-labels-examples].
120+
All uenv commands that take a [label][ref-uenv-labels] as an argument use the same flexible syntax [label descriptions][ref-uenv-labels-examples].
121121

122122
## Downloading uenv
123123

@@ -527,7 +527,7 @@ echo "unset -f uenv" >> $HOME/.bashrc
527527
Before uenv can be used, you need to log out then back in again and type `which uenv` to verify that uenv has been installed in your `$HOME` path.
528528

529529
[](){#ref-uenv-labels}
530-
## uenv Labels
530+
## uenv labels
531531

532532
Uenv are referred to using **labels**, where a label has the following form
533533

0 commit comments

Comments
 (0)