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

Las instrucciones siguientes muestran cómo utilizar la interfaz web de GitHub para crear documentación y enviar una solicitud de extracción (PR). Antes de seguir los pasos indicados aquí, asegúrese de leer Document your destination in Adobe Experience Platform Destinations.

Configuración del entorno de creación de GitHub

  1. En el explorador, vaya a https://github.com/AdobeDocs/experience-platform.en.

  2. Para ramificar el repositorio, haga clic en Fork como se muestra a continuación. Esto crea una copia del repositorio del Experience Platform en su propia cuenta de GitHub.

    Repositorio de documentación de Adobe de ramificación

  3. En la ramificación del repositorio, cree una nueva rama para su proyecto, como se muestra a continuación. Utilice esta nueva rama para su trabajo.

    Crear nueva rama de GitHub

  4. En la estructura de carpetas de GitHub del repositorio ramificado, vaya a experience-platform.en/help/destinations/catalog/[...], donde [...] es la categoría deseada para su destino. Por ejemplo, si está agregando un destino de personalización al Experience Platform, seleccione la categoría personalization . Seleccione Agregar archivo > Crear nuevo archivo.

    Añadir nuevo archivo

  5. Asigne un nombre a su destino YOURDESTINATION.md, donde DESTINO es el nombre de su destino en Adobe Experience Platform. Por ejemplo, si su empresa se llama Moviestar, debe asignar un nombre al archivo moviestar.md.

Cree la página de documentación para su destino

  1. Creará el contenido de la página de destino en función de la plantilla de autoservicio documentación. 🔗 Descargue la plantilla y descomprima para extraer la plantilla de .md archivo.

  2. Pegue y edite el contenido de la plantilla con información relevante para el destino en un editor de Markdown en línea, como dillinger.io. Siga las instrucciones de la plantilla para obtener detalles sobre qué debe rellenar y qué párrafos se pueden eliminar.

    SUGERENCIA

    Puede cerrar la ventana del explorador en cualquier momento y volver a abrirla más tarde. Su trabajo se guarda automáticamente y se le espera cuando vuelva a abrir el explorador.

  3. Copie el contenido del editor de markdown en el nuevo archivo de GitHub.

  4. Para las capturas de pantalla o imágenes que planee usar, utilice la interfaz de GitHub para cargar los archivos en experience-platform.en/help/destinations/assets/catalog/[...], donde [...] es la categoría deseada para el destino. Por ejemplo, si está agregando un destino de personalización al Experience Platform, seleccione la categoría personalization . Debe vincular las imágenes de la página que esté creando. Consulte instrucciones sobre cómo vincular a imágenes.

    Cargar imagen a GitHub

  5. Cuando esté listo, guarde el archivo en su rama.

Confirmar la creación del archivo

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

SUGERENCIA

Tenga en cuenta que no hay nada que pueda romper aquí. Al seguir las instrucciones de esta sección, simplemente está sugiriendo una actualización de la documentación. El equipo de documentación de Adobe Experience Platform aprobará o editará la actualización sugerida.

  1. Después de guardar el archivo y cargar las imágenes que desee, 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 trabajado esté seleccionada y seleccione Contribute > Abrir solicitud de extracción.

Crear solicitud de extracción

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

    SUGERENCIA

    Deje activada la casilla Permitir ediciones por parte de los mantenedores para que el equipo de documentación de Adobe pueda realizar ediciones en PR.

    Creación de solicitudes de extracción en el repositorio de documentación de Adobe

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

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

    PR con éxito

  4. ¡Gracias! El equipo de documentación de Adobe contactará con PR en caso de que se requieran modificaciones y le informará cuando se publicará la documentación.

SUGERENCIA

Para añadir imágenes y vínculos a la documentación y para cualquier otra pregunta relacionada con Markdown, lea Using Markdown en la guía de escritura colaborativa de Adobe.

En esta página