Configuración de desarrollo y comandos para construir, visualizar en el entorno local y más

Las siguientes instrucciones detallan cómo configurar el entorno de desarrollo para este sitio web.

Configuración IDE en la nube

Estas instrucciones están pensadas para Gitpod.io, adáptalas si prefieres otro entorno de desarrollo en la nube:

1. Bifurcar este repositorio. Si necesitas ayuda, mira en Bifurcar un repositorio.

2. En gitpod.io/workspaces, crea un nuevo espacio de trabajo (haz esto solo una vez) o abre un espacio de trabajo existente de tu fork. También puedes visitar el enlace con el formato: https://gitpod.io#https://github.com/YOUR_GITHUB_ID/opentelemetry.io.

   Nota: Si tienes los permisos necesarios para trabajar directamente en este repositorio, o simplemente quieres explorar, abre https://gitpod.io/#https://github.com/open-telemetry/opentelemetry.io.

Gitpod instalará automáticamente los paquetes necesarios por ti durante la inicialización del entorno.

Aún no estás listo para construir, visualizar en el entorno local o hacer actualizaciones en los ficheros del sitio web.

Configuración local

1. Crea un fork y clona el repositorio del sitio web desde https://github.com/open-telemetry/opentelemetry.io.

2. Navega hasta el directorio del repositorio clonado.

3. Instala o actualiza a una versión LTS de Node.js.~~~~ Recomendamos el uso de nvm para manejar la instalación de Node. En Linux, ejecuta el siguiente comando, el cual instalará y actualizará a la versión especificada en el fichero .nvmrc:

   nvm install
   

   Para instalar en Windows, usa nvm-windows:

   > nvm install lts && nvm use lts
   

4. Instala los paquetes del proyecto y otros prerequisitos:

   npm install
   

Aún no estás listo para construir, visualizar en el entorno local o hacer actualizaciones en los ficheros del sitio web.

Construir

Para construir este sitio web:

npm run build

Los ficheros se generan bajo la carpeta public.

Visualizar en el entorno local

Para visualizar en el entorno local, ejecuta el comando:

npm run serve

La web estará publicada en localhost:1313.

Si necesitas probar la redirección de Netlify, usa el siguiente comando y accede a través de localhost:8888:

npm run serve:netlify

El comando serve publica el sitio web utilizando archivos en memoria, no desde el disco.

Si ves un error como too many open files o pipe failed en macOS, puede que necesites aumentar el límite de ficheros abiertos. Consulta Hugo issue #6109.

Contenido y submódulos

Este sitio web se genera a partir del siguiente contenido:

• Los ficheros bajo content/, static/, etc. Por defecto en Hugo.
• Los Hugo mounts, definidos en hugo.yaml bajo la carpeta mounts. Los Hugo mounts también provienen directamente de los submódulos de Git, presentes en content-modules, o contenido preprocesado desde content-modules (situado bajo tmp/).

Cambios en los submódulos

Si realizas un cambio dentro del contenido en los content-modules, primero necesitarás crear una PR (que contenga los cambios en el submódulo) al repositorio de submódulos. Solo después de que la PR del submódulo haya sido aceptada, será posible actualizar el submódulo y hacer que los cambios aparezcan en este sitio web.

Es más sencillo gestionar tus cambios en content-modules realizando los cambios en el repositorio al que corresponda el submódulo en lugar de dentro del mismo submódulo.

Los colaboradores más expertos pueden trabajar directamente en el submódulo, siendo capaces de construir y servir localmente directamente los cambios. Por defecto, los scripts de CI obtienen los submódulos en cada invocación. Para prevenir este comportamiento mientras trabajas dentro del submódulo, puedes configurar la variable de entorno GET=no. También necesitarías ejecutar git fetch --unshallow en el submódulo antes de crear la PR. De manera alternativa, puedes configurar DEPTH=100 para volver a clonar los submódulos.