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

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 do Adobe podem ser usados para apoiar ainda mais o 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, é possível baixar o aplicativo aqui.

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

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

platform-repo

Na página principal do repositório GitHub da Platform, selecione Bifurcar.

bifurcação

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

DICA

Para obter mais informações, consulte o tutorial em 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 experience-platform.en repositório.

clonagem

Quando o processo de clonagem for concluído, vá para o GitHub Desktop para criar uma nova ramificação. Selecionar Principal no início da navegação 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.

create-branch-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 no computador 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 da editor de texto de sua escolha.

O Adobe recomenda usar Código do Visual Studio e que você instale a extensão Adobe Markdown Authoring. Para instalar a extensão, inicie o Visual Studio Code e selecione o Extensões do menu de navegação esquerdo.

extensão

Em seguida, insira 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 origens e extrair 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.

edit-template

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 no Visual Studio Code (ou o editor de texto escolhido). Em seguida, usando o GitHub Desktop, insira uma mensagem de confirmação e selecione Confirmar criação-origem-documentação.

commit-vs

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

push-origin

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 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 principal do repositório Adobe.

DICA

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

É 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

Nesta página