DocumentaçãoExperience PlatformGuia de destinos

Use um editor de texto em seu ambiente local para criar uma página de documentação de destino local-authoring

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Tópicos:

Criado para:

  • undefined
  • undefined

As instruções nesta página mostram como usar um editor de texto para trabalhar em seu ambiente local, criar documentação e enviar uma solicitação de pull (PR). Antes de seguir as etapas indicadas aqui, leia Documentar seu destino nos Destinos do Adobe Experience Platform.

TIP
Consulte também a documentação de suporte no guia do colaborador do Adobe:

Conectar-se ao GitHub e configurar o ambiente de criação local set-up-environment

  1. Em seu 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 Experience Platform em sua própria conta GitHub.

    Bifurcar repositório de documentação do Adobe

  3. Clonar o repositório no computador local. Selecione Código > HTTPS > Abrir com o GitHub Desktop, conforme mostrado abaixo. Verifique se você tem o GitHub Desktop instalado. Para referência adicional, leia Criar um clone local do repositório no guia do colaborador do Adobe.

    Clonar o repositório da documentação do Adobe para o ambiente local

  4. Na estrutura do arquivo local, 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 pasta personalization.

Crie a página de documentação do seu destino author-documentation

  1. Sua página de documentação é baseada no modelo de destino de autoatendimento. Baixe o modelo de destino. Descompacte e extraia o arquivo yourdestination-template.md no 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 se chama Moviestar, você chamaria seu arquivo de moviestar.md.
  2. Abra o novo arquivo em seu editor de texto preferido. A Adobe recomenda o uso do Visual Studio Code e a instalação da extensão Adobe Markdown Authoring. Para instalar a extensão, abra o Visual Studio Code, 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 template com informações relevantes para o seu destino. Siga as instruções no modelo.
  4. Para capturas de tela ou imagens que você planeja adicionar à 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 destino e salve as imagens aqui. Você deve vinculá-los 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 está trabalhando.

Envie sua documentação para revisão submit-review

TIP
Observe que não há nada que você possa quebrar aqui. Seguindo as instruções nesta seção, você está simplesmente sugerindo uma atualização da documentação. A 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 ramificação do Publish para publicar a ramificação no GitHub.

Nova ramificação local

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

    Confirmar local

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

    Enviar confirmação

  3. Na interface da Web do GitHub, abra uma solicitação de pull (PR) para mesclar a ramificação de trabalho à ramificação mestre do repositório de 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. Verifique se as ramificações base e de comparação estão 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 da sua bifurcação na ramificação mestre do repositório Adobe.

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

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

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

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

PR bem-sucedida

  1. Obrigado! A equipe de documentação do Adobe entrará em contato com o PR, caso seja necessário fazer alguma edição, e para informar quando a documentação será publicada.
TIP
Para adicionar imagens e links à sua documentação e para qualquer outra pergunta sobre o Markdown, leia Usando o Markdown no guia de gravação colaborativa do Adobe.
recommendation-more-help
7f4d1967-bf93-4dba-9789-bb6b505339d6