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

Última actualización: 2023-11-01
  • Creado para:
  • Developer
    User
    Admin
    Leader

Las instrucciones de esta página muestran cómo utilizar un editor de texto para trabajar en el entorno local, crear documentación y enviar una solicitud de extracción (PR). Antes de seguir los pasos indicados aquí, asegúrese de leer Documente su destino en Destinos de Adobe Experience Platform.

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. Hasta bifurcar En el repositorio, haga clic en Tenedor como se muestra a continuación. Esto crea una copia del repositorio de Experience Platform en su propia cuenta de GitHub.

    Repositorio de documentación de Fork Adobe

  3. Clone el repositorio en el equipo local. Seleccionar Código > HTTPS > Abrir con GitHub Desktop, como se muestra a continuación. Asegúrese de que tiene GitHub Desktop instalado. Para más información, lea Crear un clon local del repositorio en la guía del colaborador de Adobe.

    Clonar repositorio de documentación de Adobe al 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 opción personalization carpeta.

Crear la página de documentación de su destino

  1. La página de documentación se basa en 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 del 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 su editor de texto elegido. El Adobe recomienda que utilice Código de Visual Studio e instale la extensión de Adobe Markdown Authoring. Para instalar la extensión, abra Código de Visual Studio y seleccione Extensions en la parte izquierda de la pantalla y busque adobe markdown authoring. Seleccione la extensión y haga clic en Install.
    Instalar la extensión de creación de Adobe Markdown
  3. Edite la plantilla con la información relevante para su destino. Siga las instrucciones de la plantilla.
  4. Para obtener capturas de pantalla o imágenes que planee agregar 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 opción personalization carpeta. Cree una nueva carpeta para el destino y guarde las imágenes aquí. Debe establecer un vínculo a ellos desde la página que está creando. Consulte instrucciones 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 sugiere 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 las actualizaciones y seleccione Publicar rama para publicar la rama en GitHub.

Nueva sucursal local

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

    Compromiso local

  2. En GitHub Desktop, push su trabajo a la remoto , como se muestra a continuación.

    Insertar el 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 las ramas base y de comparación son correctas. Añada una nota al PR, describa la 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 el Permitir ediciones por responsables casilla de verificación seleccionada para que el equipo de documentación de Adobe pueda realizar ediciones en el PR.

    Crear solicitud 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 CLA, actualice la página PR y envíe la solicitud de extracción.

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

PR correcta

  1. ¡Gracias! El equipo de documentación del Adobe se pondrá en contacto con en caso de que sea necesario realizar alguna edición y le informará de cuándo se publicará la documentación.
SUGERENCIA

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

En esta página