Como contribuir
El contenido del Glosario Cloud Native se almacena en este repositorio de GitHub donde encontrará una lista de issues, PRs y discusiones sobre el glosario.
Existen cuatro formas en las que se puede contribuir:
- Trabajar en un issue existente
- Proponer nuevos términos
- Actualizar un término existente
- Ayudar a traducir el glosario
¿Quién puede contribuir?
El objetivo de este Glosario es simplificar el espacio Cloud Native - notorio por su complejidad - haciéndolo más fácil de entender. Para ello, debemos focalizarnos en la simplicidad.
Explicar conceptos complejos en palabras simples es muy difícil. Y mientras pueda parecer fácil crear un contenido entendible y amigable, llegar a esa simplicidad es fruto del trabajo arduo y colaborativo entre expertos de Cloud Native. En concreto, para agregar un nuevo término, usted debería tener un conocimiento profundo al respecto.
El esfuerzo de traducción es algo diferente. Dado que existen definiciones sólidas en Inglés, contribuidores menos experimentados técnicamente pueden también proveer términos traducidos. Esta parte del proyecto es más amigable para principiantes.
Unirse a la comunidad del glosario
Si desea contribuir con regularidad, considere unirse a nuestras reuniones mensuales del Grupo de trabajo del glosario. Puede encontrar los detalles de la reunión en el calendario de la CNCF. También puede conectarse con los mantenedores y otros colaboradores en nuestro canal #glossary en el calendario CNCF. ¡Nos encantaría conocerle!
Trabajar en un issue existente
Vaya a los issues del repositorio de Glosario en GitHub. Allí verá una lista de todos los issues. Puede filtrar por etiqueta (por ejemplo, idioma español, ‘help needed’, ‘good first issue’). Tenga en cuenta que necesitará una cuenta de GitHub para hacer esto.
Asegúrese de que el término que le interesa no esté ya asignado a alguien mas. En este ejemplo puede ver que los primeros tres términos están disponibles mientras que el cuarto ya ha sido asignado.
Una vez que haya encontrado un término en el que desea trabajar, haga clic en el issue y agregue un comentario expresando su interés en trabajarlo.
Además, también únase al canal #glossary en el CNCF Slack e informe a los mantenedores de su interés en el issue (etiquete a @Catherine Paganini, @jmo, @Seokho Son, @Jihoon Seo y/o @iamnoah para asegurarse de que reciban la notificación). Tenga en cuenta que solo puede reclamar un término a la vez. Si desea trabajar en varios términos, termine uno antes de reclamar el siguiente.
Una vez que le asignen el issue, puede empezar a trabajar en él. Para conocer los próximos pasos, consulte la sección Enviar un nuevo término (crear un PR).
Antes de concluir la creación del pull request (PR), necesita firmar el Contributor License Agreement (CLA). Seleccione la opción ICLA si usted es un individuo contribuyendo al proyecto a título personal. A continuación siga los pasos descritos en el link.
También necesitará verificar la firma de su commit y activar el modo vigilante en GitHub para comprobar el origen de su commit y mostrar el estado “verified”.
Proponer nuevos términos
Puede proponer un nuevo término para que otros trabajen en él o crear una nueva definición usted mismo. De cualquier forma, comenzará creando un issue. Tenga en cuenta que debe cumplir los términos de la definición nativa para la nube de CNCF. Las únicas excepciones son los términos básicos necesarios para comprender los conceptos nativos de la nube.
A continuación se muestra una guía paso a paso para aquellos que aún no están familiarizados con GitHub. Si usted es un profesional de GitHub, puede dar sólo un vistazo para asegurarse de lo siguiente:
- usar nuestras plantillas de issues,
- encontrar la plantilla del archivo,
- conocer las convenciones de nomenclatura,
- notificar a los mantenedores en Slack (de lo contrario, podemos perderlo),
- resolver fallas en la revisión de ortografía.
Antes de comenzar, le sugerimos leer la Guía de estilo ¡Gracias!
Crear un issue
Vaya a los issues del repositorio del Glosario en GitHub y haga clic en “New issue”.
Verá una variedad de plantillas. Para proponer un nuevo término en Español, seleccione “Request to update existing term (Non-English)”.
Agregue la palabra que está sugiriendo, responda las dos preguntas a continuación, marque las casillas de verificación y presione “Submit new issue”. Si solo está proponiendo un nuevo término, ¡ya está listo! Para trabajar en ello, siga los siguientes pasos.
Evaluar su issue
A continuación, los mantenedores evaluarán el issue. Eso significa que evaluarán si el término debe formar parte del Glosario (tenga en cuenta que no todos los términos son admitidos). Los términos deben ser términos nativos de la nube establecidos y ampliamente utilizados). Para ser admitido, el término propuesto debe ser nativo de la nube, ser ampliamente utilizado y establecido.
Informe a los mantenedores que ha enviado un término en Slack, ya que de lo contrario podrían perderlo. Etiquete en su mensaje a @Catherine Paganini, @jmo, @Seokho Son, @Jihoon Seo y/o @iamnoah. Si el término es aprobado y quiere trabajar en él, ellos se lo asignarán.
Tenga en cuenta que solo puede reclamar un término a la vez. Si desea trabajar en varios términos, termine uno antes de reclamar el siguiente.
Proponer un nuevo término (crear un PR)
Antes de comenzar, lea la Guía de estilo — le ayudará a minimizar el ir de un lado a otro. Como se indica en la guía de estilo, recomendamos encarecidamente el comenzar con un documento de Google o Word.
Una vez que el término esté listo para ser enviado, vaya a la carpeta de content (en la sección de code)…
…luego “en” …
…y seleccione _TEMPLATE.md
Copie el contenido…
Cambie de branch a “dev-es”, regrese a la carpeta /content/ y seleccione “es”.
Presione “Add file” y seleccione “Create new file.”
Agregue el nombre del término en la URL (sin mayúsculas, sin espacios ni paréntesis y usando guiones para separar palabras) y la extensión .md al final (nota: si su vista previa no funciona, probablemente olvidó agregar .md al final). A continuación pegue el contenido de la plantilla. Copie y pegue su definición en el archivo. Para facilitar las revisiones, use semántica de saltos de línea (por ejemplo, una línea por oración). Tenga en cuenta que GitHub usa Markdown para formatear el texto (p. ej., hipervínculo, negrita, cursiva). Consulte esta hoja de referencia para markdown. Para verificar que usó Markdown según lo pensado, vaya a “Preview”.
Desplácese hacia abajo y asigne un nombre al nuevo archivo de confirmación cuando esté listo para enviarlo. Ahora está a punto de asignar el término a su propio branch. Para enviar el PR se requiere un paso adicional. Presiona “Commit new file” y…
…ahora ya esta creando un PR:
Al finalizar estos pasos, su PR deberá de aparecer en “Pull requests”.
Actualizar un término existente
Para actualizar un término existente, puede sugerir un cambio a través de un issue o continuar y actualizar el término directamente enviando un pull request.
Solicitar un cambio a través de un issue
Si desea marcar un problema con un término pero no sabe cómo hacerlo o desea solucionarlo usted mismo, haga clic en “Reportar un issue”.
Esto abrirá directamente un issue. Explique qué cambio es necesario y por qué. Presiona enviar, y eso es todo.
Actualizar un término directamente
Para cambiar un término directamente, vaya a “Editar esta página”.
Esto abrirá la página del término en GitHub. Realice sus cambios y envíe un PR. Consulte “Envío de un nuevo término” (más arriba en este documento) para obtener una descripción mas detallada (salte a la sección que habla acerca de markdown).
Ayudar a traducir el glosario
Para ayudar a traducir el glosario a su idioma, únase al canal #glossary-localizations en CNCF Slack y háganoslo saber. Puede unirse a un equipo existente o crear uno nuevo (la Guía de localización le proporcionará la información necesaria para comenzar). Únase también a nuestras juntas mensuales del grupo de trabajo. Puede encontrar mas detalles en el calendario de la CNCF. ¡Esperamos verle allí!
Revisar la ortografía
La revisión de ortografía puede fallar por las siguientes razones:
- el PR contiene error(es) ortográfico(s),
- el PR contiene palabras que no están registradas en la lista de palabras en español.
Para poder añadir nuevas palabras a la lista en español, siga los siguientes pasos:
- Seleccione la carpeta “content” en su PR.
- Vaya a la carpeta “es” y localice el archivo “.wordlist.txt”.
- Seleccione la opción “Edit this file” y añada las palabras faltantes.
- Al terminar, describa los cambios en el mensaje del commit y dé clic en “Sign off and propose changes”.
Nótese que las palabras están en orden alfabético, le pedimos encarecidamente mantenga este orden. La revisión ortográfica ignora el uso de mayúsculas y minúsculas.