Documentar el destino en Adobe Experience Platform

Información general

Bienvenido a Adobe Experience Platform, bueno de tenerte aquí!
La documentación del destino es el último paso para que se pueda establecer en Adobe Experience Platform.

Esta sección de documentación incluye:

• Instrucciones paso a paso para crear una página de documentación para el nuevo destino;
• Una plantilla que puede rellenar para su destino;
• Instrucciones generales sobre el uso de Markdown;
• Instrucciones específicas para el sabor de Markdown del Adobe (el sabor del Adobe Markdown es muy similar al de Markdown normal).
• A página prácticas recomendadas para ayudarle a crear una página de documentación para su página de destino, que cumpla los estándares de calidad de la documentación del Experience Platform.

Requisitos previos

Para crear documentación para el destino según las instrucciones de este artículo, son necesarios los siguientes elementos:

• Una cuenta de GitHub. Regístrese para GitHub si todavía no tiene una cuenta.
• Escritorio de GitHub. Si selecciona cree la documentación en el entorno local, debe usar Escritorio de GitHub.
• La integración con Adobe debe estar en una fase de prueba con el destino implementado en un entorno de ensayo en Adobe Experience Platform.

Instrucciones de alto nivel para crear documentación para su destino en Adobe Experience Platform

En un nivel superior, para crear documentación para el destino, debe crear una ramificación del repositorio de documentación de Adobe Experience Platform y edite el plantilla de documentación proporcionada en una rama nueva. Utilice la plantilla proporcionada por el Adobe para crear una nueva página de destino. Abra una solicitud de extracción (PR) cuando esté listo. Las instrucciones para hacerlo se detallan a continuación, en Pasos para crear la nueva página de destino.

Plantilla de documentación

Para ayudarle a crear su página de documentación, Adobe ha rellenado previamente un plantilla de documentación para usted. Más abajo, puede encontrar instrucciones para editar la plantilla y abrir una solicitud de extracción. El equipo de documentación de Adobe revisará y publicará la documentación de su nuevo destino.

Descargue la plantilla aquí y descomprima el archivo para extraer el yourdestination.md archivo.

A continuación se ofrecen instrucciones sobre el uso de la plantilla para crear la página de documentación.

Pasos para crear la nueva página de destino

Puede utilizar la interfaz web de GitHub o el entorno local para crear documentación para el nuevo destino en Adobe Experience Platform. Busque instrucciones para ambas opciones en los vínculos siguientes:

• Utilice la interfaz web de GitHub para crear una página de documentación de destino
• Utilice un editor de texto en el entorno local para crear una página de documentación de destino

Prácticas recomendadas

Consulte la prácticas recomendadas de creación antes y mientras crea la página de documentación de destino. Asegúrese de leer también el guía de escritura para la documentación de Adobe para obtener más sugerencias de escritura que utiliza el equipo de documentación de Adobe al crear la documentación.