You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Update README-pt.md
- Update README-pt.md following the latest english version.
- fix typos
* Update README-pt.md
- Minor typo
- Typo in "Francês"
- Suggestion for readability and grammar accuracy.
- Some suggestions for accuracy + verbiage used in the Portuguese localizat ion.
- Minor text adjustment.
- Adjustments for consistency with the English version
Co-authored-by: Mauren Berti <[email protected]>
Co-authored-by: Mauren Berti <[email protected]>
---------
Co-authored-by: Mauren Berti <[email protected]>
Bem-vindos! Este repositório contém todos os recursos necessários para criar o [website e documentação do Kubernetes](https://kubernetes.io/). Estamos muito satisfeitos por você querer contribuir!
5
+
Este repositório contém todos os recursos necessários para criar o [website e documentação do Kubernetes](https://kubernetes.io/). Ficamos felizes por você querer contribuir!
6
6
7
-
# Utilizando este repositório
7
+
##Utilizando este repositório
8
8
9
-
Você pode executar o website localmente utilizando o Hugo (versão Extended), ou você pode executa-ló em um container runtime. É altamente recomendável utilizar um container runtime, pois garante a consistência na implantação do website real.
9
+
Você pode executar o website localmente utilizando o [Hugo (versão Extended)](https://gohugo.io/), ou você pode executá-lo em um agente de execução de contêiner. É altamente recomendável utilizar um agente de execução de contêiner, pois este fornece consistência de implantação em relação ao website real.
O website do Kubernetes utiliza o [tema Docsy Hugo](https://github.com/google/docsy#readme). Mesmo se você planeje executar o website em um container, é altamente recomendado baixar os submódulos e outras dependências executando o seguinte comando:
27
+
O website do Kubernetes utiliza o [tema Docsy Hugo](https://github.com/google/docsy#readme). Mesmo que você planeje executar o website em um contêiner, é altamente recomendado baixar os submódulos e outras dependências executando o seguinte comando:
28
28
29
-
```
30
-
# Baixar o submódulo Docsy
29
+
## Windows
30
+
31
+
```powershell
32
+
# Obter dependências e outros submódulos
31
33
git submodule update --init --recursive --depth 1
32
34
```
33
35
36
+
## Linux / outros Unix
37
+
38
+
```bash
39
+
# Obter dependências e outros submódulos
40
+
make module-init
41
+
```
42
+
34
43
## Executando o website usando um container
35
44
36
-
Para executar o build do website em um container, execute o comando abaixo para criar a imagem do container e executa-lá:
45
+
Para executar o build do website em um contêiner, execute o comando abaixo:
37
46
38
-
```
39
-
make container-image
47
+
```bash
48
+
# Você pode definir a variável $CONTAINER_ENGINE com o nome do agente de execução de contêiner utilizado.
40
49
make container-serve
41
50
```
42
51
52
+
Caso ocorram erros, é provável que o contêiner que está executando o Hugo não tenha recursos suficientes. A solução é aumentar a quantidade de CPU e memória disponível para o Docker ([MacOSX](https://docs.docker.com/docker-for-mac/#resources) e [Windows](https://docs.docker.com/docker-for-windows/#resources)).
53
+
43
54
Abra seu navegador em http://localhost:1313 para visualizar o website. Conforme você faz alterações nos arquivos fontes, o Hugo atualiza o website e força a atualização do navegador.
44
55
45
56
## Executando o website localmente utilizando o Hugo
@@ -54,39 +65,29 @@ npm ci
54
65
make serve
55
66
```
56
67
57
-
Isso iniciará localmente o Hugo na porta 1313. Abra o seu navegador em http://localhost:1313 para visualizar o website. Conforme você faz alterações nos arquivos fontes, o Hugo atualiza o website e força uma atualização no navegador.
68
+
O Hugo iniciará localmente na porta 1313. Abra o seu navegador em http://localhost:1313 para visualizar o website. Conforme você faz alterações nos arquivos fontes, o Hugo atualiza o website e força uma atualização no navegador.
58
69
59
70
## Construindo a página de referência da API
60
71
61
72
A página de referência da API localizada em `content/en/docs/reference/kubernetes-api` é construída a partir da especificação do Swagger utilizando https://github.com/kubernetes-sigs/reference-docs/tree/master/gen-resourcesdocs.
62
73
63
74
Siga os passos abaixo para atualizar a página de referência para uma nova versão do Kubernetes:
64
75
65
-
OBS: modifique o "v1.20" no exemplo a seguir pela versão a ser atualizada
66
-
67
-
1. Obter o submódulo `kubernetes-resources-reference`:
76
+
1. Obter o submódulo `api-ref-generator`:
68
77
69
78
```
70
79
git submodule update --init --recursive --depth 1
71
80
```
72
81
73
-
2.Criar a nova versão da API no submódulo e adicionar à especificação do Swagger:
4. Ajustar os arquivos `toc.yaml` e `fields.yaml` para refletir as mudanças entre as duas versões.
88
+
3. Ajustar os arquivos `toc.yaml` e `fields.yaml` para refletir as mudanças entre as duas versões.
88
89
89
-
5. Em seguida, gerar as páginas:
90
+
4. Em seguida, gerar as páginas:
90
91
91
92
```
92
93
make api-reference
@@ -101,7 +102,7 @@ make container-serve
101
102
102
103
Abra o seu navegador em http://localhost:1313/docs/reference/kubernetes-api/ para visualizar a página de referência da API.
103
104
104
-
6. Quando todas as mudanças forem refletidas nos arquivos de configuração `toc.yaml` e `fields.yaml`, crie um pull request com a nova página de referência de API.
105
+
5. Quando todas as mudanças forem refletidas nos arquivos de configuração `toc.yaml` e `fields.yaml`, crie um pull request com a nova página de referência de API.
105
106
106
107
## Troubleshooting
107
108
### error: failed to transform resource: TOCSS: failed to transform "scss/main.scss" (text/x-scss): this feature is not available in your current Hugo version
Verifique a quantidade de memória disponível para o agente de execução de contêiner. No caso do Docker Desktop para macOS, abra o menu "Preferences..." -> "Resources..." e tente disponibilizar mais memória.
155
156
156
-
# Comunidade, discussão, contribuição e apoio
157
+
##Comunidade, discussão, contribuição e apoio
157
158
158
159
Saiba mais sobre a comunidade Kubernetes SIG Docs e reuniões na [página da comunidade](http://kubernetes.io/community/).
159
160
160
-
Você também pode entrar em contato com os mantenedores deste projeto em:
161
+
Você também pode entrar em contato com os mantenedores deste projeto utilizando:
161
162
162
-
-[Slack](https://kubernetes.slack.com/messages/sig-docs) ([Obter o convide para o este slack](https://slack.k8s.io/))
Você pode clicar no botão **Fork** na área superior direita da tela para criar uma cópia desse repositório na sua conta do GitHub. Esta cópia é chamada de *fork*. Faça as alterações desejadas no seu fork e, quando estiver pronto para enviar as alterações para nós, vá até o fork e crie um novo **pull request** para nos informar sobre isso.
168
170
@@ -179,10 +181,27 @@ Para mais informações sobre como contribuir com a documentação do Kubernetes
179
181
*[Guia de Estilo da Documentação](http://kubernetes.io/docs/contribute/style/style-guide/)
180
182
*[Localizando documentação do Kubernetes](https://kubernetes.io/docs/contribute/localization/)
181
183
182
-
Você pode contatar os mantenedores da localização em Português em:
184
+
### Embaixadores para novos colaboradores
185
+
186
+
Caso você precise de ajuda em algum momento ao contribuir, os [Embaixadores para novos colaboradores](https://kubernetes.io/docs/contribute/advanced/#serve-as-a-new-contributor-ambassador) são pontos de contato. São aprovadores do SIG Docs cujas responsabilidades incluem orientar e ajudar novos colaboradores em seus primeiros pull requests. O melhor canal para contato com embaixadores é o [Slack do Kubernetes](https://slack.k8s.io/). Atuais Embaixadores do SIG Docs:
Você pode contatar os mantenedores da localização em Português no canal do Slack [#kubernetes-docs-pt](https://kubernetes.slack.com/messages/kubernetes-docs-pt).
0 commit comments