Documentación
Información general
Siempre informa a la comunidad antes de trabajar (creando un nuevo ‘issue’ o comentando uno existente). Esto es para evitar que dos personas estén trabajando en lo mismo y prevenir conflictos.
El trabajo de documentación debe fusionarse en la rama main.
El código fuente de la documentación se encuentra en el directorio
support/documentation/content.
La documentación se genera usando Hugo. Debe instalarlo en su computadora si desea obtener una vista previa de su trabajo.
The minimum required version for Hugo is 0.121.0. It was tested using version 0.132.2.
The used theme is hugo-theme-relearn. You should read its documentation before starting editing the documentation.
Cuando se libere una nueva versión del plugin, o cuando se actualice la
documentación, los mantenedores del plugin fusionarán la rama main con la
rama documentation. Esto activará los pipelines de github y gitlab, y
actualizará la documentación publicada.
Traducciones
El idioma principal es el inglés (código en).
El directorio support/documentation/content/en sólo contiene archivos de
documentación en inglés.
La documentación se traduce mediante Weblate (consulte la documentación de traducción). Para hacerlo pues, utilizamos la herramienta po4a, como veremos más adelante en esta página.
Añadir un nuevo idioma
En el archivo support/documentation/config.toml, copie y modifique la
sección [Languages.fr].
Si las traducciones no están completas, no importa, se utilizará el inglés para las secuencias de caracteres que falten.
Previsualizar
Para previsualizar sus modificaciones, simplemente ejecute:
hugo serve -s support/documentation/A continuación, abra su navegador en la dirección http://localhost:1313/peertube-plugin-livechat/. Esta página se actualizará automáticamente con cada modificación.
Actualizar archivos de localización y generar traducciones de documentación
Por ahora, sólo tienes la versión en inglés. Para actualizar las frases de
la documentación, y generar traducciones, tienes que ejecutar el script
doc-translate.sh.
Para hacerlo, asegúrese de tener po4a (versión>= 0.69) instalado en su computadora.
Algunas distribuciones de Linux (como Debian Bullseye, por ejemplo) tienen
una versión demasiado antigua de po4a. Asegúrese de instalar una versión
compatible. Si está utilizando Debian Bullseye, por ejemplo, puede descargar
el archivo Bookworm po4a.deb desde
https://packages.debian.org,
e instalarlo manualmente.
Para traducir, solo haz:
npm run doc:translateA continuación, puede previsualizar el resultado utilizando hugo serve -s support/documentation/, y utilizando el selector de idioma.
Redactar la documentación
Sólo tienes que editar los archivos en inglés en
support/documentation/content/en.
Después, antes de hacer el commit, ejecuta siempre npm run doc:translate,
para que los cambios en los archivos en inglés se propaguen al archivo
support/documentation/po/livechat.en.pot.
You can use the livechat_label short code to use application strings. See
here: Documentation
translation.
It is possible to prevent a file from beeing translating, using
livechatnotranslation: true in the Yaml Font Matter section. See here:
Documentation
translation.
Please use the livechatnotranslation option for technical documentation.
We don’t want technical documentation to be translated, to avoid issues
because of a wrong translation.
Para facilitar el trabajo de los traductores, evite hacer párrafos demasiado largos.
Por ahora, no es posible utilizar tablas Markdown: las herramientas de traducción las descomponen.
There may be links to this documentation elsewhere on the web. Try not to change the urls of the documentation pages. Or at the very least, put links to the new location on the previous url.
When a new feature is released, you can use the livechat_version_notice
short code to display an infobox with the version with which the features is
available. This short code takes the version number as parameter. Here is
an example:
This feature comes with the livechat plugin version 12.0.0.
¿Y si no puedo usar hugo y/o po4a?
Simplemente edite los archivos markdown en inglés, y especifique que no puede construir las traducciones cuando haga su Pull Request.
Publicación
La publicación de la documentación es automátizada cuando los cambios se
fusionan en la rama documentation.