-
Notifications
You must be signed in to change notification settings - Fork 14.3k
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 #26404 from reylejano/merged-master-dev-1.21
Merge master into dev 1.21 - 2/5/2021
- Loading branch information
Showing
94 changed files
with
1,270 additions
and
695 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,76 +1,137 @@ | ||
# A documentação do Kubernetes | ||
|
||
[![Build Status](https://api.travis-ci.org/kubernetes/website.svg?branch=master)](https://travis-ci.org/kubernetes/website) | ||
[![GitHub release](https://img.shields.io/github/release/kubernetes/website.svg)](https://github.com/kubernetes/website/releases/latest) | ||
[![Netlify Status](https://api.netlify.com/api/v1/badges/be93b718-a6df-402a-b4a4-855ba186c97d/deploy-status)](https://app.netlify.com/sites/kubernetes-io-master-staging/deploys) [![GitHub release](https://img.shields.io/github/release/kubernetes/website.svg)](https://github.com/kubernetes/website/releases/latest) | ||
|
||
Bem vindos! Este repositório abriga todos os recursos necessários para criar o [site e documentação do Kubernetes](https://kubernetes.io/). Estamos muito satisfeitos por você querer contribuir! | ||
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! | ||
|
||
## Contribuindo com os documentos | ||
# Utilizando este repositório | ||
|
||
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 uma nova solicitação de pull para nos informar sobre isso. | ||
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. | ||
|
||
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 abordar o 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 revisor do Kubernetes que é diferente daquele originalmente designado para lhe fornecer feedback. Além disso, em alguns casos, um de seus revisores pode solicitar uma revisão técnica de um [revisor de tecnologia Kubernetes](https://github.com/kubernetes/website/wiki/Tech-reviewers) quando necessário. Os revisores farão o melhor para fornecer feedback em tempo hábil, mas o tempo de resposta pode variar de acordo com as circunstâncias. | ||
## Pré-requisitos | ||
|
||
Para mais informações sobre como contribuir com a documentação do Kubernetes, consulte: | ||
|
||
* [Comece a contribuir](https://kubernetes.io/docs/contribute/start/) | ||
* [Preparando suas alterações na documentação](http://kubernetes.io/docs/contribute/intermediate#view-your-changes-locally) | ||
* [Usando Modelos de Página](http://kubernetes.io/docs/contribute/style/page-templates/) | ||
* [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/) | ||
Para usar este repositório, você precisa instalar: | ||
|
||
Você pode contactar os mantenedores da localização em Português em: | ||
- [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/). | ||
|
||
* Felipe ([GitHub - @femrtnz](https://github.com/femrtnz)) | ||
* [Slack channel](https://kubernetes.slack.com/messages/kubernetes-docs-pt) | ||
Antes de você iniciar, instale as dependências, clone o repositório e navegue até o diretório: | ||
|
||
## Executando o site localmente usando o Docker | ||
``` | ||
git clone https://github.com/kubernetes/website.git | ||
cd website | ||
``` | ||
|
||
A maneira recomendada de executar o site do Kubernetes localmente é executar uma imagem especializada do [Docker](https://docker.com) que inclui o gerador de site estático [Hugo](https://gohugo.io). | ||
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: | ||
|
||
> Se você está rodando no Windows, você precisará de mais algumas ferramentas que você pode instalar com o [Chocolatey](https://chocolatey.org). `choco install make` | ||
``` | ||
# Baixar o submódulo Docsy | ||
git submodule update --init --recursive --depth 1 | ||
``` | ||
|
||
> Se você preferir executar o site localmente sem o Docker, consulte [Executando o site localmente usando o Hugo](#executando-o-site-localmente-usando-o-hugo) abaixo. | ||
## Executando o website usando um container | ||
|
||
Se você tiver o Docker [em funcionamento](https://www.docker.com/get-started), crie a imagem do Docker do `kubernetes-hugo` localmente: | ||
Para executar o build do website em um container, execute o comando abaixo para criar a imagem do container e executa-lá: | ||
|
||
```bash | ||
``` | ||
make container-image | ||
make container-serve | ||
``` | ||
|
||
Depois que a imagem foi criada, você pode executar o site localmente: | ||
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 | ||
make container-serve | ||
# instalar dependências | ||
npm ci | ||
make serve | ||
``` | ||
|
||
Abra seu navegador para http://localhost:1313 para visualizar o site. Conforme você faz alterações nos arquivos de origem, Hugo atualiza o site e força a atualização do navegador. | ||
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. | ||
|
||
## Executando o site localmente usando o Hugo | ||
## 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 | ||
|
||
Veja 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). | ||
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`. | ||
|
||
Para executar o site localmente quando você tiver o Hugo instalado: | ||
### Troubleshooting macOS for too many open files | ||
|
||
```bash | ||
make serve | ||
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 | ||
``` | ||
|
||
Isso iniciará o servidor Hugo local na porta 1313. Abra o navegador para http://localhost:1313 para visualizar o site. Conforme você faz alterações nos arquivos de origem, Hugo atualiza o site e força a atualização do navegador. | ||
Esta solução funciona tanto para o MacOS Catalina quanto para o MacOS Mojave. | ||
|
||
## Comunidade, discussão, contribuição e apoio | ||
# Comunidade, discussão, contribuição e apoio | ||
|
||
Aprenda a se envolver com a comunidade do Kubernetes na [página da comunidade](http://kubernetes.io/community/). | ||
Saiba mais sobre a comunidade Kubernetes SIG Docs e reuniões na [página da comunidade](http://kubernetes.io/community/). | ||
|
||
Você pode falar com os mantenedores deste projeto: | ||
Você também pode entrar em contato com os mantenedores deste projeto em: | ||
|
||
- [Slack](https://kubernetes.slack.com/messages/sig-docs) | ||
- [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) | ||
|
||
### Código de conduta | ||
# 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! | ||
# Obrigado! | ||
|
||
O Kubernetes conta com a participação da comunidade e nós realmente agradecemos suas contribuições para o nosso site e nossa documentação! | ||
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! |
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
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
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
Oops, something went wrong.