Documentar sua origem
Criado para:
- Desenvolvedor
A etapa final antes que a nova fonte possa ser definida como ativa no Adobe Experience Platform é documentar a nova fonte.
Este guia de documentação inclui:
- Um tutorial que você pode seguir para criar uma página de documentação para sua nova fonte;
- Um modelo de documentação que você deve preencher para sua nova fonte;
- Instruções sobre como usar o Markdown para escrever a documentação técnica;
- Instruções sobre como entender o sabor do Adobe Markdown.
Pré-requisitos
Os seguintes itens são necessários antes de você começar a documentar sua nova origem:
- Uma conta de usuário GitHub válida: se você não tiver uma conta GitHub existente, crie uma por meio da página de inscrição do GitHub;
- Acesso ao GitHub Desktop: você deve usar o aplicativo GitHub Desktop para criar sua documentação de origem em seu ambiente local;
- Sua integração com o Adobe deve estar em uma fase de teste com sua fonte implantada em um ambiente de preparo no Experience Platform.
Instruções de alto nível para criar a documentação para sua origem no Experience Platform
Em um alto nível, para criar a documentação para sua origem, você precisa criar uma bifurcação do repositório de documentação do Experience Platform e editar o modelo de documentação fornecido em uma nova ramificação. Use o modelo fornecido pela Adobe para criar uma nova página de origem e abrir uma solicitação de pull (PR) quando estiver pronto. As instruções para fazer isso estão mais abaixo, nas etapas para criar sua nova página de origem.
Modelo de documentação
Você pode usar um modelo de documentação preenchido previamente para ajudar a criar a documentação para sua origem. Mais abaixo, você pode encontrar instruções sobre como editar o modelo e abrir uma solicitação de pull. A documentação enviada para sua nova fonte será revisada e publicada pela equipe de documentação da Adobe.
Você também pode baixar os modelos de documentação abaixo:
Criar sua nova página de origem
Você pode usar a interface da Web do GitHub ou seu ambiente local para criar a documentação para sua nova origem no Experience Platform. Encontre instruções para ambas as opções nos links abaixo: