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

SUGERENCIA

Los siguientes documentos de la guía de contribución de Adobe se pueden utilizar para respaldar aún más su proceso de documentación:

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

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 al Repositorio de Adobe Experience Platform GitHub.

platform-repo

En la página principal del repositorio de Platform GitHub, seleccione Bifurcación (Fork).

Fork (Ramificación)

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.

SUGERENCIA

Para obtener más información, consulte el tutorial sobre configuración del repositorio de Git localmente para la documentación.

open-git-desktop

A continuación, espere unos momentos para que GitHub Desktop clone el experience-platform.en repositorio.

clonación

Una vez completado el proceso de clonación, vaya a GitHub Desktop para crear una rama nueva. Select Maestro en la barra de navegación superior y, a continuación, seleccione Nueva rama

rama nueva

En el panel emergente que aparece, introduzca un nombre descriptivo para la rama y, a continuación, seleccione Crear rama.

create-branch-vs

A continuación, seleccione Rama de publicación.

publish-branch

Cree la página de documentación para el origen

Con el repositorio clonado en el equipo local y una rama nueva creada, ahora puede empezar a crear la página de documentación para el nuevo origen a través del editor de texto de su elección.

Adobe recomienda usar 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 la variable Extensiones de la barra de navegación izquierda.

 Extensión

A continuación, introduzca Adobe Markdown Authoring en la barra de búsqueda y, a continuación, seleccione Instalar de la página que aparece.

instalar

Con el equipo local listo, descargue el plantilla de documentación de fuentes y extraer el archivo a experience-platform.en/help/sources/tutorials/api/create/... con [...] que representan la categoría que elija. Por ejemplo, si está creando un origen de base de datos, seleccione la carpeta de la base de datos.

Finalmente, siga las instrucciones descritas en la plantilla y edite la plantilla con la información relevante relacionada con su fuente.

edit-template

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 elegido). A continuación, con GitHub Desktop, introduzca un mensaje de confirmación y seleccione Confirmar para create-source-documentation.

commit-vs

A continuación, seleccione Origen push para cargar el trabajo en la rama remota.

push-origin

Para crear una solicitud de extracción, seleccione Crear solicitud de extracción.

create-pr-vs

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

SUGERENCIA

Deje el Permitir ediciones por parte de los administradores casilla de verificación seleccionada para garantizar que el equipo de documentación de Adobe pueda realizar modificaciones en PR.

create-pr

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

confirm-pr

En esta página