138 lines
7.3 KiB
Markdown
138 lines
7.3 KiB
Markdown
# A documentação do Kubernetes
|
|
|
|
[](https://app.netlify.com/sites/kubernetes-io-master-staging/deploys) [](https://github.com/kubernetes/website/releases/latest)
|
|
|
|
Bem vindos! Este repositório abriga todos os recursos necessários para criar o [website e documentação do Kubernetes](https://kubernetes.io/). Estamos muito satisfeitos por você querer contribuir!
|
|
|
|
# Utilizando este repositório
|
|
|
|
Você pode executar o website localmente utilizando o Hugo (versão Extended), ou você pode executa-ló em um container runtime. É altamente recomendável usar um container runtime, pois garante a consistência na implantação do website real.
|
|
|
|
## Pré-requisitos
|
|
|
|
Para usar este repositório, você precisa instalar:
|
|
|
|
- [npm](https://www.npmjs.com/)
|
|
- [Go](https://golang.org/)
|
|
- [Hugo (versão Extended)](https://gohugo.io/)
|
|
- Um container runtime, por exemplo [Docker](https://www.docker.com/).
|
|
|
|
Antes de você iniciar, instale as dependências, clone o repositório e navegue até o diretório:
|
|
|
|
```
|
|
git clone https://github.com/kubernetes/website.git
|
|
cd website
|
|
```
|
|
|
|
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:
|
|
|
|
```
|
|
# Baixar o submódulo Docsy
|
|
git submodule update --init --recursive --depth 1
|
|
```
|
|
|
|
## Executando o website usando um container
|
|
|
|
Para executar o build do website em um container, execute o comando abaixo para criar a imagem do container e executa-lá:
|
|
|
|
```
|
|
make container-image
|
|
make container-serve
|
|
```
|
|
|
|
Abra seu navegador em http://localhost:1313 para visualizar o website. Conforme você faz alterações nos arquivos fontes, Hugo atualiza o website e força a atualização do navegador.
|
|
|
|
## Executando o website localmente utilizando o Hugo
|
|
|
|
Consulte a [documentação oficial do Hugo](https://gohugo.io/getting-started/installing/) para instruções de instalação do Hugo. Certifique-se de instalar a versão do Hugo especificada pela variável de ambiente `HUGO_VERSION` no arquivo [`netlify.toml`](netlify.toml#L9).
|
|
|
|
Para executar o build e testar o website localmente, execute:
|
|
|
|
```bash
|
|
# instalar dependências
|
|
npm ci
|
|
make serve
|
|
```
|
|
|
|
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.
|
|
|
|
## Troubleshooting
|
|
### 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
|
|
|
|
Por motivos técnicos, o Hugo é disponibilizado em dois conjuntos de binários. O website atual funciona apenas na versão **Hugo Extended**. Na [página de releases](https://github.com/gohugoio/hugo/releases) procure por arquivos com `extended` no nome. Para confirmar, execute `hugo version` e procure pela palavra `extended`.
|
|
|
|
### Troubleshooting macOS for too many open files
|
|
|
|
Se você executar o comando `make serve` no macOS e retornar o seguinte erro:
|
|
|
|
```
|
|
ERROR 2020/08/01 19:09:18 Error: listen tcp 127.0.0.1:1313: socket: too many open files
|
|
make: *** [serve] Error 1
|
|
```
|
|
|
|
Verifique o limite atual para arquivos abertos:
|
|
|
|
`launchctl limit maxfiles`
|
|
|
|
Em seguida, execute os seguintes comandos (adaptado de https://gist.github.com/tombigel/d503800a282fcadbee14b537735d202c):
|
|
|
|
```shell
|
|
#!/bin/sh
|
|
|
|
# Esse são os links do gist original, vinculados ao meu gists agora.
|
|
# curl -O https://gist.githubusercontent.com/a2ikm/761c2ab02b7b3935679e55af5d81786a/raw/ab644cb92f216c019a2f032bbf25e258b01d87f9/limit.maxfiles.plist
|
|
# curl -O https://gist.githubusercontent.com/a2ikm/761c2ab02b7b3935679e55af5d81786a/raw/ab644cb92f216c019a2f032bbf25e258b01d87f9/limit.maxproc.plist
|
|
|
|
curl -O https://gist.githubusercontent.com/tombigel/d503800a282fcadbee14b537735d202c/raw/ed73cacf82906fdde59976a0c8248cce8b44f906/limit.maxfiles.plist
|
|
curl -O https://gist.githubusercontent.com/tombigel/d503800a282fcadbee14b537735d202c/raw/ed73cacf82906fdde59976a0c8248cce8b44f906/limit.maxproc.plist
|
|
|
|
sudo mv limit.maxfiles.plist /Library/LaunchDaemons
|
|
sudo mv limit.maxproc.plist /Library/LaunchDaemons
|
|
|
|
sudo chown root:wheel /Library/LaunchDaemons/limit.maxfiles.plist
|
|
sudo chown root:wheel /Library/LaunchDaemons/limit.maxproc.plist
|
|
|
|
sudo launchctl load -w /Library/LaunchDaemons/limit.maxfiles.plist
|
|
```
|
|
|
|
Esta solução funciona tanto para o MacOS Catalina quanto para o MacOS Mojave.
|
|
|
|
# Comunidade, discussão, contribuição e apoio
|
|
|
|
Saiba mais sobre a comunidade Kubernetes SIG Docs e reuniões na [página da comunidade](http://kubernetes.io/community/).
|
|
|
|
Você também pode entrar em contato com os mantenedores deste projeto em:
|
|
|
|
- [Slack](https://kubernetes.slack.com/messages/sig-docs) ([Obter o convide para o este slack](https://slack.k8s.io/))
|
|
- [Mailing List](https://groups.google.com/forum/#!forum/kubernetes-sig-docs)
|
|
|
|
# Contribuindo com os documentos
|
|
|
|
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.
|
|
|
|
Depois que seu **pull request** for criado, um revisor do Kubernetes assumirá a responsabilidade de fornecer um feedback claro e objetivo. Como proprietário do pull request, **é sua responsabilidade modificar seu pull request para atender ao feedback que foi fornecido a você pelo revisor do Kubernetes.**
|
|
|
|
Observe também que você pode acabar tendo mais de um revisor do Kubernetes para fornecer seu feedback ou você pode acabar obtendo feedback de um outro revisor do Kubernetes diferente daquele originalmente designado para lhe fornecer o feedback.
|
|
|
|
Além disso, em alguns casos, um de seus revisores pode solicitar uma revisão técnica de um [revisor técnico do Kubernetes](https://github.com/kubernetes/website/wiki/Tech-reviewers) quando necessário. Os revisores farão o melhor para fornecer feedbacks em tempo hábil, mas o tempo de resposta pode variar de acordo com as circunstâncias.
|
|
|
|
Para mais informações sobre como contribuir com a documentação do Kubernetes, consulte:
|
|
|
|
* [Contribua com a documentação do Kubernetes](https://kubernetes.io/docs/contribute/)
|
|
* [Tipos de conteúdo de página](https://kubernetes.io/docs/contribute/style/page-content-types/)
|
|
* [Guia de Estilo da Documentação](http://kubernetes.io/docs/contribute/style/style-guide/)
|
|
* [Localizando documentação do Kubernetes](https://kubernetes.io/docs/contribute/localization/)
|
|
|
|
Você pode contatar os mantenedores da localização em Português em:
|
|
|
|
* Felipe ([GitHub - @femrtnz](https://github.com/femrtnz))
|
|
* [Slack channel](https://kubernetes.slack.com/messages/kubernetes-docs-pt)
|
|
|
|
# Código de conduta
|
|
|
|
A participação na comunidade Kubernetes é regida pelo [Código de Conduta da Kubernetes](code-of-conduct.md).
|
|
|
|
# Obrigado!
|
|
|
|
O Kubernetes conta com a participação da comunidade e nós realmente agradecemos suas contribuições para o nosso website e nossa documentação!
|