updated training materials for upcoming wis2box-1.0b8 (#110)

* Multi language with spanish examples (#109) * multi-language support * don't reference maaikelimper * simplify cheatsheet, replace b5 with b7 * add / for zip from site-host directory * remove yaml cheatsheet * remove ref yaml cheatsheet * avoid dated infomartion by referring to pilot phase * update dev * re-org and new sections * fix title skeleton content * latest changes for dev * updates for initializing wis2box * commit my work for thursday * bufr tools exercises move to wis2box-api * add placeholder for access-control exercise * rename * updated MQTT exercise * latest changes * update synop2bufr and monitoring exercises * commit all work in progress on dev * wip to dev * update mqtt-explorer changes * commit latest changes * commit WIP * upload WIP training materials * use different day for synop form exercise * add screenshot of downloader dashboard * commit WIP * ftp updates * remove data-mappings.yml * updates * updates * fix gts-header-mapping issues * added answers * various fixes, plus hide last 2 sections * add ftp commands, various fixes * add various updates --------- Co-authored-by: Tom Kralidis <[email protected]>
wmo-im · Sep 10, 2024 · 8a325cc · 8a325cc
1 parent 1496496
commit 8a325cc
Show file tree

Hide file tree

Showing 104 changed files with 2,491 additions and 1,595 deletions.
diff --git a/documentation/docs/assets/img/FTP-not-a-valid-path.png b/documentation/docs/assets/img/FTP-not-a-valid-path.png
diff --git a/documentation/docs/assets/img/csv2bufr-station-not-found.png b/documentation/docs/assets/img/csv2bufr-station-not-found.png
diff --git a/documentation/docs/assets/img/grafana_success.png b/documentation/docs/assets/img/grafana_success.png
diff --git a/documentation/docs/assets/img/minio-admin-create-new-path.png b/documentation/docs/assets/img/minio-admin-create-new-path.png
diff --git a/documentation/docs/assets/img/minio-admin-uploaded-file.png b/documentation/docs/assets/img/minio-admin-uploaded-file.png
diff --git a/documentation/docs/assets/img/minio-ui-create-new-path.png b/documentation/docs/assets/img/minio-ui-create-new-path.png
diff --git a/documentation/docs/assets/img/minio-ui-create-path.png b/documentation/docs/assets/img/minio-ui-create-path.png
diff --git a/documentation/docs/assets/img/minio-ui-upload-file.png b/documentation/docs/assets/img/minio-ui-upload-file.png
diff --git a/documentation/docs/assets/img/minio-ui.png b/documentation/docs/assets/img/minio-ui.png
diff --git a/documentation/docs/assets/img/minio-wis2box-incoming-dataset-folder.png b/documentation/docs/assets/img/minio-wis2box-incoming-dataset-folder.png
diff --git a/documentation/docs/assets/img/mqtt-explorer-global-broker-msg-origin.png b/documentation/docs/assets/img/mqtt-explorer-global-broker-msg-origin.png
diff --git a/documentation/docs/assets/img/mqtt-explorer-global-broker-msg-properties.png b/documentation/docs/assets/img/mqtt-explorer-global-broker-msg-properties.png
diff --git a/...entation/docs/assets/img/mqtt-explorer-global-broker-sub-origin-cache-synop.png b/...entation/docs/assets/img/mqtt-explorer-global-broker-sub-origin-cache-synop.png
diff --git a/documentation/docs/assets/img/mqtt-explorer-global-broker-sub-origin.png b/documentation/docs/assets/img/mqtt-explorer-global-broker-sub-origin.png
diff --git a/documentation/docs/assets/img/mqtt-explorer-sys-topic.png b/documentation/docs/assets/img/mqtt-explorer-sys-topic.png
diff --git a/documentation/docs/assets/img/mqtt-explorer-topics.png b/documentation/docs/assets/img/mqtt-explorer-topics.png
diff --git a/documentation/docs/assets/img/mqtt-explorer-wis2-notification-metadata.png b/documentation/docs/assets/img/mqtt-explorer-wis2-notification-metadata.png
diff --git a/documentation/docs/assets/img/mqtt-explorer-wis2box-broker-everyone-everyone.png b/documentation/docs/assets/img/mqtt-explorer-wis2box-broker-everyone-everyone.png
diff --git a/documentation/docs/assets/img/mqtt-explorer-wis2box-storage.png b/documentation/docs/assets/img/mqtt-explorer-wis2box-storage.png
diff --git a/documentation/docs/assets/img/popup-existing-dataset-id.png b/documentation/docs/assets/img/popup-existing-dataset-id.png
diff --git a/documentation/docs/assets/img/synop2bufr-ex2-success.png b/documentation/docs/assets/img/synop2bufr-ex2-success.png
diff --git a/documentation/docs/assets/img/synop2bufr-toggle.png b/documentation/docs/assets/img/synop2bufr-toggle.png
diff --git a/documentation/docs/assets/img/winbox-webapp-credentials.png b/documentation/docs/assets/img/winbox-webapp-credentials.png
diff --git a/documentation/docs/assets/img/winbox-webapp-options.png b/documentation/docs/assets/img/winbox-webapp-options.png
diff --git a/documentation/docs/assets/img/winscp-ftp-connection.png b/documentation/docs/assets/img/winscp-ftp-connection.png
diff --git a/documentation/docs/assets/img/winscp-student-vm-exercise-materials.png b/documentation/docs/assets/img/winscp-student-vm-exercise-materials.png
diff --git a/documentation/docs/assets/img/wis2-notification-metadata-links.png b/documentation/docs/assets/img/wis2-notification-metadata-links.png
diff --git a/documentation/docs/assets/img/wis2box-api-collections.png b/documentation/docs/assets/img/wis2box-api-collections.png
diff --git a/documentation/docs/assets/img/wis2box-api-discovery-metadata.png b/documentation/docs/assets/img/wis2box-api-discovery-metadata.png
diff --git a/documentation/docs/assets/img/wis2box-api.png b/documentation/docs/assets/img/wis2box-api.png
diff --git a/documentation/docs/assets/img/wis2box-create-new-dataset-form-initial.png b/documentation/docs/assets/img/wis2box-create-new-dataset-form-initial.png
diff --git a/documentation/docs/assets/img/wis2box-create-new-dataset.png b/documentation/docs/assets/img/wis2box-create-new-dataset.png
diff --git a/documentation/docs/assets/img/wis2box-data-mappings.png b/documentation/docs/assets/img/wis2box-data-mappings.png
diff --git a/documentation/docs/assets/img/wis2box-dataset-editor-new-dataset.png b/documentation/docs/assets/img/wis2box-dataset-editor-new-dataset.png
diff --git a/documentation/docs/assets/img/wis2box-grafana-ui.png b/documentation/docs/assets/img/wis2box-grafana-ui.png
diff --git a/documentation/docs/assets/img/wis2box-metadata-editor-part1.png b/documentation/docs/assets/img/wis2box-metadata-editor-part1.png
diff --git a/documentation/docs/assets/img/wis2box-metadata-editor-part2.png b/documentation/docs/assets/img/wis2box-metadata-editor-part2.png
diff --git a/documentation/docs/assets/img/wis2box-metadata-editor-part3.png b/documentation/docs/assets/img/wis2box-metadata-editor-part3.png
diff --git a/documentation/docs/assets/img/wis2box-metadata-validation-error.png b/documentation/docs/assets/img/wis2box-metadata-validation-error.png
diff --git a/documentation/docs/assets/img/wis2box-metadata-validation-success.png b/documentation/docs/assets/img/wis2box-metadata-validation-success.png
diff --git a/documentation/docs/assets/img/wis2box-minio-buckets.png b/documentation/docs/assets/img/wis2box-minio-buckets.png
diff --git a/documentation/docs/assets/img/wis2box-submit-dataset-success.png b/documentation/docs/assets/img/wis2box-submit-dataset-success.png
diff --git a/documentation/docs/assets/img/wis2box-ui-empty.png b/documentation/docs/assets/img/wis2box-ui-empty.png
diff --git a/documentation/docs/assets/img/wis2box-ui-new-dataset.png b/documentation/docs/assets/img/wis2box-ui-new-dataset.png
diff --git a/documentation/docs/assets/img/wis2box-webapp-menu.png b/documentation/docs/assets/img/wis2box-webapp-menu.png
diff --git a/documentation/docs/assets/img/wis2box-webapp-monitor.png b/documentation/docs/assets/img/wis2box-webapp-monitor.png
diff --git a/documentation/docs/assets/img/wis2downloader-dashboard.png b/documentation/docs/assets/img/wis2downloader-dashboard.png
diff --git a/documentation/docs/assets/tables/aws-minimal.csv b/documentation/docs/assets/tables/aws-minimal.csv
@@ -28,7 +28,7 @@
 "snow_depth","meters","Decimal","Snow depth at time of observation to 2 decimal places"
 "precipitation_intensity","kg m-2 h-1","Decimal","Intensity of precipitation at time of observation to 5 decimal places"
 "anemometer_height","meters","Decimal","Height of the anemometer above local ground  to 2 decimal place"
-"time_period_of_wind","minutes","Integer","Time period over which the wind speed and direction have been averegd. 10 minutes in normal cases or the number of minutes since a significant change occuring in the preceeding 10 minutes."
+"time_period_of_wind","minutes","Integer","Defines the time period over which the wind speed and direction have been averaged. Set to -10 to indicate a measurement period over the preceeding 10 minutes."
 "wind_direction","degrees","Integer","Wind direction (at anemometer height) averaged from the caterisan components over the indicated time period, 0 decimal places"
 "wind_speed","ms-1","Decimal","Wind speed (at anemometer height) averaged from the cartesian components over the indicated time period, 1 decimal place"
 "maximum_wind_gust_direction_10_minutes","degrees","Integer","Highest 3 second average over the preceeding 10 minutes, 0 decimal places"

diff --git a/documentation/docs/cheatsheets/docker.md b/documentation/docs/cheatsheets/docker.md
@@ -6,37 +6,26 @@ title: Docker cheatsheet
 
 ## Overview
 
-Docker allows for creating virtual envronments in an isolated manner in support
+Docker allows for creating virtual environments in an isolated manner in support
 of virtualization of computing resources.  The basic concept behind Docker is containerization,
 where software can run as services, interacting with other software containers, for example.
 
 The typical Docker workflow involves creating and building **images**, which are then run as live **containers**.
 
+Docker is used to run the suite of services that make up wis2box using pre-built images.
+
 ### Image management
 
 * List available images
 
 ```bash
-docker images
-```
-
-* Build an image from a Dockerfile:
-
-```bash
-cat << EOF > Dockerfile
-FROM ubuntu:latest
-
-RUN apt-get update
-RUN apt-get install –y nginx
-
-CMD ["echo", "Hello from my first Docker setup!"]
-EOF
+docker image ls
 ```
 
-* Building the image:
+* Update an image:
 
 ```bash
-docker build -t my-image:local .
+docker pull my-image:latest
 ```
 
 * Removing an image:
@@ -53,12 +42,6 @@ docker rmi my-image:local
 docker volume ls
 ```
 
-* Create a volume:
-
-```bash
-docker volume create my-volume
-```
-
 * Display detailed information on a volume:
 
 ```bash
@@ -79,12 +62,6 @@ docker volume prune
 
 ### Container Management
 
-* Create a container from an image, with an interactive terminal (`-it`) and a mounted volume (`v`):
-
-```bash
-docker run -it -v ${pwd}:/app my-image:local
-```
-
 * Display a list of currently running containers:
 
 ```bash
@@ -97,12 +74,6 @@ docker ps
 docker ps -a
 ```
 
-* Start a container:
-
-```bash
-docker start my-image:local  # starts a new container
-```
-
 * Enter the interactive terminal of a running container:
 
 

diff --git a/documentation/docs/cheatsheets/linux.md b/documentation/docs/cheatsheets/linux.md
@@ -79,6 +79,12 @@ touch foo.txt
 echo "hi there" > test-file.txt
 ```
 
+* View the contents of a file:
+
+```bash
+cat test-file.txt
+```
+
 * Copy a file:
 
 ```bash

diff --git a/documentation/docs/cheatsheets/wis2box.md b/documentation/docs/cheatsheets/wis2box.md
@@ -11,26 +11,6 @@ wis2box runs as a suite of Docker Compose commands.  The ``wis2box-ctl.py`` comm
 
 ## wis2box command essentials
 
-### Building
-
-* Build all of wis2box:
-
-```bash
-python3 wis2box-ctl.py build
-```
-
-* Build a specific wis2box Docker image:
-
-```bash
-python3 wis2box-ctl.py build wis2box-management
-```
-
-* Update wis2box:
-
-```bash
-python3 wis2box-ctl.py update
-```
-
 ### Starting and stopping
 
 * Start wis2box:
@@ -62,33 +42,3 @@ python3 wis2box-ctl.py login
 ```bash
 python3 wis2box-ctl.py login wis2box-api
 ```
-
-### Design time commands (metadata management and publishing)
-
-!!! note
-
-    You must be logged into the **wis2box-management** container to run the below commands
-
-* Publish discovery metadata:
-
-```bash
-wis2box metadata discovery publish /path/to/discovery-metadata-file.yml
-```
-
-* Publish station metadata:
-
-```bash
-wis2box metadata station publish-collection
-```
-
-* Add a dataset of observation collections from discovery metadata:
-
-```bash
-wis2box data add-collection /path/to/discovery-metadata-file.yml
-```
-
-* Ingest data into the **wis2box-incoming** bucket to trigger processing and publishing:
-
-```bash
-wis2box data ingest --topic-hierarchy topic.hierarchy.path --path /path/to/directory/of/data/files
-```
diff --git a/documentation/docs/cheatsheets/yaml.md b/documentation/docs/cheatsheets/yaml.md
diff --git a/documentation/docs/index.md → documentation/docs/index.en.md b/documentation/docs/index.md → documentation/docs/index.en.md
@@ -2,7 +2,7 @@
 title: Home
 ---
 
-<img alt="WMO logo" src="assets/img/wmo-logo.png" width="200">
+<img alt="WMO logo" src="../assets/img/wmo-logo.png" width="200">
 # WIS2 in a box training
 
 WIS2 in a box ([wis2box](https://docs.wis2box.wis.wmo.int)) is a Free and Open Source (FOSS) Reference Implementation of a WMO WIS2 Node. The project provides a plug and play toolset to ingest, process, and publish weather/climate/water data using standards-based approaches in alignment with the WIS2 principles. wis2box also provides access to all data in the WIS2 network. wis2box is designed to have a low barrier to entry for data providers, providing enabling infrastructure and services for data discovery, access, and visualization.
@@ -87,8 +87,6 @@ Container names (running images) are denoted in **bold**.
 
 ## Training location and materials
 
-This training is always provided live at [https://training.wis2box.wis.wmo.int](https://training.wis2box.wis.wmo.int).
-
 The training contents, wiki and issue tracker are managed on GitHub at [https://github.com/wmo-im/wis2box-training](https://github.com/wmo-im/wis2box-training).
 
 ## Printing the material
@@ -98,16 +96,15 @@ File > Print > Save as PDF.
 
 ## Exercise materials
 
-Exercise materials can be downloaded from the [exercise-materials.zip](https://training.wis2box.wis.wmo.int/exercise-materials.zip) zipfile.
-
+Exercise materials can be downloaded from the [exercise-materials.zip](/exercise-materials.zip) zipfile.
 
 ## Support
 
 For issues/bugs/suggestions or improvements/contributions to this training, please use the [GitHub issue tracker](https://github.com/wmo-im/wis2box-training/issues).
 
 All wis2box bugs, enhancements and issues can be reported on [GitHub](https://github.com/wmo-im/wis2box/issues).
 
-For additional support of questions, please contact wis@wmo.int.
+For additional support of questions, please contact wis2-support@wmo.int.
 
 As always, wis2box core documentation can always be found at [https://docs.wis2box.wis.wmo.int](https://docs.wis2box.wis.wmo.int).
 

diff --git a/documentation/docs/index.es.md b/documentation/docs/index.es.md
@@ -0,0 +1,109 @@
+---
+title: Inicio
+---
+
+<img alt="Logotipo de la OMM" src="../assets/img/wmo-logo.png" width="200">
+# Entrenamiento de "WIS2-in-a-box"
+
+"WIS2-in-a-box" ([wis2box](https://docs.wis2box.wis.wmo.int)) es una Implementación de Referencia de Código Abierto (FOSS) y gratuita de un Nodo WMO WIS2. El proyecto proporciona un conjunto de herramientas plug and play para ingerir, procesar y publicar datos meteorológicos/climáticos/hidrológicos utilizando enfoques basados en estándares alineados con los principios de WIS2. wis2box también proporciona acceso a todos los datos en la red de WIS2. wis2box está diseñado para tener una barrera de entrada baja para los proveedores de datos, ofreciendo infraestructura y servicios habilitadores para la búsqueda, acceso y visualización de datos.
+
+Este entrenamiento proporciona explicaciones paso a paso de varios aspectos del proyecto wis2box, así como una serie de ejercicios para ayudarte a publicar y descargar datos de WIS2. El entrenamiento se proporciona en forma de presentaciones generales y también de ejercicios prácticos.
+
+Los participantes podrán trabajar con datos de prueba y metadatos, así como integrar sus propios datos y metadatos.
+
+Este entrenamiento cubre una amplia gama de temas (instalación/configuración, publicación/descarga de datos, etc.).
+
+## Objetivos y resultados de aprendizaje
+
+Los objetivos de este entrenamiento son familiarizarse con lo siguiente:
+
+- Conceptos y componentes centrales de la arquitectura de WIS2
+- Formatos de datos y metadatos utilizados en WIS2 para descubrimiento y acceso
+- Arquitectura y entorno de wis2box
+- Funciones principales de wis2box:
+    - Gestión de metadatos
+    - Ingesta de datos y transformación al formato BUFR
+    - Broker MQTT para la publicación de mensajes de WIS2
+    - Punto final HTTP para descarga de datos
+    - Punto final de API para acceso programático a datos
+
+## Navegación
+
+La navegación a la izquierda proporciona una tabla de contenido para todo el entrenamiento.
+
+La navegación a la derecha proporciona una tabla de contenido para una página específica.
+
+## Requisitos previos
+
+### Conocimientos
+
+- Comandos básicos de Linux (consulta la [hoja de trucos](cheatsheets/linux.md))
+- Conocimientos básicos de redes y protocolos de Internet
+
+### Software
+
+Este entrenamiento requiere las siguientes herramientas:
+
+- Una instancia que ejecute el sistema operativo Ubuntu (proporcionado por los instructores de la OMM durante las sesiones de entrenamiento locales) consulta [Accediendo a tu VM de estudiante](practical-sessions/accessing-your-student-vm.md#introduction)
+- Cliente SSH para acceder a tu instancia
+- Explorador MQTT en tu máquina local
+- Cliente SCP y FTP para copiar archivos desde tu máquina local
+
+## Convenciones
+
+!!! question
+
+    Una sección marcada de esta manera te invita a responder una pregunta.
+
+También notarás secciones de consejos y notas dentro del texto:
+
+!!! tip
+
+    Los consejos ofrecen ayuda sobre cómo lograr mejor las tareas.
+
+!!! note
+
+    Las notas proporcionan información adicional sobre el tema cubierto por la sesión práctica, así como la mejor manera de lograr tareas.
+
+Los ejemplos se indican de la siguiente manera:
+
+Configuración
+``` {.yaml linenums="1"}
+mi-colección-definida-en-yaml:
+    type: collection
+    title: mi título definido como un atributo yaml llamado title
+    description: mi descripción como un atributo yaml llamado description
+```
+
+Fragmentos que deben escribirse en una terminal/consola se indican como:
+
+```bash
+echo 'Hello world'
+```
+
+Los nombres de los contenedores (imágenes en ejecución) se indican en **negrita**.
+
+## Ubicación y materiales de entrenamiento
+
+Los contenidos del entrenamiento, la wiki y el rastreador de problemas son gestionados en GitHub en [https://github.com/wmo-im/wis2box-training](https://github.com/wmo-im/wis2box-training).
+
+## Imprimir el material
+
+Este entrenamiento se puede exportar a PDF. Para guardar o imprimir este material de entrenamiento, ve a la [página de impresión](print_page) y selecciona Archivo > Imprimir > Guardar como PDF.
+
+## Materiales de ejercicio
+
+Los materiales de ejercicio se pueden descargar desde el archivo [exercise-materials.zip](/exercise-materials.zip) zipfile.
+
+## Soporte
+
+Para problemas/errores/sugerencias o mejoras/contribuciones a este entrenamiento, utiliza el [rastreador de problemas de GitHub](https://github.com/wmo-im/wis2box-training/issues).
+
+Todos los errores, mejoras y problemas de wis2box se pueden reportar en [GitHub](https://github.com/wmo-im/wis2box/issues).
+
+Para soporte adicional o preguntas, por favor contacta a [email protected].
+
+Como siempre, la documentación principal de wis2box siempre se puede encontrar en [https://docs.wis2box.wis.wmo.int](https://docs.wis2box.wis.wmo.int).
+
+¡Las contribuciones siempre son alentadas y bienvenidas!
+