Merge branch 'main' into VCUE-706_polish-ce-doc

Author: bcumming

docs/alps/storage.md

@@ -3,9 +3,8 @@
 
 !!! under-construction
 
-Alps has different storage attached, each with characteristics suited to different workloads and use cases.
-HPC storage is managed in a separate cluster of nodes that host servers that manage the storage and the physical storage drives.
-These separate storage clusters are on the same Slingshot 11 network as Alps.
+The Alps infrastructure offers multiple storage solutions, each with characteristics suited to different workloads and use cases.
+HPC storage is provided by independent clusters, composed of servers and physical storage drives.
 
 |              | Capstor                | Iopsstor               | VAST                |
 |--------------|------------------------|------------------------|---------------------|
@@ -18,29 +17,25 @@ These separate storage clusters are on the same Slingshot 11 network as Alps.
 | IOPs         | 1.5M                   | 8.6M read, 24M write   | 200k read, 768k write |
 | file create/s| 374k                   | 214k                   | 97k                 |
 
-
-!!! todo
-    Information about Lustre. Meta data servers, etc.
-
-    * how many meta data servers on Capstor and Iopsstor
-    * how these are distributed between store/scratch
-
-    Also discuss how Capstor and iopstor are used to provide both scratch / store / other file systems
+Capstor and Iopsstor are on the same Slingshot network as Alps, while VAST is on the CSCS Ethernet network.
 
 The mounts, and how they are used for Scratch, Store, and Home file systems that are mounted on clusters are documented in the [file system docs][ref-storage-fs].
 
 [](){#ref-alps-capstor}
 ## Capstor
 
-Capstor is the largest file system, for storing large amounts of input and output data.
+Capstor is the largest file system, and it is meant for storing large amounts of input and output data.
 It is used to provide [scratch][ref-storage-scratch] and [store][ref-storage-store].
 
-!!! todo "add information about meta data services, and their distribution over scratch and store"
+Capstor has 80 Object Storage Servers ([OSS](https://wiki.lustre.org/Lustre_Object_Storage_Service_(OSS))), and 6 Metadata Servers ([MDS](https://wiki.lustre.org/Lustre_Metadata_Service_(MDS))). 
+Two of of these Metadata servers are dedicated for Store, and the remaining four are dedicated for Scratch.
 
 [](){#ref-alps-capstor-scratch}
 ### Scratch
 
 All users on Alps get their own scratch path on Alps, `/capstor/scratch/cscs/$USER`.
+Since Capstor OSSs are made of HDDs, Capstor is a storage well suited for jobs which perform large sequential and parallel read/write operations.
+See the [Scratch documentation][ref-storage-scratch] for more information.
 
 [](){#ref-alps-capstor-store}
 ### Store
@@ -51,15 +46,18 @@ It is mounted on clusters at the `/capstor/store` mount point, with folders crea
 [](){#ref-alps-iopsstor}
 ## Iopsstor
 
-!!! todo
-    small text explaining what Iopsstor is designed to be used for.
+Iopsstor is a smaller filesystem compared to Capstor, but it leverages high-performance NVMe drives, which offer significantly better speed and responsiveness than traditional HDDs.
+It is primarily used as a scratch space, and it is optimized for IOPS-intensive workloads. 
+This makes it particularly well-suited for applications that involve frequent, random read and write operations within files.
+
+Iopsstor has has 20 OSSs, and 2 MDSs. 
 
 [](){#ref-alps-vast}
 ## VAST
 
 The VAST storage is smaller capacity system that is designed for use as [Home][ref-storage-home] folders.
 
 !!! todo
-    small text explaining what Iopsstor is designed to be used for.
+    small text explaining what VAST is designed to be used for.
 
 

docs/software/uenv/build.md

@@ -26,8 +26,8 @@ uenv build <recipe> <label>
     uenv build $SCRATCH/recipes/myapp myapp/v3@daint%gh200
     ```
 
-    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.
-    After a successful build, the uenv can be pulled using an address from the status page:
+    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.
+    After a successful build, the uenv can be pulled using a name from the status page:
 
     ```bash
     uenv image pull service::myapp/v3:1669479716

docs/software/uenv/configure.md

@@ -56,5 +56,5 @@ The default repo location for downloaded uenv images.
 The repo is selected according to the following process:
 
 * if the `--repo` CLI arguement overrides 
-* else if `color` is set in the config file, use that setting
+* else if `repo` is set in the config file, use that setting
 * else use the default value of `$SCRATCH/.uenv-images`

docs/software/uenv/deploy.md

@@ -2,7 +2,7 @@
 # Deploying uenv
 
 [](){#ref-uenv-deploy-versions}
-## Versioning and Labeling
+## Versioning and labeling
 
 Uenv images have a **label** of the following form:
 
@@ -57,7 +57,7 @@ The node type (microarchitecture) that the uenv is built for.
 
 ## Registries
 
-The following naming scheme is employed in the OCI container artifactory for uenv images:
+The following naming scheme is employed in the OCI container registry for uenv images:
 
 ```text
 namespace/system/uarch/name/version:tag
@@ -92,11 +92,11 @@ Specific uenv recipes are stored in `recipes/name/version/uarch/`.
 
 The `cluster` is specified when building and deploying the uenv, while the `tag` is specified when deploying the uenv.
 
-## uenv Deployment
+## uenv deployment
 
-### Deployment Rules
+### Deployment rules
 
-A recipe can be built for deployment on different vClusters, and for multiple targets.
+A recipe can be built for deployment on different clusters, and for multiple targets.
 For example:
 
 * A multicore recipe could be built for `zen2` or `zen3` nodes
@@ -154,15 +154,15 @@ uenv image copy build::<SOURCE> deploy::<DESTINATION> # (1)!
 
 1. `<DESTINATION>` must be fully qualified.
 
-!!! example "Deploy Using Image ID"
+!!! example "Deploy using image ID"
 
     Deploy a uenv from `build::` using the ID of the image:
 
     ```bash
     uenv image copy build::d2afc254383cef20 deploy::prgenv-nvfortran/24.11:v1@daint%gh200
     ```
 
-!!! example "Deploy Using Qualified Name"
+!!! example "Deploy using qualified name"
 
     Deploy a uenv using the qualified name:
 
@@ -174,7 +174,7 @@ uenv image copy build::<SOURCE> deploy::<DESTINATION> # (1)!
 
         The build image uses the CI/CD pipeline ID as the tag. You will need to choose an appropriate tag.
 
-!!! example "Deploy a uenv from One vCluster to Another"
+!!! example "Deploy a uenv from one cluster to another"
 
     You can also deploy a uenv from one vCluster to another.
     For example, if the `uenv` for `prgenv-gnu` has been deployed on `daint`,

docs/software/uenv/index.md

@@ -52,14 +52,14 @@ $ uenv --version
 
 On Alps clusters the most recent version 8.1.0 is installed.
 
-??? warning "out of date uenv version on Eiger and Balfrin"
+??? warning "Out of date uenv version on Eiger and Balfrin"
 
     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.
 
     !!! note
         This note only applies to the current `eigen.cscs.ch` deployment.
 
-        The new [`eigen.alps.cscs.ch`][ref-cluster-eiger] deployment has version 8.1.0 of uenv installed.
+        The new [`eiger.alps.cscs.ch`][ref-cluster-eiger] deployment has version 8.1.0 of uenv installed.
 
     Please refer to `uenv --help` for the correct usage on these systems.
 
@@ -98,7 +98,7 @@ The available uenv images are stored in a registry, that can be queried using th
 The output above lists all of the uenv that are available on the current system ([Eiger][ref-cluster-eiger] in this case).
 The search can be refined by providing a [label][ref-uenv-labels].
 
-??? example "using labels to refine search"
+??? example "Using labels to refine search"
     ```bash
     # find all uenv with name prgenv-gnu
     uenv image find prgenv-gnu
@@ -117,7 +117,7 @@ The search can be refined by providing a [label][ref-uenv-labels].
     ```
 
 !!! info
-    All uenv commands that take a [label][ref-uenv-labels] as an arguement use the same flexible syntax [label descriptions][ref-uenv-labels-examples].
+    All uenv commands that take a [label][ref-uenv-labels] as an argument use the same flexible syntax [label descriptions][ref-uenv-labels-examples].
 
 ## Downloading uenv
 
@@ -527,7 +527,7 @@ echo "unset -f uenv" >> $HOME/.bashrc
     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.
 
 [](){#ref-uenv-labels}
-## uenv Labels
+## uenv labels
 
 Uenv are referred to using **labels**, where a label has the following form
 

docs/storage/filesystems.md

@@ -10,7 +10,7 @@
 
 -   :fontawesome-solid-hard-drive: __File Systems__
 
-    There are three *types* of file system that provided on Alps clusters:
+    There are three *types* of file system that are provided on Alps clusters:
 
     |                               |    [backups][ref-storage-backups]  |  [snapshot][ref-storage-snapshots]  |   [cleanup][ref-storage-cleanup]   |    access |
     | ---------                     | ---------- | ---------- | ----------- | --------- |
@@ -225,8 +225,6 @@ If you are in multiple projects, information for the [Store][ref-storage-store]
     ```console
     $ ssh [email protected]
     $ quota
-    checking your quota
-
     Retrieving data ...
 
     User: user
@@ -332,7 +330,7 @@ In addition to the automatic deletion of old files, if occupancy exceeds 60% the
 ## Frequently asked questions
 
 ??? question "My files are gone, but the directories are still there"
-    When the [cleanup policy][ref-storage-cleanup] is applied on LUSTRE file systems, the files are removed, but the directories remain.
+    When the [cleanup policy][ref-storage-cleanup] is applied on Lustre file systems, the files are removed, but the directories remain.
 
 ??? question "What do messages like `mkdir: cannot create directory 'test': Disk quota exceeded` mean?"
     You have run out of quota on the target file system.