Usar um editor de texto no ambiente local para criar uma página de documentação de destino

As instruções desta página mostram como usar um editor de texto para trabalhar no ambiente local para criar 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.

Conecte-se ao GitHub e configure seu ambiente de criação local

  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. Clone o repositório no computador local. Selecione Code > HTTPS > Open with GitHub Desktop, conforme mostrado abaixo. Verifique se o GitHub Desktop está instalado. Para obter mais referência, leia Create a local clone of the repository no guia do colaborador do Adobe.

    Clone o repositório de documentação do Adobe para o ambiente local

  4. Na estrutura de arquivo local, navegue até experience-platform.en/help/destinations/catalog/[...], onde [...] é a categoria desejada para o destino. Por exemplo, se estiver adicionando um destino de personalização ao Experience Platform, selecione a pasta personalization.

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

  1. A página de documentação se baseia no modelo de destino de autoatendimento. Baixe o modelo de destino. Descompacte-o e extraia o arquivo yourdestination-template.md para o diretório mencionado na etapa 4 acima. Renomeie o arquivo 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.
  2. Abra o novo arquivo no editor de texto de escolha. O Adobe recomenda usar Visual Studio Code e instalar a extensão de criação do Adobe Markdown. Para instalar a extensão, abra o Código do Visual Studio, selecione a guia Extensions à esquerda da tela e procure por adobe markdown authoring. Selecione a extensão e clique em Install.
    Instalar a extensão de criação do Adobe Markdown
  3. Edite o modelo com informações relevantes para o seu destino. Siga as instruções no template.
  4. Para quaisquer capturas de tela ou imagens que planeje adicionar à sua documentação, vá para GitHub/experience-platform.en/help/destinations/assets/catalog/[...], onde [...] é a categoria desejada para o seu destino. Por exemplo, se estiver adicionando um destino de personalização ao Experience Platform, selecione a pasta personalization. Crie uma nova pasta para o seu destino e salve suas imagens aqui. Você deve vincular a eles a partir da página que está criando. Consulte instruções sobre como vincular a imagens.
  5. Quando estiver pronto, salve o arquivo em que você está trabalhando.

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. No GitHub Desktop, crie uma ramificação de trabalho para suas atualizações e selecione Publicar ramificação para publicar a ramificação no GitHub.

Nova ramificação local

  1. No GitHub Desktop, commit seu trabalho, conforme mostrado abaixo.

    Confirmar local

  2. No GitHub Desktop, empurre seu trabalho para a ramificação remota, conforme mostrado abaixo.

    Empurrar sua confirmação

  3. Na interface da Web do GitHub, abra 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

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

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

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

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