Changelogs

Crea un changelog para tu documentación con nuestra función nativa Changelogs.

Echa un vistazo a nuestro propio changelog: Product Updates.

Crear un changelog

Para crear un changelog:

• En la navegación superior del editor, abre el selector de ámbito y elige Changelogs.

• Haz clic en Create new changelog.

• Ponle un título y haz clic en Create.

Ahora puedes cambiar la ruta y la descripción del changelog desde su configuración .

Colocar un changelog en la navegación

Un changelog puede estar dentro de un grupo de navegación, junto con las secciones de documentación y las referencias de API con las que se relaciona, en lugar de aparecer solo en la barra de navegación superior.

Abre Manage Changelogs, selecciona el changelog y elige un grupo junto a Navigation group. Elige None para sacarlo del grupo. Un changelog solo puede estar en un grupo a la vez.

Añadir una publicación

Para añadir una nueva publicación al changelog, haz clic en New Post. Cada publicación tiene una etiqueta, un slug desde el que se accede a ella y un contenido. El contenido de una publicación es igual que el de las páginas de documentación y puede incluir cualquier bloque.

Crear publicaciones mediante programación

También puedes crear y listar publicaciones del changelog a través de la API. Esto es útil para publicar notas de versión automáticamente desde tu pipeline de CI/CD.

Edición en un repositorio sincronizado

Si tu proyecto usa GitHub Sync, tus changelogs se reflejan en el repositorio bajo changelogs/, con una carpeta por changelog y un archivo por publicación. Puedes escribir allí una nota de versión y revisarla mediante una pull request, y las publicaciones que escribas en el editor se confirman de vuelta en el repositorio. Consulta Changelogs para ver la estructura de archivos y el frontmatter.

Feed RSS

Es posible suscribirse a los changelogs mediante un feed RSS. Esto permite a los usuarios mantenerse al día con todas las nuevas publicaciones.

Importar publicaciones

Las publicaciones se pueden importar en formato markdoc haciendo clic en el botón de importar junto al título del changelog.

Importar publicaciones solo añade publicaciones al changelog. No elimina ninguna.

Exportar un changelog

Todas las publicaciones de un changelog se pueden exportar haciendo clic en el botón de exportar junto al título del changelog. Las publicaciones se exportan en formato markdoc.