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

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

platform-repo

En la página principal del repositorio de Platform GitHub, seleccione Fork.

bifurcació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.

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

open-git-desktop

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

clonando

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

rama nueva

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

create-branch-vs

A continuación, seleccione rama de Publish.

rama de publicación

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

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

Adobe recomienda usar Visual Studio Code e instalar la extensión de Adobe Markdown Authoring. Para instalar la extensión, inicie Visual Studio Code y, a continuación, seleccione la ficha Extensiones en el panel de navegación izquierdo.

Extensión

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

instalar

Con el equipo local listo, descargue la plantilla de documentación de orígenes y extraiga el archivo en experience-platform.en/help/sources/tutorials/api/create/..., donde [...] 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.

editar-plantilla

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, primero guarde el trabajo en Visual Studio Code (o en el editor de texto que haya elegido). A continuación, con GitHub Desktop, introduzca un mensaje de confirmación y seleccione Confirmar para crear-documentación-origen.

compromiso frente a

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 las ramas base y de comparación son correctas. Agregue una nota al PR, describiendo su actualización, y luego 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.

TIP
Deje seleccionada la casilla de verificación Permitir ediciones por responsables para garantizar que el equipo de documentación de Adobe pueda realizar ediciones en la PR.

crear-pr

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.

confirmar-pr

recommendation-more-help
337b99bb-92fb-42ae-b6b7-c7042161d089