source-git-commit | workflow-type | source-wordcount | ht-degree |
---|---|---|---|
b151aac666510594751937e80dc3d9db4ede41b7 |
tm+mt |
815 |
1% |
Este site contém a documentação mais recente para o desenvolvedor do Commerce na Infraestrutura em nuvem.
- Guia da Infraestrutura do Commerce na Nuvem
- Introdução ao Commerce na infraestrutura em nuvem
Este projeto adotou o Código de conduta do Adobe Open Source. Para obter mais informações, consulte o artigo Contribuição.
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:
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.
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 da Adobe.
Se você fizer parte da comunidade da 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.
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
.
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.
Todos os artigos neste repositório usam GitHub flavored markdown. Se não estiver familiarizado com a marcação, consulte:
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, ferramentas de CLI da nuvem, configurações de serviço)
Os exemplos de conteúdo de modelo incluem, entre outros, os seguintes:
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] (_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 Liquidhelp/_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 do 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:
-
No editor de texto, abra um arquivo de dados no diretório
_jekyll/_data
. Por exemplo:- Referência da CLI da nuvem:
_jekyll/_data/cloud-cli-ref.yaml
- Pacotes na nuvem:
_jekyll/_data/cloud-packages.yaml
- Referência de ferramentas ECE:
_jekyll/_data/ece-tools.yaml
- Referência da CLI da nuvem:
-
Use a estrutura YAML existente para criar entradas.
-
Navegue até o diretório
_jekyll
.cd _jekyll
-
Gere conteúdo de modelo e grave a saída no diretório
help/_includes/templated
.bundle exec 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 comandobundle install
. As tarefas do rake são fornecidas pela gemadobe-comdox-exl-rake-tasks
para melhor manutenção nos repositórios de documentação da Adobe Commerce. -
Volte para o diretório
root
.cd ..
-
Verifique se os
help/_includes/templated
arquivos esperados foram modificados.git status
Você deve ver uma saída semelhante à seguinte:
modified: _data/cloud-cli-ref.yaml modified: help/_includes/templated/cloud-cli-ref.md
-
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.
Este repositório usa tarefas do rake fornecidas pela gem adobe-comdox-exl-rake-tasks
. Para ver todas as tarefas disponíveis, execute:
cd _jekyll
bundle exec rake --tasks
Esse repositório inclui ganchos de pré-confirmação automatizados que otimizam imagens antes da confirmação. Todos os colaboradores devem habilitar esses ganchos para garantir uma otimização de imagem consistente e um tamanho de repositório reduzido.
Após clonar o repositório, execute:
.githooks/setup-hooks.sh
- Detectar automaticamente arquivos de imagem preparados (PNG, JPG, JPEG, GIF, SVG)
- Executar
image_optim
para compactar e otimizar imagens - Transferir imagens otimizadas automaticamente
- Garantir que todas as imagens confirmadas estejam corretamente otimizadas
- Tamanho reduzido do repositório
- Carregamentos de página mais rápidos para a documentação
- Qualidade de imagem consistente em todos os colaboradores
- Não é necessária otimização manual
Para obter instruções detalhadas de instalação, solução de problemas e configuração, consulte .githooks/README.md
.