Utilice la interfaz web de GitHub para crear una página de documentación de origen

Este documento proporciona pasos sobre cómo utilizar la interfaz web de GitHub para crear documentación y enviar una solicitud de extracción (PR).

SUGERENCIA

Los siguientes documentos de la guía de contribución de Adobe se pueden utilizar para respaldar aún más su proceso de documentación:

Configuración del entorno de GitHub

El primer paso para configurar el entorno de GitHub es ir a la Repositorio de Adobe Experience Platform GitHub.

platform-repo

A continuación, seleccione Bifurcación (Fork).

Fork (Ramificación)

Una vez finalizada la ramificación, seleccione maestro e introduzca un nombre para la nueva rama en el menú desplegable que aparece. Asegúrese de proporcionar un nombre descriptivo para la rama, ya que se utilizará para contener el trabajo, y luego seleccione crear rama.

create-branch

En la estructura de carpetas de GitHub del repositorio ramificado, vaya a experience-platform.en/help/sources/tutorials/api/create/ y, a continuación, seleccione la categoría adecuada para el origen en la lista. Por ejemplo, si está creando documentación para un nuevo origen CRM, seleccione crm.

SUGERENCIA

Si está creando documentación para la interfaz de usuario de , vaya a experience-platform.en/help/sources/tutorials/ui/create/ y seleccione la categoría adecuada para el origen. Para añadir las imágenes, vaya a experience-platform.en/help/sources/images/tutorials/create/sdk a continuación, agregue las capturas de pantalla a la sdk carpeta.

crm

Aparece una carpeta de orígenes CRM existentes. Para agregar documentación para una fuente nueva, seleccione Agregar archivo y, a continuación, seleccione Crear nuevo archivo del menú desplegable que aparece.

create-new-file

Asigne un nombre al archivo de origen YOURSOURCE.md donde YOURSOURCE es el nombre de su fuente en Platform. Por ejemplo, si su empresa es ACME CRM, su nombre de archivo debería ser acme-crm.md.

git-interface

Cree la página de documentación para el origen

Para empezar a documentar el nuevo origen, pegue el contenido del plantilla de documentación de fuentes en el editor web de GitHub. También puede descargar la plantilla here.

Con la plantilla copiada en la interfaz del editor web de GitHub, siga las instrucciones descritas en la plantilla y edite los valores que contengan información relevante para la fuente.

pegar-plantilla

Cuando termine, confirme el archivo en su rama.

commit

Envíe su documentación para su revisión

Una vez confirmado el archivo, puede abrir una solicitud de extracción (PR) para fusionar la rama de trabajo en la rama maestra del repositorio de documentación de Adobe. Asegúrese de que la rama en la que ha estado trabajando está seleccionada y, a continuación, seleccione Comparar y extraer solicitudes.

compare-pr

Asegúrese de que la base y las ramas comparadas sean correctas. Agregue una nota a la PR, describa su actualización y, a continuación, seleccione Crear solicitud de extracción. Esto abre una PR para fusionar la rama de trabajo del trabajo en la rama maestra del repositorio de Adobe.

SUGERENCIA

Deje el Permitir ediciones por parte de los administradores casilla de verificación seleccionada para garantizar que el equipo de documentación de Adobe pueda realizar modificaciones en PR.

create-pr

En este punto, aparece una notificación que le solicita que firme el Acuerdo de licencia para colaboradores de Adobe (CLA). Este es un paso obligatorio. Después de firmar el Acuerdo de colaboración, actualice la página de relaciones públicas y envíe la solicitud de extracción.

Puede confirmar que la solicitud de extracción se ha enviado inspeccionando la pestaña de solicitudes de extracción en https://github.com/AdobeDocs/experience-platform.en.

confirm-pr

En esta página