-
Notifications
You must be signed in to change notification settings - Fork 100
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #62 from Italox/traducao-how-to-write-a-stub
translate: how-to-write-a-stub.md
- Loading branch information
Showing
1 changed file
with
11 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,33 +1,29 @@ | ||
--- | ||
title: How to Write a Stub | ||
title: Como escrever um esboço | ||
--- | ||
|
||
Sometimes you might have an idea for a Gatsby.js documentation page or agree upon a suggestion in a GitHub issue, but don't have the time or resources to write that page yourself. Rather than let the idea drift off into space, consider **creating a documentation stub** to act as a content placeholder. That way, other members of the community (and/or you, in the future) can come back and fill in the details. | ||
Ás vezes você pode ter uma ideia para uma página da documentação do Gatsby.js ou concordar com uma sugestão para um problema no GitHub, mas você não tem tempo ou recursos para escrever essa página. Ao invés de deixar sua ideia sumir no espaço, considere **criar um esboço de documentação** para servir como um inicio de conteúdo. Dessa maneira, outros membros da comunidade (e/ou você, no futuro) podem retornar a este esboço e preenchê-lo com detalhes. | ||
|
||
A **stub** is a temporary placeholder for a piece of Gatsby.js documentation tied to a GitHub issue, using this format (feel free to copy and paste, changing the title and issue number): | ||
Um **esboço** é um espaço temporário reservado na documentação do Gatsby.js atrelado a uma issue no GitHub, usando este formato (sinta-se livre para copiar e colar, mudando o título e número da issue): | ||
|
||
```markdown:title=how-to-tame-dragons.md | ||
--- | ||
title: How to Tame Dragons | ||
issue: https://github.com/gatsbyjs/gatsby/issues/XXXX | ||
--- | ||
This is a stub. Help our community expand it. | ||
Este é um esboço. Ajude nossa comunidade a expandi-lo. | ||
Please use the [Gatsby Style Guide](/contributing/gatsby-style-guide/) to ensure your | ||
pull request gets accepted. | ||
Por favor use o [Guia de Estilo do Gatsby](/contributing/gatsby-style-guide/) para garantir que seu pull request será aceito. | ||
``` | ||
Se você tiver qualquer pergunta sobre títulos ou outros detalhes relacionados a criação de esboços, sinta-se livre para nos perguntar em uma issue relevante no GitHub. | ||
|
||
If you have any questions about titles or other details related to creating stubs, feel free to ask us on a relevant GitHub issue. | ||
## Sessões de Programação em Pares da Comunidade | ||
|
||
## Community Pair Programming Sessions | ||
Se você criou ou viu um esboço no Gatsby.js e sentiu-se interessado em adicionar o conteúdo, verifique o [Programa de Programação em Pares](/contributing/pair-programming/) do Gatsby.js. Nós adoraremos trabalhar com você em nossa jornada de contribuição para o open source. | ||
|
||
If you create a stub or see an existing one on the Gatsby.js site and feel interested in filling out the content, check out the Gatsby.js | ||
[Pair Programming program](/contributing/pair-programming/). We would love to work with you in your open source contributing journey! | ||
## Convertendo um Esboço para uma Documentação | ||
|
||
## Converting a Stub to a Doc | ||
Para converter um esboço em uma documentação real, remova a palavra `issue` do frontmatter (palavra chique para dados Markdown) do esboço e substitua o modelo de conteúdo inicial com o seu texto e código. Salve o arquivo, commit no GitHub, abra um PR, receba comentários. Aprenda mais em nossa página sobre [contribuições com documentação](/contributing/docs-contributions/). | ||
|
||
To change a stub into a living-breathing document, remove the `issue` entry from a stub's frontmatter (a fancy name for Markdown metadata) and replace the boilerplate content with | ||
your wonderful prose and code. Save the file, commit to GitHub, open a PR, get feedback. Learn more in our page on [docs contributions](/contributing/docs-contributions/). | ||
|
||
If you wish to see any of the available stubs, head over to the current [Stub List](/contributing/stub-list/). | ||
Se você deseja ver os esboços disponíveis, confira nossa [lista de esboços](/contributing/stub-list/). |