Ir al contenido principal

Sincronizar contenido desde GitHub

Sincroniza archivos Markdown desde un repositorio de GitHub en Fin para que Fin y Copilot puedan usarlos.

La sincronización de contenido de GitHub te permite sincronizar archivos Markdown (.md) desde un repositorio de GitHub en Fin, para que Fin y Copilot puedan usarlos.


Primeros pasos

  1. Ve a Train > Content, haz clic en See all, luego elige From GitHub.

  2. Instala la app Fin GitHub sync para la cuenta de GitHub que quieres conectar. Puede que necesites la aprobación del administrador de tu organización para instalar la app en una cuenta organizacional.

  3. Elige si la app puede acceder a todos los repositorios o solo a algunos seleccionados.

  4. Cuando la configuración de GitHub esté lista, la ventana emergente se cerrará. Elige el repositorio y una carpeta si es necesario, desde donde quieres sincronizar archivos Markdown.

  5. (Opcional) Elige crear o actualizar un archivo CLAUDE.md con instrucciones para Claude Code sobre cómo crear y actualizar contenido sincronizado y usar el esquema Frontmatter.

  6. Haz clic en Clone and connect.

Nota: Para dar acceso a otro repositorio más tarde, haz clic en Manage GitHub repository access on GitHub. Esto abre la misma ventana emergente, donde puedes añadir repositorios a la lista permitida.


Permisos

La app Fin GitHub sync necesita estos permisos de GitHub:

  • Metadata (solo lectura): El alcance predeterminado que tiene toda app de GitHub.

  • Checks (lectura y escritura): Ejecuta las comprobaciones del esquema Frontmatter descritas en PR checks abajo.

  • Code (lectura y escritura): Crea o actualiza el archivo CLAUDE.md. Crear el archivo es opcional, pero se requiere el permiso.

  • Pull requests (lectura y escritura): Crea el archivo CLAUDE.md y recibe los webhooks que sincronizan cambios a Fin y ejecutan las comprobaciones de PR.

  • Workflows (lectura y escritura): Añade el flujo de trabajo de GitHub Actions que permite que tu repositorio apruebe y fusione automáticamente las pull requests de sugerencias de Fin (configuración opcional de auto-merge).


Cómo funciona la sincronización

Cuando conectas tu repositorio por primera vez, Fin sincroniza todos los archivos Markdown en él, o en la carpeta que elegiste. Después, cuando se fusiona un cambio en esos archivos Markdown, Fin aplica las ediciones automáticamente.


(Opcional) Esquema Frontmatter

Frontmatter no es obligatorio. Si tus archivos Markdown no lo usan ya, puedes saltarte esta sección. Frontmatter te permite establecer propiedades extra para cómo se sincroniza cada archivo en Fin. Agrégalo al inicio de tu archivo Markdown, así:

---
title: How to request a refund
description: Steps to get a refund on your order
audience: everyone
published: true
fin: enabled
copilot: enabled
sales_agent: disabled
---

Article body goes here…

Claves y valores soportados:

  • title (cualquier texto): El título del artículo. Si falta, Fin usa el primer H1 o una versión legible del nombre del archivo.

  • description (cualquier texto): Una descripción corta que se muestra bajo el título del artículo.

  • published o state (published, true, draft o false): Si el artículo se sincroniza como publicado o como borrador. Publicado significa que el contenido está activo y disponible para Fin.

  • public_url (cualquier URL): La URL pública a la que se envía a los clientes cuando Fin cita este contenido. Sin ella, Fin no cita una fuente para el artículo.

  • service_agent o service (enabled o disabled): Si Fin puede usar el artículo.

  • copilot (enabled o disabled): Si Copilot puede usar el artículo.

  • sales_agent o sales (enabled o disabled): Si Sales Agent puede usar el artículo.

Todas las claves y valores de Frontmatter son opcionales. Las claves no reconocidas se omiten.


Comprobaciones de PR

Fin ejecuta comprobaciones ligeras en las pull requests que cambian tus archivos Markdown sincronizados. Verifican que cada clave de Frontmatter sea válida y esté soportada. Una comprobación fallida aparece en la sección de comprobaciones de la pull request, y puedes hacer clic para ver detalles.

Nota: Estas comprobaciones no bloquean la fusión. Las pull requests aún pueden fusionarse si fallan las comprobaciones GitSync: Content Validation. Para hacerlas obligatorias, consulta la guía de GitHub sobre requerir comprobaciones de estado antes de fusionar.


Limitaciones conocidas

  • Solo se sincronizan archivos Markdown (.md). Los archivos .mdx aún no son compatibles.

  • Los artículos sincronizados están desactivados por defecto para Fin, Copilot y Sales Agent, para que puedas revisarlos antes de publicarlos.

  • Esta es una sincronización unidireccional de GitHub a Fin. Los artículos sincronizados son solo de lectura en Fin y deben editarse en GitHub.

  • Actualmente los artículos solo se crean en inglés.

¿Ha quedado contestada tu pregunta?