Usar a interface da Web do GitHub para criar uma página de documentação de origem

Este documento fornece etapas sobre como usar a interface da Web do GitHub para criar a documentação e enviar uma solicitação de pull (PR).

Configurar o ambiente do GitHub

A primeira etapa na configuração do ambiente do GitHub é navegar até o repositório do GitHub da Adobe Experience Platform.

Em seguida, selecione Bifurcação.

Quando a bifurcação estiver concluída, selecione mestre e digite um nome para a nova ramificação no menu suspenso que aparece. Forneça um nome descritivo para a ramificação, pois ele será usado para conter seu trabalho, e selecione criar ramificação.

Na estrutura de pastas GitHub do seu repositório bifurcado, navegue até experience-platform.en/help/sources/tutorials/api/create/ e selecione a categoria apropriada para a sua origem na lista. Por exemplo, se você estiver criando a documentação para uma nova origem do CRM, selecione crm.

Uma pasta de fontes CRM existentes é exibida. Para adicionar a documentação de uma nova origem, selecione Adicionar arquivo e selecione Criar novo arquivo no menu suspenso exibido.

Nomeie o arquivo de origem YOURSOURCE.md, onde YOURSOURCE é o nome da origem na Plataforma. Por exemplo, se sua empresa é o ACME CRM, seu nome de arquivo deve ser acme-crm.md.

Crie a página de documentação da sua fonte

Para começar a documentar sua nova fonte, cole o conteúdo do modelo de documentação de fontes no editor da Web do GitHub. Você também pode baixar o modelo aqui.

Com o modelo copiado para a interface do editor da Web do GitHub, siga as instruções descritas no modelo e edite os valores que contêm informações relevantes para a fonte.

Quando terminar, confirme o arquivo na ramificação.

Envie sua documentação para revisão

Depois que o arquivo for confirmado, você poderá abrir uma solicitação de pull (PR) para mesclar a ramificação de trabalho com a ramificação mestre do repositório da documentação do Adobe. Verifique se a ramificação em que você está trabalhando está selecionada e selecione Solicitação de comparação e extração.

Certifique-se de que as ramificações base e de comparação estejam corretas. Adicione uma observação à PR, descrevendo sua atualização e selecione Criar solicitação de pull. Isso abre uma PR para mesclar a ramificação de trabalho do seu trabalho na ramificação mestre do repositório Adobe.

Nesse momento, é exibida uma notificação solicitando que você assine o Contrato de licença de colaborador (CLA) do Adobe. Essa é uma etapa obrigatória. Depois de assinar o CLA, atualize a página da PR e envie a solicitação de pull.

É possível confirmar se a solicitação de pull foi enviada ao inspecionar a guia pull requests em https://github.com/AdobeDocs/experience-platform.en.