Documente su destino en Adobe Experience Platform
Información general overview
Bienvenido a Adobe Experience Platform. ¡Encantado de tenerle aquí!
Documentar el destino es el paso final antes de poder configurarlo 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 para que la rellene en su destino;
- Instrucciones generales sobre el uso de Markdown;
- Instrucciones específicas para el sabor del Adobe Markdown (el sabor del Adobe Markdown es muy similar al Markdown normal).
- Una página de prácticas recomendadas que le ayudará a crear una página de documentación para su página de destino que cumpla los estándares de calidad de Experience Platform.
Requisitos previos prerequisites
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ístrate en GitHub si aún no tienes una cuenta.
- Escritorio de GitHub. Si decide crear la documentación en su entorno local, debe usar GitHub Desktop.
- 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 generales para crear documentación para su destino en Adobe Experience Platform high-level-instructions
En un nivel superior, para crear documentación para tu destino, necesitas crear una ramificación del repositorio de documentación de Adobe Experience Platform y editar la plantilla de documentación proporcionada en una nueva rama. 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 encuentran más abajo, en Pasos para crear la nueva página de destino.
Plantilla de documentación documentation-template
Para ayudarle a crear su página de documentación, Adobe ha rellenado previamente una plantilla de documentación para usted. Más adelante, encontrará instrucciones sobre cómo editar la plantilla y abrir una solicitud de extracción. El equipo de documentación de Adobe revisará y publicará la documentación del nuevo destino.
Descargue la plantilla aquí y descomprima el archivo para extraer el archivo yourdestination.md.
A continuación, se proporcionan instrucciones sobre el uso de la plantilla para crear la página de documentación.
Pasos para crear la nueva página de destino steps-to-create-docs-page
Puede utilizar la interfaz web de GitHub o el entorno local para crear documentación para el nuevo destino en Adobe Experience Platform. Encuentre instrucciones para ambas opciones en los siguientes vínculos:
Prácticas recomendadas best-practices
Revise las prácticas recomendadas de creación antes y durante la creación de la página de documentación de destino. Asegúrese de leer también las instrucciones de escritura para la documentación de Adobe para obtener más sugerencias de escritura que el equipo de documentación de Adobe usa al crear la documentación.