sharet-adl
a3690b62a2
Proposing fixes for some issues in the page:
1. Handle display issue for the 'kubectl run' command, where pipe character ('|') is not properly escaped, so the text gets trimmed.
Currently the text is rendered like this: "run `kubectl run NAME --image=image [--env=“key=value”] [--port=port] [--replicas=replicas] [--dry-run=server".
The correct text will be displayed like:
"kubectl run NAME --image=image [--env="key=value"] [--port=port] [--replicas=replicas] [--dry-run=server|client|none] [--overrides=inline-json] [flags]".
Also, the description column would be displayed properly.
2. Fixing output of 'get pods' command, when flag --server-print is set to false.
The only displayed columns would be NAME and AGE.
3. Fixing description and sample command for delete pods (kubectl delete pods,service ..), where 'label-name' text is ambiguously used as the label's value. Labels are key-value pairs.
Suggested way of writting it:
"# Delete all the pods and services that have the label '<label-key>=<label-value>'.
kubectl delete pods,services -l <label-key>=<label-value>"
Another way to write it could be:
"# Delete all the pods and services that have the label 'name=<label-value>'.
kubectl delete pods,services -l name=<label-value>"
4. Updating the syntax for three 'kubectl exec' commands, to include the '--' before the user's command, to be inline with current way of working and to avoid deprecation message.
5. Enhance sample for 'kubectl config' command, where the newline was not handled properly.
Before:
[user@wstation ~]$ kubectl config view --template='{{ range .contexts }}{{ if eq .name "'$(kubectl config current-context)'" }}Current user: {{ .context.user }}{{ end }}{{ end }}'
Current user: kubernetes-admin[user@wstation ~]$
After:
[user@wstation ~]$ kubectl config view --template='{{ range .contexts }}{{ if eq .name "'$(kubectl config current-context)'" }}Current user: {{ printf "%s\n" .context.user }}{{ end }}{{ end }}'
Current user: kubernetes-admin
[user@wstation ~]$
The Kubernetes documentation
This repository contains the assets required to build the Kubernetes website and documentation. We're glad that you want to contribute!
Running the website locally using Hugo
See the official Hugo documentation for Hugo installation instructions. Make sure to install the Hugo extended version specified by the HUGO_VERSION environment variable in the netlify.toml file.
To run the website locally when you have Hugo installed:
git clone https://github.com/kubernetes/website.git
cd website
hugo server --buildFuture
This will start the local Hugo server on port 1313. Open up your browser to http://localhost:1313 to view the website. As you make changes to the source files, Hugo updates the website and forces a browser refresh.
Get involved with SIG Docs
Learn more about SIG Docs Kubernetes community and meetings on the community page.
You can also reach the maintainers of this project at:
Contributing to the docs
You can click the Fork button in the upper-right area of the screen to create a copy of this repository in your GitHub account. This copy is called a fork. Make any changes you want in your fork, and when you are ready to send those changes to us, go to your fork and create a new pull request to let us know about it.
Once your pull request is created, a Kubernetes reviewer will take responsibility for providing clear, actionable feedback. As the owner of the pull request, it is your responsibility to modify your pull request to address the feedback that has been provided to you by the Kubernetes reviewer.
Also, note that you may end up having more than one Kubernetes reviewer provide you feedback or you may end up getting feedback from a Kubernetes reviewer that is different than the one initially assigned to provide you feedback.
Furthermore, in some cases, one of your reviewers might ask for a technical review from a Kubernetes tech reviewer when needed. Reviewers will do their best to provide feedback in a timely fashion but response time can vary based on circumstances.
For more information about contributing to the Kubernetes documentation, see:
- Contribute to Kubernetes docs
- Using Page Templates
- Documentation Style Guide
- Localizing Kubernetes Documentation
Localization README.md's
| Language | Language |
|---|---|
| Chinese | Korean |
| French | Polish |
| German | Portuguese |
| Hindi | Russian |
| Indonesian | Spanish |
| Italian | Ukrainian |
| Japanese | Vietnamese |
Code of conduct
Participation in the Kubernetes community is governed by the CNCF Code of Conduct.
Thank you!
Kubernetes thrives on community participation, and we appreciate your contributions to our website and our documentation!