Utilice la interfaz web de GitHub para crear una página de documentación de destino :headding-anchor:github-interface
Las instrucciones siguientes muestran cómo utilizar la interfaz web de GitHub para crear documentación y enviar una solicitud de extracción (PR). Antes de seguir los pasos indicados aquí, asegúrate de leer Documentar tu destino en Destinos de Adobe Experience Platform.
Configuración del entorno de creación de GitHub :headding-anchor:set-up-environment
-
En su explorador, vaya a
https://github.com/AdobeDocs/experience-platform.en
. -
Para ramificar el repositorio, haga clic en Ramificar como se muestra a continuación. Esto crea una copia del repositorio de Experience Platform en su propia cuenta de GitHub.
-
En la ramificación del repositorio, cree una nueva rama para el proyecto, como se muestra a continuación. Utilice esta nueva rama para su trabajo.
-
En la estructura de carpetas de GitHub del repositorio ramificado, vaya a
experience-platform.en/help/destinations/catalog/[...]
, donde[...]
es la categoría deseada para el destino. Por ejemplo, si está agregando un destino de personalización al Experience Platform, seleccione la categoríapersonalization
. Seleccione Agregar archivo > Crear nuevo archivo. -
Asigne un nombre a su destino
YOURDESTINATION.md
, donde YOURDESTINATION es el nombre de su destino en Adobe Experience Platform. Por ejemplo, si su compañía se llama Moviestar, debe asignar un nombre al archivomoviestar.md
.
Crear la página de documentación de su destino :headding-anchor:author-documentation
-
Creará el contenido de su página de destino en función de la plantilla de autoservicio de documentación. Descargue la plantilla y descomprímala para extraer la plantilla de archivo
.md
. -
Pegue y edite el contenido de la plantilla con información relevante para su destino en un editor de markdown en línea, como dillinger.io. Siga las instrucciones de la plantilla para obtener más información sobre lo que debe rellenar y los párrafos que se pueden eliminar.
note tip TIP Puede cerrar la ventana del explorador en cualquier momento y volver a abrirla más tarde. Su trabajo se guarda automáticamente y le estará esperando cuando vuelva a abrir el explorador. 3. Copie el contenido del editor de markdown en el nuevo archivo en GitHub.
-
Para cualquier captura de pantalla o imagen que planee usar, use la interfaz de GitHub para cargar los archivos en
experience-platform.en/help/destinations/assets/catalog/[...]
, donde[...]
es la categoría deseada para el destino. Por ejemplo, si está agregando un destino de personalización al Experience Platform, seleccione la categoríapersonalization
. Debe vincular a las imágenes de la página que está creando. Vea instrucciones sobre cómo vincular a imágenes. -
Cuando esté listo, guarde el archivo en la rama.
Envíe su documentación para su revisión :headding-anchor:submit-review
- Después de guardar el archivo y cargar las imágenes deseadas, puede abrir 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 trabajó esté seleccionada y seleccione Contribute > Abrir solicitud de extracción.
-
Asegúrese de que las ramas base y de comparación son correctas. Agregue una nota al 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.
note tip TIP Deje seleccionada la casilla de verificación Permitir ediciones por responsables para que el equipo de documentación de Adobe pueda realizar ediciones en la PR. -
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.
-
Puede confirmar que la solicitud de extracción se ha enviado inspeccionando la ficha Solicitudes de extracción en
https://github.com/AdobeDocs/experience-platform.en
. -
¡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.