mirror of
https://github.com/kubernetes-sigs/kustomize.git
synced 2026-05-17 18:25:26 +00:00
Move template files from docs/ to root
This commit is contained in:
22
CONTRIBUTING.md
Normal file
22
CONTRIBUTING.md
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
# Contributing Guidelines
|
||||||
|
|
||||||
|
Welcome to Kubernetes. We are excited about the prospect of you joining our [community](https://github.com/kubernetes/community)! The Kubernetes community abides by the CNCF [code of conduct](code-of-conduct.md). Here is an excerpt:
|
||||||
|
|
||||||
|
_As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities._
|
||||||
|
|
||||||
|
## Getting Started
|
||||||
|
|
||||||
|
We have full documentation on how to get started contributing here:
|
||||||
|
|
||||||
|
- [Contributor License Agreement](https://git.k8s.io/community/CLA.md) Kubernetes projects require that you sign a Contributor License Agreement (CLA) before we can accept your pull requests
|
||||||
|
- [Kubernetes Contributor Guide](http://git.k8s.io/community/contributors/guide) - Main contributor documentation, or you can just jump directly to the [contributing section](http://git.k8s.io/community/contributors/guide#contributing)
|
||||||
|
- [Contributor Cheat Sheet](https://git.k8s.io/community/contributors/guide/contributor-cheatsheet.md) - Common resources for existing developers
|
||||||
|
|
||||||
|
## Mentorship
|
||||||
|
|
||||||
|
- [Mentoring Initiatives](https://git.k8s.io/community/mentoring) - We have a diverse set of mentorship programs available that are always looking for volunteers!
|
||||||
|
|
||||||
|
## Contact Information
|
||||||
|
|
||||||
|
- [Slack channel](https://kubernetes.slack.com/messages/sig-cli)
|
||||||
|
- [Mailing list](https://groups.google.com/forum/#!forum/kubernetes-sig-cli)
|
||||||
18
README.md
18
README.md
@@ -9,6 +9,8 @@ patch [kubernetes style] API objects. It's like
|
|||||||
[`make`], in that what it does is declared in a file,
|
[`make`], in that what it does is declared in a file,
|
||||||
and it's like [`sed`], in that it emits editted text.
|
and it's like [`sed`], in that it emits editted text.
|
||||||
|
|
||||||
|
This tool is sponsored by [sig-cli] ([KEP]).
|
||||||
|
|
||||||
[](https://travis-ci.org/kubernetes-sigs/kustomize)
|
[](https://travis-ci.org/kubernetes-sigs/kustomize)
|
||||||
[](https://goreportcard.com/report/github.com/kubernetes-sigs/kustomize)
|
[](https://goreportcard.com/report/github.com/kubernetes-sigs/kustomize)
|
||||||
|
|
||||||
@@ -113,10 +115,18 @@ The YAML can be directly [applied] to a cluster:
|
|||||||
> kustomize build ~/someApp/overlays/production | kubectl apply -f -
|
> kustomize build ~/someApp/overlays/production | kubectl apply -f -
|
||||||
> ```
|
> ```
|
||||||
|
|
||||||
## About
|
## Community, discussion, contribution, and support
|
||||||
|
|
||||||
This tool is sponsored by [sig-cli] ([KEP]).
|
Learn how to engage with the Kubernetes community on the [community page].
|
||||||
|
|
||||||
|
You can reach the maintainers of this project at:
|
||||||
|
|
||||||
|
- [Slack]
|
||||||
|
- [Mailing List]
|
||||||
|
|
||||||
|
### Code of conduct
|
||||||
|
|
||||||
|
Participation in the Kubernetes community is governed by the [Kubernetes Code of Conduct].
|
||||||
|
|
||||||
[KEP]: https://github.com/kubernetes/community/blob/master/keps/sig-cli/0008-kustomize.md
|
[KEP]: https://github.com/kubernetes/community/blob/master/keps/sig-cli/0008-kustomize.md
|
||||||
[`make`]: https://www.gnu.org/software/make
|
[`make`]: https://www.gnu.org/software/make
|
||||||
@@ -139,3 +149,7 @@ This tool is sponsored by [sig-cli] ([KEP]).
|
|||||||
[variant]: docs/glossary.md#variant
|
[variant]: docs/glossary.md#variant
|
||||||
[variants]: docs/glossary.md#variant
|
[variants]: docs/glossary.md#variant
|
||||||
[workflows]: docs/workflows.md
|
[workflows]: docs/workflows.md
|
||||||
|
[community page]: http://kubernetes.io/community/
|
||||||
|
[Kubernetes Code of Conduct]: code-of-conduct.md
|
||||||
|
[Slack]: https://kubernetes.slack.com/messages/sig-cli
|
||||||
|
[Mailing List]: https://groups.google.com/forum/#!forum/kubernetes-sig-cli
|
||||||
|
|||||||
3
code-of-conduct.md
Normal file
3
code-of-conduct.md
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
# Kubernetes Community Code of Conduct
|
||||||
|
|
||||||
|
Please refer to our [Kubernetes Community Code of Conduct](https://git.k8s.io/community/code-of-conduct.md)
|
||||||
@@ -1,4 +0,0 @@
|
|||||||
# Kustomize Community Code of Conduct
|
|
||||||
|
|
||||||
Kustomize contributers expected to adhere to
|
|
||||||
the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md).
|
|
||||||
@@ -1,36 +0,0 @@
|
|||||||
# Contributing guidelines
|
|
||||||
|
|
||||||
[Contributor License Agreement]: https://git.k8s.io/community/CLA.md
|
|
||||||
[github workflow guide]: https://github.com/kubernetes/community/blob/master/contributors/guide/github-workflow.md
|
|
||||||
[CNCF code of conduct]: https://github.com/cncf/foundation/blob/master/code-of-conduct.md
|
|
||||||
|
|
||||||
## Contributing a Patch
|
|
||||||
|
|
||||||
1. Kubernetes projects require contributors to sign the
|
|
||||||
[Contributor License Agreement] before pull requests
|
|
||||||
can be considered.
|
|
||||||
1. Submit an issue describing your proposed change to
|
|
||||||
the repo in question.
|
|
||||||
1. The [repo owners](../OWNERS) will respond to your issue
|
|
||||||
promptly.
|
|
||||||
1. Fork the repo, develop and test your code.
|
|
||||||
See the [github workflow guide].
|
|
||||||
1. For _new features_, provide a markdown-based demo following
|
|
||||||
the pattern established in the [examples](../examples) directory.
|
|
||||||
Run `bin/pre-commit.sh` to test your demo.
|
|
||||||
1. Submit a pull request.
|
|
||||||
|
|
||||||
## Community, discussion, contribution, and support
|
|
||||||
|
|
||||||
Learn how to engage with the Kubernetes community on
|
|
||||||
the [community page](http://kubernetes.io/community/).
|
|
||||||
|
|
||||||
You can reach the maintainers of this project at:
|
|
||||||
|
|
||||||
- [Slack](http://slack.k8s.io/)
|
|
||||||
- [Mailing List](https://groups.google.com/forum/#!forum/kubernetes-kustomize)
|
|
||||||
|
|
||||||
## Code of conduct
|
|
||||||
|
|
||||||
Participation in the Kubernetes community is governed
|
|
||||||
by the [CNCF code of conduct].
|
|
||||||
@@ -14,9 +14,9 @@
|
|||||||
* [eschewed features](eschewedFeatures.md) - Why certain features are (currently)
|
* [eschewed features](eschewedFeatures.md) - Why certain features are (currently)
|
||||||
not supported in Kustomize.
|
not supported in Kustomize.
|
||||||
|
|
||||||
* [contributing guidelines](CONTRIBUTING.md) - Please read before sending a PR.
|
* [contributing guidelines](../CONTRIBUTING.md) - Please read before sending a PR.
|
||||||
|
|
||||||
* [code of conduct](CODE_OF_CONDUCT.md)
|
* [code of conduct](../code-of-conduct.md)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user