Utilice un editor de texto en el entorno local para crear una página de documentación de fuentes
Este documento proporciona pasos sobre cómo utilizar el entorno local para crear documentación para el origen y enviar una solicitud de extracción (PR).
Requisitos previos
El siguiente tutorial requiere que tenga GitHub Desktop instalado en el equipo local. Si no tiene GitHub Desktop, puede descargar la aplicación aquí.
Conéctese a GitHub y configure su entorno de creación local
El primer paso para configurar el entorno de creación local es ir a Repositorio de GitHub de Adobe Experience Platform.
En la página principal del repositorio de Platform GitHub, seleccione Tenedor.
Para clonar el repositorio en el equipo local, seleccione Código. En el menú desplegable que aparece, seleccione HTTPS y, a continuación, seleccione Abrir con GitHub Desktop.
A continuación, espere unos momentos para que GitHub Desktop clone el experience-platform.en repositorio.
Una vez completado el proceso de clonación, vaya a GitHub Desktop para crear una nueva rama. Seleccionar Principal en la barra de navegación superior y, a continuación, seleccione Nueva rama
En el panel emergente que aparece, escriba un nombre descriptivo para la rama y, a continuación, seleccione Crear rama.
A continuación, seleccione Publicar rama.
Crear la página de documentación para el origen
Con el repositorio clonado en el equipo local y una nueva rama creada, ahora puede empezar a crear la página de documentación para el nuevo origen a través de la editor de texto de su elección.
El Adobe recomienda que utilice Código de Visual Studio y que instale la extensión de creación de Adobe Markdown. Para instalar la extensión, inicie Visual Studio Code y, a continuación, seleccione Extensiones de la barra de navegación izquierda.
A continuación, introduzca Adobe Markdown Authoring en la barra de búsqueda y seleccione Instalar de la página que aparece.
Con el equipo local listo, descargue el plantilla de documentación de orígenes y extraiga el archivo en experience-platform.en/help/sources/tutorials/api/create/... con [...] que representa la categoría que elija. Por ejemplo, si está creando un origen de base de datos, seleccione la carpeta de base de datos.
Finalmente, siga las instrucciones descritas en la plantilla y edite la plantilla con la información relevante perteneciente a su fuente.
Envíe su documentación para su revisión
Para crear una solicitud de extracción (PR) y enviar la documentación para su revisión, guarde primero su trabajo en Visual Studio Code (o el editor de texto que haya elegido). A continuación, con GitHub Desktop, introduzca un mensaje de confirmación y seleccione Compromiso con create-source-documentation.
A continuación, seleccione Origen push para cargar su trabajo en la rama remota.
Para crear una solicitud de extracción, seleccione Crear solicitud de extracción.
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.
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.
