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).
Configuración del entorno de GitHub
El primer paso para configurar el entorno de GitHub es ir al repositorio de GitHub de Adobe Experience Platform.
A continuación, seleccione Bifurcación.
Una vez completada la bifurcació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 su trabajo y, a continuación, seleccione crear rama.
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 de CRM, seleccione crm.
experience-platform.en/help/sources/tutorials/ui/create/
y seleccione la categoría adecuada para el origen. Para agregar tus imágenes, ve a experience-platform.en/help/sources/images/tutorials/create/sdk
y luego agrega tus capturas de pantalla a la carpeta sdk
.
Aparece una carpeta de orígenes de CRM existentes. Para agregar documentación para un nuevo origen, selecciona Agregar archivo y, a continuación, selecciona Crear nuevo archivo en el menú desplegable que aparece.
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
.
Crear la página de documentación para el origen
Para empezar a documentar la nueva fuente, pegue el contenido de la plantilla de documentación de fuentes 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.
Cuando se complete, confirme el archivo en la rama.
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.
Asegúrese de que las ramas base y de comparación son correctas. Agregue una nota al PR, describiendo su actualización, y luego 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.
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.