Assistentes
Menu
Feedback
Guias
Docs
Diretrizes de documentação
Diretrizes de contribuição
Diretrizes de contribuição

Sua ajuda é muito importante para a experiência de documentação da VTEX. Existem várias maneiras de contribuir, dependendo do portal em que você deseja colaborar e do método de sua preferência. Este guia explica como você pode contribuir para melhorar a documentação da VTEX:

Botão de feedback

Disponível em: Help Center e Developer Portal

Você pode enviar seu feedback sobre qualquer página dos portais de documentação clicando em Feedback no canto superior direito de cada portal.

{"base64":"  ","img":{"width":1893,"height":914,"type":"gif","mime":"image/gif","wUnits":"px","hUnits":"px","length":208667,"url":"https://vtexhelp.vtexassets.com/assets/docs/src/doc-feedback-form___21b3eb638614c18bf9b51f91e834a380.gif"}}

Ao clicar em "Feedback", uma nova janela do navegador será aberta com um formulário. Veja abaixo as informações que você precisa preencher no formulário de feedback:

  • Plataforma: selecione um dos seguintes portais para o qual deseja enviar seu feedback: Help Center, Developer Portal, ou VTEX Learning Center.
  • URL (opcional): se você deseja enviar feedback sobre uma página específica de um dos portais mencionados anteriormente, adicione a URL exata da página, por exemplo: https://developers.vtex.com/docs/guides/getting-started-with-storefront-solutions.
  • Tipo de feedback: escolha o tipo de feedback que deseja dar dentre as opções abaixo.
Tipo de feedbackDescrição
CommentDeixe um comentário sobre a documentação.
QuestionDescreva suas dúvidas sobre o conteúdo da documentação.
ErrorIndique informações incorretas no conteúdo da documentação ou se a página não estiver disponível.
ImprovementSugira melhorias de conteúdo.
  • Feedback: descreva seu feedback com base no tipo de feedback que você escolheu.
  • Suggestions (optional): faça uma sugestão para corrigir ou melhorar o conteúdo.
  • Attachment (optional): se você tiver arquivos complementares para compartilhar, como capturas de tela, imagens e planilhas, adicione-os nesta seção.
  • Follow-up: se quiser que a gente entre em contato com você sobre o seu feedback, selecione Sim. Na página seguinte do formulário, adicione seu nome e email para que possamos entrar em contato com você.

Isso foi útil?

Disponível em: Help Center e Developer Portal

Você pode enviar comentários sobre qualquer página dos portais de documentação respondendo à opção Isso foi útil? (Was this helpful?).

{"base64":"  ","img":{"width":1881,"height":777,"type":"gif","mime":"image/gif","wUnits":"px","hUnits":"px","length":2682081,"url":"https://vtexhelp.vtexassets.com/assets/docs/src/was-this-helpful___f7a0bfefa5147947c2bb4d11baa31e22.gif"}}

Você pode deixar um comentário sobre a página e explicar por que achou útil ou não. Clique em SEND FEEDBACK para enviar seu feedback.

Sugerir edições (GitHub)

Disponível em: Help Center e Developer Portal

Você pode colaborar em qualquer página dos portais de documentação clicando em Sugerir edições (GitHub) (Suggest edits).

{"base64":"  ","img":{"width":1881,"height":777,"type":"gif","mime":"image/gif","wUnits":"px","hUnits":"px","length":971251,"url":"https://vtexhelp.vtexassets.com/assets/docs/src/suggest-edits-github___fff6aa05ddc4031e99a38b84c1d91aeb.gif"}}

Ao clicar em Sugerir edições (GitHub) (Suggest edits), uma nova janela do navegador será aberta com a página do repositório de documentação. Siga estas etapas:

  1. Na página do repositório de documentação, edite o arquivo de documentação que corresponde às suas sugestões.

    Certifique-se de dar suas sugestões com base nos princípios das diretrizes de documentação e no código de conduta.

  2. Clique em Commit changes….

  3. No modal Propose changes, preencha as seguintes informações:

    Nome do campoDescrição
    Commit messageEscreva uma breve descrição do seu commit, por exemplo, Fix typo.
    Extended description (Optional)Escreva uma descrição com mais detalhes sobre o seu commit.
    Create a new branch for this commit and start a pull requestDê um nome à sua branch para que você possa abrir um pull request e a equipe possa revisar suas sugestões.
  4. Depois de preencher o modal, clique em Propose changes.

  5. Crie um pull request com suas alterações, seguindo os seguintes passos:

    {"base64":"  ","img":{"width":1642,"height":840,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":79854,"url":"https://vtexhelp.vtexassets.com/assets/docs/src/open-pull-request___2181e6b6116f8427f47435992da98723.png"}}

    Nome do campoDescrição
    Add a titleAdicione um título para seu pull request, incluindo o tipo de alteração, o nome do arquivo e o que você alterou, por exemplo, Fix (customer-credit-integration-guide.md): Documentation typos.
    Add a descriptionVerifique os tipos de alteração que estiver propondo: novo conteúdo, melhoria, ajuste ou correção ortográfica e gramatical. Além disso, fique à vontade para incluir mais detalhes na sua descrição para ajudar a equipe a analisá-la.
    ReviewersClique em Reviewers e escolha o grupo vtexdocs/vtex-education.
  6. Clique em Create pull request.

Após criar um pull request, nossa equipe analisará suas alterações o mais rápido possível e entrará em contato com você através dos comentários do pull request.

Pull requests são um processo colaborativo. Suas sugestões são valorizadas, mas a aprovação não é garantida. Esteja aberto a feedback e discussões.

Contribuidores
1
Photo of the contributor
+ 1 contributors
Isso foi útil?
Sim
Não
Sugerir edições (GitHub)
Títulos
« Previous
Visão geral da documentação
Next »
Contribuidores
1
Photo of the contributor
+ 1 contributors
Nesta página
GitHubCommunityFeedback