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).

TIP
Os seguintes documentos do guia de contribuição do Adobe podem ser usados para apoiar ainda mais o processo de documentação:

Configurar o ambiente do GitHub

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

platform-repo

Em seguida, selecione Bifurcar.

bifurcação

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

create-branch

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

TIP
Se estiver criando a documentação da interface do usuário, navegue até experience-platform.en/help/sources/tutorials/ui/create/ e selecione a categoria apropriada para sua origem. Para adicionar imagens, navegue até experience-platform.en/help/sources/images/tutorials/create/sdk em seguida, adicione suas capturas de tela à sdk pasta.

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.

create-new-file

Nomeie seu arquivo de origem YOURSOURCE.md onde YOURSOURCE é o nome da origem na Platform. Por exemplo, se sua empresa for ACME CRM, o nome do arquivo deverá ser acme-crm.md.

git-interface

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 origens no editor da Web do GitHub. Também é possível 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.

cole-template

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

confirmar

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 Comparar e extrair solicitação.

compare-pr

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

TIP
Deixe a Permitir edições pelos mantenedores caixa de seleção marcada para garantir que a equipe de documentação do Adobe possa fazer edições na PR.

create-pr

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.

confirm-pr

recommendation-more-help
337b99bb-92fb-42ae-b6b7-c7042161d089