Contribución a la documentación y mejoras

La documentación de Couchbase es de código abierto, pero hasta hace poco había una serie de problemas. Si querías hacer un cambio sustancial o simplemente corregir un error tipográfico, te encontrabas con una o más de estas preguntas:

No siempre estaba claro cómo ir de una URL de documentación a un archivo específico en el repositorio de Github.

Ahora, eso ha cambiado. Si visitas una página de la documentación, verás un enlace "Editar en GitHub" en cada página. Haz clic en este enlace y accederás a GitHub para editar el archivo directamente (la primera vez, se te pedirá que crees un fork).

En primer lugar, visite la página Uso de Graceful Failover en la documentación.

A continuación, haga clic en el enlace "Editar en GitHub".

En este punto, estás en GitHub. Suponiendo que hayas utilizado Git/GitHub antes, el resto de este proceso debería resultarte familiar.

Si aún no ha creado un tenedor, se le pedirá que lo haga.

A continuación, aparecerá una pantalla de edición en la que podrá realizar los cambios.

Una vez que hayas hecho un cambio, haz clic en "Proponer cambio de archivo". Verás un diff y podrás crear un pull request.

Es un curso intensivo para contribuir a la documentación. Hay un guía completa sobre cómo contribuir a la documentación de Couchbase Server.

Tenga en cuenta que mientras que esa guía está escrita en Markdown, la documentación de Couchbase Server está escrita en el lenguaje Lenguaje de marcado Darwin Information Typing Architecture (DITA).

Para simples correcciones tipográficas, puede que no necesite saber mucho sobre DITA, pero para ediciones más profundas, necesitará familiarizarse con la sintaxis y/o una herramienta de edición como Oxígeno.

Gracias a los miembros de la comunidad que ya han contribuido. Este nuevo sistema sólo lleva en marcha unos meses, pero ya hemos recibido grandes contribuciones. Así que me quito el sombrero ante

Me asombra que hayamos recibido tan buenas contribuciones de tanta gente tan rápidamente. Gracias a todos por contribuir a mejorar la documentación.

Para facilitar la contribución, había que mejorar el proceso de compilación. Anteriormente, implicaba un montón de pasos manuales: extraer el código fuente, compilar localmente, comprimir los resultados, enviarlos por FTP a un servidor, ejecutar manualmente una o varias tareas lentas del servidor de compilación. Ahora verás que el paso de compilación es mucho más rápido en el pull request, y las vistas previas se generan rápidamente.

También se ha mejorado la revisión de contenidos. Antes, las previsualizaciones sólo eran posibles en una única ubicación. No era posible la revisión simultánea. Esto, combinado con la lentitud de las construcciones manuales, resultaba frustrante y dificultaba la revisión de todos los cambios, por no hablar de los externos.

Por último, el backporting a otras versiones de la documentación de Couchbase Server también era un problema. La documentación se almacena en ramas separadas para cada versión, por lo que si un problema se plantea y se corrige en la 4.6, también puede aplicarse a la 4.5, y así sucesivamente. Es un proceso muy manual, pero se creó un @cb-docs-robot para automatizar el backporting (que verás en muchos de los ejemplos anteriores).

También hemos añadido la posibilidad de hacernos llegar tus comentarios sobre la documentación directamente desde tu navegador.

Basta con encontrar el "Comentarios sobre esta página" en la parte inferior derecha de su navegador, haga clic en él y escriba sus comentarios.

Estas mejoras de la documentación nos ayudan tanto interna como externamente. Esperamos que su experiencia con la documentación sea menos frustrante y más agradable. Agradecemos sus comentarios. Consulte la página Documentación de Couchbase en GitHub.