source-git-commit	workflow-type	source-wordcount	ht-degree
a6086afc0a1f099b62014ad61098a5a1dc9d4675	tm+mt	719	3%

Documentação técnica do Adobe Commerce

Agradecemos as contribuições da comunidade e de funcionários da Adobe de fora das equipes de documentação.

Código de conduta do Adobe Open Source

Este projeto adotou o Código de conduta de código aberto da Adobe ou o Código de conduta do .NET Foundation. Para obter mais informações, consulte o artigo Contribuição.

Sobre suas contribuições para o conteúdo do Adobe

Consulte o Guia do colaborador do Adobe Docs.

A forma como você contribui depende de quem você é e do tipo de alterações com as quais deseja contribuir:

Pequenas alterações

Se você estiver contribuindo com pequenas atualizações, visite o artigo e clique na área de feedback que aparece na parte inferior do artigo, clique em Opções de feedback detalhadas e em Sugerir uma edição para ir para o arquivo de origem do Markdown no GitHub. Use a interface do GitHub para fazer suas atualizações. Consulte o guia geral do colaborador do Adobe Docs para obter mais informações.

As pequenas correções ou esclarecimentos que você envia para documentação e exemplos de código neste repositório são cobertos pelos termos de uso do Adobe.

Grandes alterações ou novos artigos de membros da comunidade

Se você fizer parte da comunidade Adobe e quiser criar um novo artigo ou enviar grandes alterações, use a guia Problemas no repositório Git para enviar um problema e iniciar uma conversa com a equipe de documentação. Depois de concordar com um plano, você precisará trabalhar com um funcionário para ajudá-lo a inserir o novo conteúdo por meio de uma combinação de trabalho nos repositórios públicos e privados.

Grandes mudanças dos funcionários do Adobe

Se você for um autor técnico, gerente de programa ou desenvolvedor da equipe de produtos de uma solução da Adobe Experience Cloud e seu trabalho for contribuir com ou criar artigos técnicos, deverá usar o repositório privado em https://git.corp.adobe.com/AdobeDocs.

Ferramentas e configuração

Os colaboradores da comunidade podem usar a interface do usuário do GitHub para a edição básica ou bifurcar o repositório para fazer grandes contribuições.

Consulte o Guia do colaborador do Adobe Docs para obter mais detalhes.

Como usar marcação para formatar seu tópico

Todos os artigos neste repositório usam GitHub flavored markdown. Se não estiver familiarizado com a marcação, consulte:

• Noções básicas do Markdown
• Cheatsheet de markdown para impressão

Modelos

Para alguns tópicos, usamos arquivos de dados e modelos para gerar conteúdo publicado. Os casos de uso para essa abordagem incluem:

• Publicação de grandes conjuntos de conteúdo gerado de forma programática
• Fornecer uma única fonte da verdade para clientes em vários sistemas que exigem formatos de arquivo legíveis por máquina, como YAML, para integração (por exemplo, ferramenta de análise que abrange todo o site)

Os exemplos de conteúdo de modelo incluem, entre outros, os seguintes:

• Referência de ferramentas da CLI
• Tabelas de disponibilidade de produtos
• Tabelas de requisitos do sistema

Gerar conteúdo em modelo

Em geral, a maioria dos autores só precisa adicionar uma versão de lançamento às tabelas de disponibilidade de produtos e requisitos do sistema. A manutenção de todos os outros conteúdos em modelos é automatizada ou gerenciada por um membro dedicado da equipe. Estas instruções são destinadas para a maioria dos escritores.

OBSERVAÇÃO:

• A geração de conteúdo de modelo requer o trabalho na linha de comando em um terminal.
• É necessário ter o Ruby instalado para executar o script de renderização. Consulte _jekyll/.ruby-version para obter a versão necessária.

Consulte o seguinte para obter uma descrição da estrutura do arquivo para conteúdo de modelos:

• _jekyll — Contém tópicos de modelo e ativos necessários
• _jekyll/_data — Contém os formatos de arquivo legíveis por máquina usados para renderizar modelos
• _jekyll/templated—Contém arquivos de modelo baseados em HTML que usam a linguagem de modelo Liquid
• help/_includes/templated — Contém a saída gerada para conteúdo de modelo no formato de arquivo .md para que possa ser publicada nos tópicos de Experience League; o script de renderização grava automaticamente a saída gerada nesse diretório para você

Para atualizar o conteúdo do modelo:

1. No editor de texto, abra um arquivo de dados no diretório /jekyll/_data. Por exemplo:

   • Tabelas de disponibilidade de produtos: /jekyll/_data/product-availability.yml
   • Tabelas de requisitos do sistema: /jekyll/_data/system-requirements.yml

2. Use a estrutura YAML existente para criar entradas.

   Por exemplo, para adicionar uma versão do Adobe Commerce às tabelas de disponibilidade de produtos, adicione o seguinte a cada entrada nas seções extensions e services do arquivo /jekyll/_data/product-availability.yml (modifique os números de versão conforme necessário):

   support:
      - core: 1.2.3
        version: 4.5.6
   

3. Navegue até o diretório _jekyll.

   cd _jekyll
   

4. Gere conteúdo de modelo e grave a saída no diretório help/_includes/templated.

   rake render
   

   OBSERVAÇÃO: você deve executar o script a partir do diretório _jekyll. Se esta for a primeira vez que você executa o script, instale primeiro as dependências de Ruby com o comando bundle install.

5. Volte para o diretório root.

   cd ..
   

6. Verifique se os help/_includes/templated arquivos esperados foram modificados.

   git status
   

   Você deve ver uma saída semelhante à seguinte:

   modified:   _data/product-availability.yml
   modified:   help/_includes/templated/product-availability-extensions.md
   

7. Envie suas alterações.

   git add .
   git commit -m "descriptive message of the intended commit"
   git push
   

Consulte a documentação do Jekyll para obter mais detalhes sobre Arquivos de dados, Filtros líquidos e outros recursos.