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 Repositorio de GitHub de Adobe Experience Platform.

platform-repo

A continuación, seleccione Tenedor.

Fork (Ramificación)

Una vez completada la ramificación, seleccione principal 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 este se utilizará para contener el trabajo y, a continuación, seleccione crear rama.

create-branch

En la estructura de carpetas de GitHub del repositorio ramificado, navegue hasta 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, añada sus capturas de pantalla a sdk carpeta.

crm

Aparece una carpeta de orígenes de CRM existentes. Para añadir documentación para un nuevo origen, seleccione Añadir archivo y luego seleccione Crear nuevo archivo en el menú desplegable que aparece.

create-new-file

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

git-interface

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

Para empezar a documentar la nueva fuente, pegue el contenido de plantilla de documentación de orígenes en el editor web de GitHub. También puede descargar la plantilla aquí.

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.

paste-template

Cuando se complete, confirme el archivo en la rama.

comprometer

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 solicitud.

compare-pr

Asegúrese de que las ramas base y de comparación son correctas. Añada una nota al PR, describiendo la actualización y, a continuación, seleccione Crear solicitud de extracción. Se abrirá una PR para fusionar la rama de trabajo del trabajo en la rama maestra del repositorio de Adobe.

SUGERENCIA

Deje el Permitir ediciones por responsables casilla de verificación seleccionada para garantizar que el equipo de documentación de Adobe pueda realizar ediciones en el 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 CLA, actualice la página PR y envíe la solicitud de extracción.

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

confirm-pr

En esta página