Sensedia Docs proporciona un proceso simplificado para publicar documentación.
Publicar documentación es un paso crucial en el ciclo de vida de la documentación. Sensedia Docs ofrece diversas herramientas y funcionalidades para ayudarte a publicar tu documentación de manera eficiente y efectiva. En esta guía, te mostraremos el proceso para publicar tu documentación usando Sensedia Docs.
Antes de poder publicar tu documentación, necesitas configurar tu proyecto. Esto implica crear un nuevo proyecto en Sensedia Docs y configurarlo según tus necesidades.
Dentro del repositorio clonado, encontrarás un directorio example. Este directorio contiene un proyecto de ejemplo que puedes usar como punto de partida para tu documentación.
Abre el archivo bitbucket-pipelines.yml y configúralo según los requisitos de tu proyecto. Este archivo define el pipeline de publicación y especifica cómo se desplegará tu documentación.
Asegúrate de que tu repositorio de Bitbucket esté configurado correctamente para activar el pipeline cuando se realicen cambios. Esto incluye configurar las variables de entorno STRAPI_URL, STRAPI_TOKEN.
Debes acceder a Strapi para generar estos tokens, que se utilizan para autenticar y autorizar las actualizaciones de tu documentación.
Una vez que tu proyecto esté configurado, puedes comenzar a crear tu documentación. Sensedia Docs proporciona una interfaz fácil de usar para redactar y organizar tu contenido. Puedes crear diferentes tipos de documentos, como guías, referencias de API y tutoriales, usando Markdown + visualizador (Extensión Sensedia Docs para VSCode).
El proceso de publicación es gestionado por Bitbucket Pipelines, que construye y despliega automáticamente tu documentación cuando realizas un push de cambios al repositorio. El pipeline definido en el archivo bitbucket-pipelines.yml se encargará del proceso de construcción y despliegue.
El pipeline se activa automáticamente cuando haces push de cambios al repositorio. Asegúrate de que tu archivo bitbucket-pipelines.yml esté correctamente configurado para la rama main.
Asegúrate de haber hecho push de tus cambios a la rama correcta y que el pipeline haya finalizado correctamente. Revisa los logs del pipeline para detectar posibles errores.
Simplemente realiza cambios en tus archivos Markdown y haz push al repositorio. El pipeline reconstruirá y volverá a desplegar tu documentación automáticamente.
Nuestro sitio web utiliza cookies para habilitar funcionalidades básicas de evaluación y notificaciones. No utilizamos cookies de seguimiento para publicidad ni análisis de terceros.Aprender más