Skip to content

Commit

Permalink
Multi language with spanish examples (#109)
Browse files Browse the repository at this point in the history
* multi-language support
  • Loading branch information
maaikelimper authored May 2, 2024
1 parent 1496496 commit d362346
Show file tree
Hide file tree
Showing 17 changed files with 304 additions and 5 deletions.
2 changes: 1 addition & 1 deletion documentation/docs/assets/tables/aws-minimal.csv
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -87,7 +87,7 @@ 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).
This training is always provided live at [https://maaikelimper.github.io/wis2box-training-test](https://maaikelimper.github.io/wis2box-training-test).

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).

Expand All @@ -98,7 +98,7 @@ 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](https://maaikelimper.github.io/wis2box-training-test/exercise-materials.zip) zipfile.


## Support
Expand Down
111 changes: 111 additions & 0 deletions documentation/docs/index.es.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
---
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

Este entrenamiento siempre se proporciona en vivo en [https://maaikelimper.github.io/wis2box-training-test](https://maaikelimper.github.io/wis2box-training-test).

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](https://maaikelimper.github.io/wis2box-training-test/exercise-materials.zip).

## 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!

169 changes: 169 additions & 0 deletions documentation/docs/practical-sessions/accessing-your-student-vm.es.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,169 @@
---
title: Acceso a tu VM de estudiante
---

# Acceso a tu VM de estudiante

!!! abstract "Resultados de aprendizaje"

Al finalizar esta sesión práctica, podrás:

- acceder a tu VM de estudiante mediante SSH y WinSCP
- verificar que el software necesario para los ejercicios prácticos esté instalado
- verificar que tienes acceso a los materiales de ejercicio para este entrenamiento en tu VM local de estudiante

## Introducción

Como parte de las sesiones de entrenamiento local de wis2box, puedes acceder a tu VM personal en la red de entrenamiento local llamada "WIS2-training".

Tu VM de estudiante tiene el siguiente software preinstalado:

- Ubuntu 22.0.4.3 LTS [ubuntu-22.04.3-live-server-amd64.iso](https://releases.ubuntu.com/jammy/ubuntu-22.04.3-live-server-amd64.iso)
- Python 3.10.12
- Docker 24.0.6
- Docker Compose 2.21.0
- Editores de texto: vim, nano

!!! note

Si deseas ejecutar este entrenamiento fuera de una sesión de entrenamiento local, puedes proporcionar tu propia instancia utilizando cualquier proveedor de nube, por ejemplo:

- GCP (Google Cloud Platform) instancia VM `e2-medium`
- AWS (Amazon Web Services) instancia ec2 `t3a.medium`
- Azure (Microsoft) Máquina Virtual Azure `standard_b2s`

Selecciona Ubuntu Server 22.0.4 LTS como SO.

Después de crear tu VM, asegúrate de haber instalado Python, Docker y Docker Compose, como se describe en [dependencias de software de wis2box](https://docs.wis2box.wis.wmo.int/en/latest/user/getting-started.html#software-dependencies).

El archivo de lanzamiento de wis2box utilizado en este entrenamiento se puede descargar de la siguiente manera:

```bash
wget https://github.com/wmo-im/wis2box/releases/download/1.0b5/wis2box-setup-1.0b5.zip
unzip wis2box-setup-1.0b5.zip
```

Siempre puedes encontrar el archivo de lanzamiento más reciente de 'wis2box-setup' en [https://github.com/wmo-im/wis2box/releases](https://github.com/wmo-im/wis2box/releases).

El material de ejercicio utilizado en este entrenamiento se puede descargar de la siguiente manera:

```bash
wget https://maaikelimper.github.io/wis2box-training-test/exercise-materials.zip
unzip exercise-materials.zip
```

Los siguientes paquetes adicionales de Python son necesarios para ejecutar los materiales de ejercicio:

```bash
pip3 install minio
pip3 install pywiscat
pip3 install pywis-pubsub
```

Si estás utilizando la VM de estudiante proporcionada durante las sesiones locales de entrenamiento de WIS2, el software necesario ya estará instalado.

## Conectarse a tu VM de estudiante en la red de entrenamiento local

Utiliza la siguiente configuración para conectar tu PC a la red Wi-Fi local emitida en la sala durante el entrenamiento de WIS2:

- **SSID: WIS2-training**
- **contraseña: dataismagic!**

Utiliza un cliente SSH para conectarte a tu VM de estudiante usando lo siguiente:

- **Host: (proporcionado durante el entrenamiento presencial)**
- **Puerto: 22**
- **Nombre de usuario: (proporcionado durante el entrenamiento presencial)**
- **Contraseña: wis2training** (contraseña predeterminada para cambiar después de iniciar sesión)

!!! tip
Contacta a un instructor si no estás seguro sobre el nombre del host/usuario o tienes problemas para conectarte.

Una vez conectado, por favor cambia tu contraseña para asegurar que otros no puedan acceder a tu VM:

```bash
limper@student-vm:~$ passwd
Cambiando la contraseña para testuser.
Contraseña actual:
Nueva contraseña:
Vuelve a escribir la nueva contraseña:
passwd: la contraseña se actualizó correctamente
```

## Verificar versiones de software

Para poder ejecutar wis2box, la VM de estudiante debe tener Python, Docker y Docker Compose preinstalados.

Verificar la versión de Python:
```bash
python3 --version
```
devuelve:
```console
Python 3.10.12
```

Verificar la versión de Docker:
```bash
docker --version
```
devuelve:
```console
Docker version 24.0.6, build ed223bc
```

Verificar la versión de Docker Compose:
```bash
docker compose version
```
devuelve:
```console
Docker Compose version v2.21.0
```

Para asegurarte de que tu usuario pueda ejecutar comandos de Docker, tu usuario ha sido agregado al grupo docker.

Para probar que tu usuario pueda ejecutar 'hello-world' de Docker, ejecuta el siguiente comando:
```bash
docker run hello-world
```

devuelve:
```console
Hello from Docker!
This message shows that your installation appears to be working correctly.
...
```

## Inspeccionar los materiales de ejercicio

Inspeccionar el contenido de tu directorio de inicio; estos son los materiales utilizados como parte del entrenamiento y las sesiones prácticas.

```bash
ls ~/
```
devuelve:
```console
exercise-materials wis2box-1.0b5
```

Puedes usar WinSCP para conectarte a tu instancia e inspeccionar el contenido de tu directorio de inicio y descargar o cargar archivos entre tu VM y tu PC local.

Abre WinSCP y haz clic en "New Site". Puedes crear una nueva conexión SCP a tu VM de la siguiente manera:

![Captura de pantalla de WinSCP](../assets/img/winscp-student-vm-scp.png)

Haz clic en 'Guardar' y luego 'Iniciar sesión' para conectarte a tu VM.

Y deberías poder ver el siguiente contenido:

![Contenido en WinSCP](../assets/img/winscp-student-vm-exercise-materials.png)

## Conclusión

!!! success "¡Felicidades!"
En esta sesión práctica, aprendiste cómo:

- acceder a tu VM de estudiante mediante SSH y WinSCP
- verificar que el software necesario para los ejercicios prácticos esté instalado
- verificar que tienes acceso a los materiales de ejercicio para este entrenamiento en tu VM local de estudiante
18 changes: 18 additions & 0 deletions documentation/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -60,3 +60,21 @@ markdown_extensions:

extra_css:
- assets/css/custom.css

plugins:
- i18n:
docs_structure: suffix
languages:
- locale: en
default: true
name: English
build: true
- locale: es
name: Español
build: true
- locale: fr
name: Français
build: true
- locale: ru
name: Русский
build: true
3 changes: 2 additions & 1 deletion documentation/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
mkdocs
mkdocs-material
mkdocs-print-site-plugin
mkdocs-table-reader-plugin
mkdocs-table-reader-plugin
mkdocs-static-i18n

0 comments on commit d362346

Please sign in to comment.