109a0dc0a1
This Python script imports the tutorials that are going to be maintained at the https://github.com/kubernetes/examples repository. Currently only pulls the tutorials from master ref of examples. This script: - Deletes content between `<!-- EXCLUDE_FROM_DOCS BEGIN -->` and `<!-- EXCLUDE_FROM_DOCS END -->` (including the markers). This is to drop website redirection notices appear in the examples repo. - Adds Jekyll title to the imported docs. The title can be customized so we do not need to parse h1 elements from the markdown. - Insert "DO NOT UPDATE" section (commented out HTML) to the markdown files that are imported. Once merged, I will go ahead and update the tutorials in kubernetes/examples, then I will run this script and check in its results in a separate PR. Signed-off-by: Ahmet Alp Balkan <ahmetb@google.com> |
||
|---|---|---|
| .github | ||
| _data | ||
| _includes | ||
| _layouts | ||
| _sass | ||
| case-studies | ||
| cn | ||
| community | ||
| css | ||
| docs | ||
| images | ||
| js | ||
| partners | ||
| staging-container | ||
| test | ||
| .gitignore | ||
| .travis.yml | ||
| 404.md | ||
| CNAME | ||
| CONTRIBUTING.md | ||
| Gemfile | ||
| Gemfile.lock | ||
| LICENSE | ||
| Makefile | ||
| OWNERS | ||
| README.md | ||
| _config.yml | ||
| editdocs.md | ||
| google2b743c61aa37ebbe.html | ||
| google3a25d10f6aadcdc0.html | ||
| googlea92cf511a27d4f6b.html | ||
| googlead862a0628bec321.html | ||
| googlebea0044df4aa3179.html | ||
| googlece48a67808b497a5.html | ||
| index.html | ||
| jquery-ui.html | ||
| labels.yaml | ||
| netlify.toml | ||
| robots.txt | ||
| skip_title_check.txt | ||
| skip_toc_check.txt | ||
| update-imported-docs.sh | ||
| update-imported-tutorials.py | ||
| verify-docs-format.sh | ||
README.md
Instructions for Contributing to the Kubernetes Documentation
Welcome! We are very pleased you want to contribute to the Kubernetes documentation.
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 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.
For more information about contributing to the Kubernetes documentation, see:
- Contributing to the Kubernetes Documentation
- Creating a Documentation Pull Request
- Writing a New Topic
- Staging Your Documentation Changes
- Using Page Templates
- Documentation Style Guide
Thank you!
Kubernetes thrives on community participation, and we really appreciate your contributions to our site and our documentation!