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

Última atualização: 5 de maio de 2025
  • Tópicos:

Criado para:

  • Desenvolvedor

Este documento fornece etapas sobre como usar seu ambiente local para criar documentação para sua fonte e enviar uma solicitação de pull (PR).

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

Pré-requisitos

O tutorial a seguir requer que o GitHub Desktop esteja instalado em sua máquina local. Se você não tiver o GitHub Desktop, poderá baixar o aplicativo aqui.

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

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

repositório-plataforma

Na página principal do repositório GitHub do Experience Platform, selecione Fork.

bifurcação

Para clonar o repositório no computador local, selecione Código. No menu suspenso exibido, selecione HTTPS e, em seguida, Abrir com o GitHub Desktop.

DICA
Para obter mais informações, consulte o tutorial sobre configuração do repositório Git localmente para a documentação.

open-git-desktop

Em seguida, aguarde alguns instantes para que o GitHub Desktop clone o repositório experience-platform.en.

clonagem

Quando o processo de clonagem for concluído, vá para o GitHub Desktop para criar uma nova ramificação. Selecione Mestre na navegação superior e selecione Nova ramificação

nova-ramificação

No painel pop-over exibido, digite um nome descritivo para a ramificação e selecione Criar ramificação.

criar-ramificação-vs

Em seguida, selecione Publicar ramificação.

publicar-ramificação

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

Com o repositório clonado em sua máquina local e uma nova ramificação criada, agora é possível começar a criar a página de documentação para sua nova fonte por meio do editor de texto de sua escolha.

A Adobe recomenda que você use o Visual Studio Code e instale a extensão de Criação do Adobe Markdown. Para instalar a extensão, inicie o Visual Studio Code e selecione a guia Extensões no menu de navegação esquerdo.

extensão

Em seguida, digite Adobe Markdown Authoring na barra de pesquisa e selecione Instalar na página exibida.

instalar

Com o computador local pronto, baixe o modelo de documentação de origem e extraia o arquivo para experience-platform.en/help/sources/tutorials/api/create/..., com [...] representando a categoria de sua escolha. Por exemplo, se você estiver criando uma origem de banco de dados, selecione a pasta do banco de dados.

Por fim, siga as instruções descritas no modelo e edite-o com as informações relevantes relacionadas à sua fonte.

editar-modelo

Envie sua documentação para revisão

Para criar uma solicitação de pull (PR) e enviar sua documentação para revisão, primeiro salve seu trabalho em Visual Studio Code (ou no editor de texto escolhido). Em seguida, usando o GitHub Desktop, insira uma mensagem de confirmação e selecione Confirmar para criar-origem-documentação.

confirmação-vs

Em seguida, selecione Origem de push para carregar seu trabalho na ramificação remota.

origem de push

Para criar uma solicitação de pull, selecione Criar solicitação de pull.

create-pr-vs

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 do Adobe.

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

create-pr

É 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