Utilice un editor de texto en el entorno local para crear una página de documentación de destino

Las instrucciones de esta página le muestran cómo utilizar un editor de texto para trabajar en su entorno local con el fin de 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.

Conéctese a GitHub y configure su entorno de creación local

  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. Clone el repositorio en el equipo local. Seleccione Código > HTTPS > Abrir con GitHub Desktop, como se muestra a continuación. Asegúrese de tener GitHub Desktop instalado. Para obtener más referencia, lea Create a local clone of the repository en la guía del colaborador de Adobe.

    Clonar el repositorio de documentación de Adobe en el entorno local

  4. En la estructura de archivos local, vaya a experience-platform.en/help/destinations/catalog/[...], donde [...] es la categoría deseada para el destino. Por ejemplo, si va a añadir un destino de personalización al Experience Platform, seleccione la carpeta personalization .

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

  1. La página de documentación se basa en la plantilla de destino de autoservicio. Descargue la plantilla de destino. Descomprima y extraiga el archivo yourdestination-template.md al directorio mencionado en el paso 4 anterior. Cambie el nombre del archivo YOURDESTINATION.md, donde YOURDESTINATION 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.
  2. Abra el nuevo archivo en el editor de texto de su elección. Adobe recomienda utilizar Visual Studio Code e instalar la extensión de creación de Adobe Markdown. Para instalar la extensión, abra Código de Visual Studio, seleccione la pestaña Extensions a la izquierda de la pantalla y busque adobe markdown authoring. Seleccione la extensión y haga clic en Install.
    Instalación de la extensión de creación de Adobe Markdown
  3. Edite la plantilla con la información relevante para el destino. Siga las instrucciones de la plantilla.
  4. Para las capturas de pantalla o imágenes que planee añadir a la documentación, vaya a GitHub/experience-platform.en/help/destinations/assets/catalog/[...], donde [...] es la categoría deseada para el destino. Por ejemplo, si va a añadir un destino de personalización al Experience Platform, seleccione la carpeta personalization . Cree una nueva carpeta para el destino y guarde las imágenes aquí. Debe vincularlos desde la página que esté creando. Consulte instrucciones sobre cómo vincular a imágenes.
  5. Cuando esté listo, guarde el archivo en el que está trabajando.

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. En GitHub Desktop, cree una rama de trabajo para sus actualizaciones y seleccione Publicar rama para publicar la rama en GitHub.

Nueva rama local

  1. En GitHub Desktop, confirma su trabajo, como se muestra a continuación.

    Confirmar local

  2. En GitHub Desktop, inserte su trabajo en la rama remota, como se muestra a continuación.

    Impulse su compromiso

  3. En la interfaz web de GitHub, abra 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

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

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

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

  1. ¡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