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

As instruções abaixo mostram como usar a interface da Web do GitHub para criar a documentação e enviar uma solicitação de pull (PR). Antes de passar pelas etapas indicadas aqui, leia Documentar seu destino em Destinos do Adobe Experience Platform.

Configurar o ambiente de criação do GitHub

  1. No navegador, navegue até https://github.com/AdobeDocs/experience-platform.en.

  2. Para bifurcar o repositório, clique em Bifurcar conforme mostrado abaixo. Isso cria uma cópia do repositório do Experience Platform em sua própria conta GitHub.

    Repositório de documentação do Fork Adobe

  3. Na bifurcação do repositório, crie uma nova ramificação para o projeto, conforme mostrado abaixo. Use esta nova ramificação para o seu trabalho.

    Criar nova ramificação do GitHub

  4. Na estrutura de pastas GitHub do repositório bifurcado, navegue até experience-platform.en/help/destinations/catalog/[...], onde [...] é a categoria desejada para o seu destino. Por exemplo, se estiver adicionando um destino de personalização ao Experience Platform, selecione a categoria personalization. Selecione Adicionar arquivo > Criar novo arquivo.

    Adicionar novo arquivo

  5. Nomeie seu destino YOURDESTINATION.md, onde YOURDESTINATION é o nome do seu destino no Adobe Experience Platform. Por exemplo, se sua empresa é chamada Moviestar, você nomearia o arquivo moviestar.md.

Crie a página de documentação para seu destino

  1. Você criará o conteúdo da página de destino com base no modelo de autoatendimento de documentação. 🔗 Baixe o template e descompacte-o para extrair o template .md de arquivo.

  2. Cole e edite o conteúdo do modelo com informações relevantes para seu destino em um editor de marcação online, como dillinger.io. Siga as instruções no modelo para obter detalhes sobre o que você deve preencher e quais parágrafos podem ser removidos.

    DICA

    Você pode fechar a janela do navegador a qualquer momento e reabrir mais tarde. Seu trabalho é salvo automaticamente e estará aguardando você ao reabrir o navegador.

  3. Copie o conteúdo do editor de marcação para o novo arquivo no GitHub.

  4. Para capturas de tela ou imagens que você planeja usar, use a interface do GitHub para fazer upload dos arquivos para experience-platform.en/help/destinations/assets/catalog/[...], onde [...] é a categoria desejada para seu destino. Por exemplo, se estiver adicionando um destino de personalização ao Experience Platform, selecione a categoria personalization. Você precisa vincular às imagens da página que está criando. Consulte instruções sobre como vincular a imagens.

    Upload de imagem no GitHub

  5. Quando estiver pronto, salve o arquivo na ramificação.

Confirmar criação do arquivo

Envie sua documentação para revisão

DICA

Observe que não há nada que você possa quebrar aqui. Ao seguir as instruções desta seção, você está apenas sugerindo uma atualização de documentação. Sua atualização sugerida será aprovada ou editada pela equipe de documentação da Adobe Experience Platform.

  1. Depois de salvar o arquivo e fazer upload das imagens desejadas, você pode abrir uma solicitação de pull (PR) para mesclar sua ramificação de trabalho na ramificação principal do repositório da documentação do Adobe. Verifique se a ramificação em que você trabalhou está selecionada e selecione Contribute > Abrir solicitação de pull.

Criar solicitação de pull

  1. Certifique-se de que as ramificações base e comparativas estejam corretas. Adicione uma nota ao PR, descrevendo sua atualização e selecione Criar solicitação de pull. Isso abre uma PR para mesclar a ramificação de trabalho da bifurcação na ramificação principal do repositório do Adobe.

    DICA

    Deixe a caixa de seleção Allow edits by maintainers selecionada para que a equipe de documentação do Adobe possa fazer edições no PR.

    Criar solicitação de pull para o repositório de documentação do Adobe

  2. Neste ponto, é exibida uma notificação solicitando que você assine o Contrato de licença de colaborador (CLA) do Adobe. Esta é uma etapa obrigatória. Após assinar o CLA, atualize a página do PR e envie a solicitação de pull.

  3. Você pode confirmar que a solicitação de pull foi enviada inspecionando a guia Solicitações de pull em https://github.com/AdobeDocs/experience-platform.en.

    PR bem-sucedido

  4. Obrigado! A equipe de documentação do Adobe entrará em contato com o PR caso alguma edição seja necessária e informará quando a documentação será publicada.

DICA

Para adicionar imagens e links à sua documentação e para quaisquer outras perguntas sobre o Markdown, leia Using Markdown no guia de escrita colaborativa do Adobe.

Nesta página