kubernetes-sigs/kustomize
1
0
Fork 0
mirror of https://github.com/kubernetes-sigs/kustomize.git synced 2026-06-10 08:20:59 +00:00
Code Issues Packages Projects Releases 1 Wiki Activity

Add more Kustomize contributing docs

Browse Source
This commit is contained in:
Phillip Wittrock
2020-06-14 08:04:16 -07:00
parent c2eb09cd8f
commit c4518e964f
18 changed files with 860 additions and 67 deletions
Download Patch File Download Diff File Expand all files Collapse all files

57
README.md
View File

@@ -16,9 +16,9 @@ inspired by [DAM].
[![Go Report Card](https://goreportcard.com/badge/github.com/kubernetes-sigs/kustomize)](https://goreportcard.com/report/github.com/kubernetes-sigs/kustomize)
Download a binary from the [release page], or see
these [instructions](docs/INSTALL.md).
these [instructions](https://kubernetes-sigs.github.io/kustomize/installation/).
Browse the [docs](docs) or jump right into the
Browse the [docs](https://kubernetes-sigs.github.io/kustomize/) or jump right into the
tested [examples](examples).
## kubectl integration
@@ -132,20 +132,8 @@ The YAML can be directly [applied] to a cluster:
## Community
To file bugs please read [this](docs/bugs.md).
Before working on an implementation, please
* Read the [eschewed feature list].
* File an issue describing
how the new feature would behave
and label it [kind/feature].
### Other communication channels
- [Slack]
- [Mailing List]
- General kubernetes [community page]
- [file a bug](https://kubernetes-sigs.github.io/kustomize/contributing/bugs/) instructions
- [contribute a feature](https://kubernetes-sigs.github.io/kustomize/contributing/features/) instructions
### Code of conduct
@@ -154,32 +142,27 @@ is governed by the [Kubernetes Code of Conduct].
[`make`]: https://www.gnu.org/software/make
[`sed`]: https://www.gnu.org/software/sed
[DAM]: docs/glossary.md#declarative-application-management
[DAM]: https://kubernetes-sigs.github.io/kustomize/api-reference/glossary#declarative-application-management
[KEP]: https://github.com/kubernetes/enhancements/blob/master/keps/sig-cli/0008-kustomize.md
[Kubernetes Code of Conduct]: code-of-conduct.md
[Mailing List]: https://groups.google.com/forum/#!forum/kubernetes-sig-cli
[Slack]: https://kubernetes.slack.com/messages/sig-cli
[applied]: docs/glossary.md#apply
[base]: docs/glossary.md#base
[community page]: http://kubernetes.io/community/
[declarative configuration]: docs/glossary.md#declarative-application-management
[eschewed feature list]: docs/eschewedFeatures.md
[applied]: https://kubernetes-sigs.github.io/kustomize/api-reference/glossary#apply
[base]: https://kubernetes-sigs.github.io/kustomize/api-reference/glossary#base
[declarative configuration]: https://kubernetes-sigs.github.io/kustomize/api-reference/glossary#declarative-application-management
[imageBase]: docs/images/base.jpg
[imageOverlay]: docs/images/overlay.jpg
[kind/feature]: /../../labels/kind%2Ffeature
[kubectl announcement]: https://kubernetes.io/blog/2019/03/25/kubernetes-1-14-release-announcement
[kubectl book]: https://kubectl.docs.kubernetes.io/pages/app_customization/introduction.html
[kubernetes documentation]: https://kubernetes.io/docs/tasks/manage-kubernetes-objects/kustomization/
[kubernetes style]: docs/glossary.md#kubernetes-style-object
[kustomization]: docs/glossary.md#kustomization
[overlay]: docs/glossary.md#overlay
[overlays]: docs/glossary.md#overlay
[release page]: /../../releases
[resource]: docs/glossary.md#resource
[resources]: docs/glossary.md#resource
[kubernetes style]: https://kubernetes-sigs.github.io/kustomize/api-reference/glossary#kubernetes-style-object
[kustomization]: https://kubernetes-sigs.github.io/kustomize/api-reference/glossary#kustomization
[overlay]: https://kubernetes-sigs.github.io/kustomize/api-reference/glossary#overlay
[overlays]: https://kubernetes-sigs.github.io/kustomize/api-reference/glossary#overlay
[release page]: https://github.com/kubernetes-sigs/kustomize/releases
[resource]: https://kubernetes-sigs.github.io/kustomize/api-reference/glossary#resource
[resources]: https://kubernetes-sigs.github.io/kustomize/api-reference/glossary#resource
[sig-cli]: https://github.com/kubernetes/community/blob/master/sig-cli/README.md
[variant]: docs/glossary.md#variant
[variants]: docs/glossary.md#variant
[v2.0.3]: /../../releases/tag/v2.0.3
[v2.1.0]: /../../releases/tag/v2.1.0
[workflows]: docs/workflows.md
[variant]: https://kubernetes-sigs.github.io/kustomize/api-reference/glossary#variant
[variants]: https://kubernetes-sigs.github.io/kustomize/api-reference/glossary#variant
[v2.0.3]: https://github.com/kubernetes-sigs/kustomize/releases/tag/v2.0.3
[v2.1.0]: https://github.com/kubernetes-sigs/kustomize/releases/tag/v2.1.0
[workflows]: https://kubernetes-sigs.github.io/kustomize/guides

2
docs/api-reference/kustomization/commonannotations/index.html
View File

@@ -812,7 +812,7 @@ the value will be overridden.</p>
<div class="text-muted mt-5 pt-3 border-top">Last modified June 11, 2020: <a href="https://github.com/kubernetes-sigs/kustomize/commit/6c54098664e6f584c19814fc26d716d550341d98">kustomize docs tweaks (6c540986)</a>
<div class="text-muted mt-5 pt-3 border-top">Last modified June 11, 2020: <a href="https://github.com/kubernetes-sigs/kustomize/commit/589ddcb4faa1170e1cd549a41b11f18e146197d8">kustomize docs tweaks (589ddcb4)</a>
</div>
</div>

2
docs/api-reference/kustomization/commonlabels/index.html
View File

@@ -855,7 +855,7 @@ resource has been applied to a cluster.</p>
<div class="text-muted mt-5 pt-3 border-top">Last modified June 11, 2020: <a href="https://github.com/kubernetes-sigs/kustomize/commit/6c54098664e6f584c19814fc26d716d550341d98">kustomize docs tweaks (6c540986)</a>
<div class="text-muted mt-5 pt-3 border-top">Last modified June 11, 2020: <a href="https://github.com/kubernetes-sigs/kustomize/commit/589ddcb4faa1170e1cd549a41b11f18e146197d8">kustomize docs tweaks (589ddcb4)</a>
</div>
</div>

2
docs/api-reference/kustomization/patches/index.html
View File

@@ -801,7 +801,7 @@ is equivalent to <code>^myapp$</code>.</p>
<div class="text-muted mt-5 pt-3 border-top">Last modified June 11, 2020: <a href="https://github.com/kubernetes-sigs/kustomize/commit/6c54098664e6f584c19814fc26d716d550341d98">kustomize docs tweaks (6c540986)</a>
<div class="text-muted mt-5 pt-3 border-top">Last modified June 11, 2020: <a href="https://github.com/kubernetes-sigs/kustomize/commit/589ddcb4faa1170e1cd549a41b11f18e146197d8">kustomize docs tweaks (589ddcb4)</a>
</div>
</div>

35
docs/contributing/bugs/index.html
View File

@@ -22,16 +22,16 @@
<link rel="icon" type="image/png" href="/kustomize/favicons/android-192x192.png" sizes="192x192">
<title>Filing Bugs | Kustomize</title><meta property="og:title" content="Filing Bugs" />
<meta property="og:description" content="How to file bugs against Kustomize
<meta property="og:description" content="How to file bugs and fix Kustomize bugs
" />
<meta property="og:type" content="website" />
<meta property="og:url" content="https://kubernetes-sigs.github.io/kustomize/contributing/bugs/" />
<meta property="og:site_name" content="Kustomize" />
<meta itemprop="name" content="Filing Bugs">
<meta itemprop="description" content="How to file bugs against Kustomize
<meta itemprop="description" content="How to file bugs and fix Kustomize bugs
"><meta name="twitter:card" content="summary"/>
<meta name="twitter:title" content="Filing Bugs"/>
<meta name="twitter:description" content="How to file bugs against Kustomize
<meta name="twitter:description" content="How to file bugs and fix Kustomize bugs
"/>
@@ -223,6 +223,29 @@
<ul class="td-sidebar-nav__section pr-md-3">
<li class="td-sidebar-nav__section-title">
<a href="/kustomize/contributing/features/" class="align-left pl-0 pr-2 collapsed td-sidebar-link td-sidebar-link__section">Contributing Features</a>
</li>
<ul>
<li class="collapse " id="kustomizecontributingfeatures">
</li>
</ul>
</ul>
<ul class="td-sidebar-nav__section pr-md-3">
<li class="td-sidebar-nav__section-title">
<a href="/kustomize/contributing/docs/" class="align-left pl-0 pr-2 collapsed td-sidebar-link td-sidebar-link__section">Writing Docs</a>
@@ -379,7 +402,7 @@
<div class="td-content">
<h1>Filing Bugs</h1>
<div class="lead">How to file bugs against Kustomize</div>
<div class="lead">How to file bugs and fix Kustomize bugs</div>
<p>File issues as desired, but if you&rsquo;ve found a problem
with how <code>kustomize build</code> works, please report</p>
<ul>
@@ -435,12 +458,14 @@ misunderstandings.</p>
</div>
<div class="text-muted mt-5 pt-3 border-top">Last modified June 7, 2020: <a href="https://github.com/kubernetes-sigs/kustomize/commit/42497c664f619a36cc86156e366b53099bd633cb">Convert docs to docsy (42497c66)</a>
<div class="text-muted mt-5 pt-3 border-top">Last modified June 14, 2020: <a href="https://github.com/kubernetes-sigs/kustomize/commit/1f28681af4176a6d97fdf286da0bd2b8d46c57ee">Add more Kustomize contributing docs (1f28681a)</a>
</div>
</div>

36
docs/contributing/community/index.html
View File

@@ -223,6 +223,29 @@
<ul class="td-sidebar-nav__section pr-md-3">
<li class="td-sidebar-nav__section-title">
<a href="/kustomize/contributing/features/" class="align-left pl-0 pr-2 collapsed td-sidebar-link td-sidebar-link__section">Contributing Features</a>
</li>
<ul>
<li class="collapse " id="kustomizecontributingfeatures">
</li>
</ul>
</ul>
<ul class="td-sidebar-nav__section pr-md-3">
<li class="td-sidebar-nav__section-title">
<a href="/kustomize/contributing/docs/" class="align-left pl-0 pr-2 collapsed td-sidebar-link td-sidebar-link__section">Writing Docs</a>
@@ -382,9 +405,12 @@
<div class="lead">Joining SIG-CLI and the Kubernetes community</div>
<p>Kustomize is a sub project of the Kubernetes <a href="https://github.com/kubernetes/community/tree/master/sig-cli#cli-special-interest-group">CLI special interest group</a> and follows the Kubernetes
project <a href="https://github.com/kubernetes/community/blob/master/community-membership.md#community-membership">contributor roles</a>.</p>
<p>If you are interested in contributing towards Kustomize or getting more involved with the community,
reach out on the <a href="https://groups.google.com/forum/#!forum/kubernetes-sig-cli">mailing list</a> or join one of the <a href="https://docs.google.com/document/d/1r0YElcXt6G5mOWxwZiXgGu_X6he3F--wKwg-9UBc29I/edit?usp=sharing">bi-weekly meetings</a> (alternating Wednesdays at
9:00am Pacific Time).</p>
<p>If you are interested in contributing towards Kustomize or getting more involved with the community:</p>
<ul>
<li>join the <a href="https://groups.google.com/forum/#!forum/kubernetes-sig-cli">mailing list</a> and reach out</li>
<li>join the <a href="https://kubernetes.slack.com/messages/sig-cli">slack channel</a> and reach out</li>
<li>attend one of the <a href="https://docs.google.com/document/d/1r0YElcXt6G5mOWxwZiXgGu_X6he3F--wKwg-9UBc29I/edit?usp=sharing">bi-weekly meetings</a> (alternating Wednesdays at 9:00am Pacific Time)</li>
</ul>
<div class="section-index">
@@ -407,12 +433,14 @@ reach out on the <a href="https://groups.google.com/forum/#!forum/kubernetes-sig
</div>
<div class="text-muted mt-5 pt-3 border-top">Last modified June 7, 2020: <a href="https://github.com/kubernetes-sigs/kustomize/commit/42497c664f619a36cc86156e366b53099bd633cb">Convert docs to docsy (42497c66)</a>
<div class="text-muted mt-5 pt-3 border-top">Last modified June 14, 2020: <a href="https://github.com/kubernetes-sigs/kustomize/commit/1f28681af4176a6d97fdf286da0bd2b8d46c57ee">Add more Kustomize contributing docs (1f28681a)</a>
</div>
</div>

27
docs/contributing/docs/index.html
View File

@@ -223,6 +223,29 @@
<ul class="td-sidebar-nav__section pr-md-3">
<li class="td-sidebar-nav__section-title">
<a href="/kustomize/contributing/features/" class="align-left pl-0 pr-2 collapsed td-sidebar-link td-sidebar-link__section">Contributing Features</a>
</li>
<ul>
<li class="collapse " id="kustomizecontributingfeatures">
</li>
</ul>
</ul>
<ul class="td-sidebar-nav__section pr-md-3">
<li class="td-sidebar-nav__section-title">
<a href="/kustomize/contributing/docs/" class="align-left pl-0 pr-2 active td-sidebar-link td-sidebar-link__section">Writing Docs</a>
@@ -481,12 +504,14 @@ hugo
</div>
<div class="text-muted mt-5 pt-3 border-top">Last modified June 7, 2020: <a href="https://github.com/kubernetes-sigs/kustomize/commit/42497c664f619a36cc86156e366b53099bd633cb">Convert docs to docsy (42497c66)</a>
<div class="text-muted mt-5 pt-3 border-top">Last modified June 11, 2020: <a href="https://github.com/kubernetes-sigs/kustomize/commit/589ddcb4faa1170e1cd549a41b11f18e146197d8">kustomize docs tweaks (589ddcb4)</a>
</div>
</div>

544
docs/contributing/features/index.html Normal file
View File

@@ -0,0 +1,544 @@
<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<meta name="generator" content="Hugo 0.73.0-DEV" />
<META NAME="ROBOTS" CONTENT="NOINDEX, NOFOLLOW">
<link rel="alternate" type="application/rss&#43;xml" href="https://kubernetes-sigs.github.io/kustomize/contributing/features/index.xml">
<link rel="shortcut icon" href="/favicons/favicon.ico" >
<link rel="apple-touch-icon" href="/kustomize/favicons/apple-touch-icon-180x180.png" sizes="180x180">
<link rel="icon" type="image/png" href="/kustomize/favicons/favicon-16x16.png" sizes="16x16">
<link rel="icon" type="image/png" href="/kustomize/favicons/favicon-32x32.png" sizes="32x32">
<link rel="icon" type="image/png" href="/kustomize/favicons/android-36x36.png" sizes="36x36">
<link rel="icon" type="image/png" href="/kustomize/favicons/android-48x48.png" sizes="48x48">
<link rel="icon" type="image/png" href="/kustomize/favicons/android-72x72.png" sizes="72x72">
<link rel="icon" type="image/png" href="/kustomize/favicons/android-96x96.png" sizes="96x96">
<link rel="icon" type="image/png" href="/kustomize/favicons/android-144x144.png" sizes="144x144">
<link rel="icon" type="image/png" href="/kustomize/favicons/android-192x192.png" sizes="192x192">
<title>Contributing Features | Kustomize</title><meta property="og:title" content="Contributing Features" />
<meta property="og:description" content="How to contribute features
" />
<meta property="og:type" content="website" />
<meta property="og:url" content="https://kubernetes-sigs.github.io/kustomize/contributing/features/" />
<meta property="og:site_name" content="Kustomize" />
<meta itemprop="name" content="Contributing Features">
<meta itemprop="description" content="How to contribute features
"><meta name="twitter:card" content="summary"/>
<meta name="twitter:title" content="Contributing Features"/>
<meta name="twitter:description" content="How to contribute features
"/>
<link rel="preload" href="/kustomize/scss/main.min.818a933df0186c907f1faea6730835dd5fa01c3b53af36bb68396dc80a2d3c45.css" as="style">
<link href="/kustomize/scss/main.min.818a933df0186c907f1faea6730835dd5fa01c3b53af36bb68396dc80a2d3c45.css" rel="stylesheet" integrity="">
<script
src="https://code.jquery.com/jquery-3.3.1.min.js"
integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8="
crossorigin="anonymous"></script>
<link rel="stylesheet" type="text/css" href="https://kubernetes-sigs.github.io/kustomize//css/asciinema-player.css" />
<title>Contributing Features | Kustomize</title>
</head>
<body class="td-section">
<header>
<nav class="js-navbar-scroll navbar navbar-expand navbar-dark flex-column flex-md-row td-navbar">
<a class="navbar-brand" href="/kustomize/">
<span class="navbar-logo"></span><span class="text-uppercase font-weight-bold">Kustomize</span>
</a>
<div class="td-navbar-nav-scroll ml-md-auto" id="main_navbar">
<ul class="navbar-nav mt-2 mt-lg-0">
<li class="nav-item mr-4 mb-2 mb-lg-0">
<a class="nav-link" href="/kustomize/installation/" ><span>Installation</span></a>
</li>
<li class="nav-item mr-4 mb-2 mb-lg-0">
<a class="nav-link" href="/kustomize/guides/" ><span>Guides</span></a>
</li>
<li class="nav-item mr-4 mb-2 mb-lg-0">
<a class="nav-link" href="/kustomize/api-reference/" ><span>API Reference</span></a>
</li>
<li class="nav-item mr-4 mb-2 mb-lg-0">
<a class="nav-link" href="/kustomize/faq/" ><span>FAQ</span></a>
</li>
<li class="nav-item mr-4 mb-2 mb-lg-0">
<a class="nav-link" href="/kustomize/blog/" ><span>Blog</span></a>
</li>
<li class="nav-item mr-4 mb-2 mb-lg-0">
<a class="nav-link active" href="/kustomize/contributing/" ><span class="active">Contributing</span></a>
</li>
</ul>
</div>
<div class="navbar-nav d-none d-lg-block">
</div>
</nav>
</header>
<div class="container-fluid td-outer">
<div class="td-main">
<div class="row flex-xl-nowrap">
<div class="col-12 col-md-3 col-xl-2 td-sidebar d-print-none">
<div id="td-sidebar-menu" class="td-sidebar__inner">
<form class="td-sidebar__search d-flex align-items-center">
<button class="btn btn-link td-sidebar__toggle d-md-none p-0 ml-3 fas fa-bars" type="button" data-toggle="collapse" data-target="#td-section-nav" aria-controls="td-docs-nav" aria-expanded="false" aria-label="Toggle section navigation">
</button>
</form>
<nav class="collapse td-sidebar-nav pt-2 pl-4" id="td-section-nav">
<ul class="td-sidebar-nav__section pr-md-3">
<li class="td-sidebar-nav__section-title">
<a href="/kustomize/contributing/" class="align-left pl-0 pr-2 td-sidebar-link td-sidebar-link__section">Contributing</a>
</li>
<ul>
<li class="collapse show" id="kustomizecontributing">
<ul class="td-sidebar-nav__section pr-md-3">
<li class="td-sidebar-nav__section-title">
<a href="/kustomize/contributing/bugs/" class="align-left pl-0 pr-2 collapsed td-sidebar-link td-sidebar-link__section">Filing Bugs</a>
</li>
<ul>
<li class="collapse " id="kustomizecontributingbugs">
</li>
</ul>
</ul>
<ul class="td-sidebar-nav__section pr-md-3">
<li class="td-sidebar-nav__section-title">
<a href="/kustomize/contributing/community/" class="align-left pl-0 pr-2 collapsed td-sidebar-link td-sidebar-link__section">Community</a>
</li>
<ul>
<li class="collapse " id="kustomizecontributingcommunity">
</li>
</ul>
</ul>
<ul class="td-sidebar-nav__section pr-md-3">
<li class="td-sidebar-nav__section-title">
<a href="/kustomize/contributing/features/" class="align-left pl-0 pr-2 active td-sidebar-link td-sidebar-link__section">Contributing Features</a>
</li>
<ul>
<li class="collapse show" id="kustomizecontributingfeatures">
</li>
</ul>
</ul>
<ul class="td-sidebar-nav__section pr-md-3">
<li class="td-sidebar-nav__section-title">
<a href="/kustomize/contributing/docs/" class="align-left pl-0 pr-2 collapsed td-sidebar-link td-sidebar-link__section">Writing Docs</a>
</li>
<ul>
<li class="collapse " id="kustomizecontributingdocs">
</li>
</ul>
</ul>
<ul class="td-sidebar-nav__section pr-md-3">
<li class="td-sidebar-nav__section-title">
<a href="/kustomize/contributing/howitworks/" class="align-left pl-0 pr-2 collapsed td-sidebar-link td-sidebar-link__section">Writing Code</a>
</li>
<ul>
<li class="collapse " id="kustomizecontributinghowitworks">
</li>
</ul>
</ul>
<ul class="td-sidebar-nav__section pr-md-3">
<li class="td-sidebar-nav__section-title">
<a href="/kustomize/contributing/mac/" class="align-left pl-0 pr-2 collapsed td-sidebar-link td-sidebar-link__section">MacOS Dev Guide</a>
</li>
<ul>
<li class="collapse " id="kustomizecontributingmac">
</li>
</ul>
</ul>
<ul class="td-sidebar-nav__section pr-md-3">
<li class="td-sidebar-nav__section-title">
<a href="/kustomize/contributing/windows/" class="align-left pl-0 pr-2 collapsed td-sidebar-link td-sidebar-link__section">Windows Dev Guide</a>
</li>
<ul>
<li class="collapse " id="kustomizecontributingwindows">
</li>
</ul>
</ul>
</li>
</ul>
</ul>
</nav>
</div>
</div>
<div class="d-none d-xl-block col-xl-2 td-toc d-print-none">
<div class="td-page-meta ml-2 pb-1 pt-2 mb-0">
<a href="https://github.com/kubernetes-sigs/kustomize/edit/master/site/content/en/contributing/features/_index.md" target="_blank"><i class="fa fa-edit fa-fw"></i> Edit this page</a>
<a href="https://github.com/kubernetes-sigs/kustomize/issues/new?title=Contributing%20Features" target="_blank"><i class="fab fa-github fa-fw"></i> Create documentation issue</a>
<a href="https://github.com/kubernetes-sigs/kustomize/issues/new" target="_blank"><i class="fas fa-tasks fa-fw"></i> Create project issue</a>
</div>
</div>
<main class="col-12 col-md-9 col-xl-8 pl-md-5" role="main">
<nav aria-label="breadcrumb" class="d-none d-md-block d-print-none">
<ol class="breadcrumb spb-1">
<li class="breadcrumb-item" >
<a href="https://kubernetes-sigs.github.io/kustomize/contributing/">Contributing</a>
</li>
<li class="breadcrumb-item active" aria-current="page">
<a href="https://kubernetes-sigs.github.io/kustomize/contributing/features/">Contributing Features</a>
</li>
</ol>
</nav >
<div class="td-content">
<h1>Contributing Features</h1>
<div class="lead">How to contribute features</div>
<p>Following is the process for proposing a new Kustomize feature:</p>
<ol>
<li>Check the <a href="https://kubernetes-sigs.github.io/kustomize/faq/eschewedfeatures/">eschewed feature list</a> to see if the feature has already been proposed</li>
<li>File an <a href="https://github.com/kubernetes-sigs/kustomize/issues">issue</a> describing the desired feature
<ul>
<li>label it <a href="https://github.com/kubernetes-sigs/kustomize/labels/kind%2Ffeature">kind/feature</a></li>
<li>the motivation for the feature</li>
<li>example of how you would accomplish the motivating task <em>without</em> the feature</li>
<li>example of how you would accomplish the motivating task <em>with</em> the feature</li>
</ul>
</li>
<li>Email the <a href="/kustomize/contributing/community/">sig-cli</a> mailing list with the issue</li>
<li>Present the issue at <a href="/kustomize/contributing/community/">sig-cli</a> bi-weekly meeting on Zoom
<ul>
<li>add it to the <a href="https://docs.google.com/document/d/1r0YElcXt6G5mOWxwZiXgGu_X6he3F--wKwg-9UBc29I/edit#heading=h.himo1st0tqyy">meeting agenda</a> doc</li>
<li>be present to discuss the feature</li>
<li>response may be &ndash; move forward with a PoC, not to move forward, defer and come back later,
or more information is needed.</li>
</ul>
</li>
<li>Address the feedback on the issue
<ul>
<li>Possibly write a KEP for tracking the feature</li>
</ul>
</li>
<li>Implement the feature and send a PR
<ul>
<li>Add <a href="https://github.com/kubernetes-sigs/kustomize/blob/a8b9741866cf8e0c43e643ab7a9f40a3bd7e2a4d/api/filters/imagetag/imagetag_test.go#L15">table-driven</a> tests</li>
<li>Expect comments on the PR within 2 weeks</li>
</ul>
</li>
<li>Kustomize team will release the kustomize <code>api</code> and <code>kustomize</code> modules</li>
</ol>
<div class="section-index">
<hr class="panel-line">
</div>
<div class="text-muted mt-5 pt-3 border-top">Last modified June 14, 2020: <a href="https://github.com/kubernetes-sigs/kustomize/commit/1f28681af4176a6d97fdf286da0bd2b8d46c57ee">Add more Kustomize contributing docs (1f28681a)</a>
</div>
</div>
</main>
</div>
</div>
<footer class="bg-dark py-5 row d-print-none">
<div class="container-fluid mx-sm-5">
<div class="row">
<div class="col-6 col-sm-4 text-xs-center order-sm-2">
<ul class="list-inline mb-0">
<li class="list-inline-item mx-2 h3" data-toggle="tooltip" data-placement="top" title="User mailing list" aria-label="User mailing list">
<a class="text-white" target="_blank" href="https://groups.google.com/forum/#!forum/kubernetes-sig-cli">
<i class="fa fa-envelope"></i>
</a>
</li>
</ul>
</div>
<div class="col-6 col-sm-4 text-right text-xs-center order-sm-3">
<ul class="list-inline mb-0">
<li class="list-inline-item mx-2 h3" data-toggle="tooltip" data-placement="top" title="GitHub" aria-label="GitHub">
<a class="text-white" target="_blank" href="https://github.com/kubernetes-sigs/kustomize">
<i class="fab fa-github"></i>
</a>
</li>
</ul>
</div>
<div class="col-12 col-sm-4 text-center py-2 order-sm-2">
<small class="text-white">&copy; 2020 Kubernetes Authors All Rights Reserved</small>
</div>
</div>
</div>
</footer>
</div>
<script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.14.3/umd/popper.min.js" integrity="sha384-ZMP7rVo3mIykV+2+9J3UJ46jBk0WLaUAdn689aCwoqbBJiSnjAK/l8WvCWPIPm49" crossorigin="anonymous"></script>
<script src="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/js/bootstrap.min.js" integrity="sha384-ChfqqxuZUCnJSK3+MXmPNIyE6ZbWh2IMqE241rYiqJxyMiZ6OW/JmZQ5stwEULTy" crossorigin="anonymous"></script>
<script src="/kustomize/js/main.min.35b203b3c2114e187f6e4bbf0903c511aaaac5535186321e3b5e364656b6de0c.js" integrity="sha256-NbIDs8IRThh/bku/CQPFEaqqxVNRhjIeO142Rla23gw=" crossorigin="anonymous"></script>
<script src="https://kubernetes-sigs.github.io/kustomize//js/asciinema-player.js"></script>
</body>
</html>

17
docs/contributing/features/index.xml Normal file
View File

@@ -0,0 +1,17 @@
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
<channel>
<title>Kustomize – Contributing Features</title>
<link>https://kubernetes-sigs.github.io/kustomize/contributing/features/</link>
<description>Recent content in Contributing Features on Kustomize</description>
<generator>Hugo -- gohugo.io</generator>
<atom:link href="https://kubernetes-sigs.github.io/kustomize/contributing/features/index.xml" rel="self" type="application/rss+xml" />
</channel>
</rss>

47
docs/contributing/howitworks/index.html
View File

@@ -22,16 +22,16 @@
<link rel="icon" type="image/png" href="/kustomize/favicons/android-192x192.png" sizes="192x192">
<title>Writing Code | Kustomize</title><meta property="og:title" content="Writing Code" />
<meta property="og:description" content="How Kustomize is implemented
<meta property="og:description" content="How to modify Kustomize
" />
<meta property="og:type" content="website" />
<meta property="og:url" content="https://kubernetes-sigs.github.io/kustomize/contributing/howitworks/" />
<meta property="og:site_name" content="Kustomize" />
<meta itemprop="name" content="Writing Code">
<meta itemprop="description" content="How Kustomize is implemented
<meta itemprop="description" content="How to modify Kustomize
"><meta name="twitter:card" content="summary"/>
<meta name="twitter:title" content="Writing Code"/>
<meta name="twitter:description" content="How Kustomize is implemented
<meta name="twitter:description" content="How to modify Kustomize
"/>
@@ -223,6 +223,29 @@
<ul class="td-sidebar-nav__section pr-md-3">
<li class="td-sidebar-nav__section-title">
<a href="/kustomize/contributing/features/" class="align-left pl-0 pr-2 collapsed td-sidebar-link td-sidebar-link__section">Contributing Features</a>
</li>
<ul>
<li class="collapse " id="kustomizecontributingfeatures">
</li>
</ul>
</ul>
<ul class="td-sidebar-nav__section pr-md-3">
<li class="td-sidebar-nav__section-title">
<a href="/kustomize/contributing/docs/" class="align-left pl-0 pr-2 collapsed td-sidebar-link td-sidebar-link__section">Writing Docs</a>
@@ -379,8 +402,18 @@
<div class="td-content">
<h1>Writing Code</h1>
<div class="lead">How Kustomize is implemented</div>
<p>Call stack when running <code>kustomize build</code>, with links to code.</p>
<div class="lead">How to modify Kustomize</div>
<div class="pageinfo pageinfo-info">
<p>To build kustomize using the locally modified modules, <code>replace</code> statements must be added to
the <code>kustomize/go.mod</code>.</p>
<p>e.g. if code in <code>api</code> was modified, a <code>replace</code> statement would need to be added for the
<code>kustomize/api</code> module.</p>
</div>
<p>Call stack when running <code>kustomize build</code>, with links to code.</p>
<h2 id="run-build">Run build</h2>
<ul>
<li><a href="https://github.com/kubernetes-sigs/kustomize/blob/c7d78970fb86782dbdded3a93944b774f826071f/kustomize/internal/commands/build/build.go#L121">RunBuild</a>
@@ -486,12 +519,14 @@
</div>
<div class="text-muted mt-5 pt-3 border-top">Last modified June 7, 2020: <a href="https://github.com/kubernetes-sigs/kustomize/commit/42497c664f619a36cc86156e366b53099bd633cb">Convert docs to docsy (42497c66)</a>
<div class="text-muted mt-5 pt-3 border-top">Last modified June 14, 2020: <a href="https://github.com/kubernetes-sigs/kustomize/commit/1f28681af4176a6d97fdf286da0bd2b8d46c57ee">Add more Kustomize contributing docs (1f28681a)</a>
</div>
</div>

36
docs/contributing/index.html
View File

@@ -220,6 +220,29 @@
<ul class="td-sidebar-nav__section pr-md-3">
<li class="td-sidebar-nav__section-title">
<a href="/kustomize/contributing/features/" class="align-left pl-0 pr-2 td-sidebar-link td-sidebar-link__section">Contributing Features</a>
</li>
<ul>
<li class="collapse show" id="kustomizecontributingfeatures">
</li>
</ul>
</ul>
<ul class="td-sidebar-nav__section pr-md-3">
<li class="td-sidebar-nav__section-title">
<a href="/kustomize/contributing/docs/" class="align-left pl-0 pr-2 td-sidebar-link td-sidebar-link__section">Writing Docs</a>
@@ -381,7 +404,7 @@
<h5>
<a href="/kustomize/contributing/bugs/">Filing Bugs</a>
</h5>
<p>How to file bugs against Kustomize</p>
<p>How to file bugs and fix Kustomize bugs</p>
</div>
@@ -395,6 +418,15 @@
<div class="entry">
<h5>
<a href="/kustomize/contributing/features/">Contributing Features</a>
</h5>
<p>How to contribute features</p>
</div>
<div class="entry">
<h5>
<a href="/kustomize/contributing/docs/">Writing Docs</a>
@@ -408,7 +440,7 @@
<h5>
<a href="/kustomize/contributing/howitworks/">Writing Code</a>
</h5>
<p>How Kustomize is implemented</p>
<p>How to modify Kustomize</p>
</div>

25
docs/contributing/mac/index.html
View File

@@ -223,6 +223,29 @@
<ul class="td-sidebar-nav__section pr-md-3">
<li class="td-sidebar-nav__section-title">
<a href="/kustomize/contributing/features/" class="align-left pl-0 pr-2 collapsed td-sidebar-link td-sidebar-link__section">Contributing Features</a>
</li>
<ul>
<li class="collapse " id="kustomizecontributingfeatures">
</li>
</ul>
</ul>
<ul class="td-sidebar-nav__section pr-md-3">
<li class="td-sidebar-nav__section-title">
<a href="/kustomize/contributing/docs/" class="align-left pl-0 pr-2 collapsed td-sidebar-link td-sidebar-link__section">Writing Docs</a>
@@ -431,6 +454,8 @@
</div>

25
docs/contributing/windows/index.html
View File

@@ -223,6 +223,29 @@
<ul class="td-sidebar-nav__section pr-md-3">
<li class="td-sidebar-nav__section-title">
<a href="/kustomize/contributing/features/" class="align-left pl-0 pr-2 collapsed td-sidebar-link td-sidebar-link__section">Contributing Features</a>
</li>
<ul>
<li class="collapse " id="kustomizecontributingfeatures">
</li>
</ul>
</ul>
<ul class="td-sidebar-nav__section pr-md-3">
<li class="td-sidebar-nav__section-title">
<a href="/kustomize/contributing/docs/" class="align-left pl-0 pr-2 collapsed td-sidebar-link td-sidebar-link__section">Writing Docs</a>
@@ -489,6 +512,8 @@ Usage: C:\_go\bin\mdrip.exe {fileName}...
</div>

13
docs/sitemap.xml
View File

@@ -44,7 +44,7 @@
<url>
<loc>https://kubernetes-sigs.github.io/kustomize/contributing/bugs/</loc>
<lastmod>2020-06-07T21:07:46-07:00</lastmod>
<lastmod>2020-06-14T08:04:16-07:00</lastmod>
</url>
<url>
@@ -54,7 +54,7 @@
<url>
<loc>https://kubernetes-sigs.github.io/kustomize/contributing/community/</loc>
<lastmod>2020-06-07T21:07:46-07:00</lastmod>
<lastmod>2020-06-14T08:04:16-07:00</lastmod>
</url>
<url>
@@ -67,14 +67,19 @@
<lastmod>2020-06-07T21:07:46-07:00</lastmod>
</url>
<url>
<loc>https://kubernetes-sigs.github.io/kustomize/contributing/features/</loc>
<lastmod>2020-06-14T08:04:16-07:00</lastmod>
</url>
<url>
<loc>https://kubernetes-sigs.github.io/kustomize/contributing/docs/</loc>
<lastmod>2020-06-07T21:07:46-07:00</lastmod>
<lastmod>2020-06-11T21:40:35-07:00</lastmod>
</url>
<url>
<loc>https://kubernetes-sigs.github.io/kustomize/contributing/howitworks/</loc>
<lastmod>2020-06-07T21:07:46-07:00</lastmod>
<lastmod>2020-06-14T08:04:16-07:00</lastmod>
</url>
<url>

2
site/content/en/contributing/bugs/_index.md
View File

@@ -4,7 +4,7 @@ linkTitle: "Filing Bugs"
type: docs
weight: 10
description: >
How to file bugs against Kustomize
How to file bugs and fix Kustomize bugs
---

9
site/content/en/contributing/community/_index.md
View File

@@ -11,12 +11,15 @@ description: >
[contributor roles]: https://github.com/kubernetes/community/blob/master/community-membership.md#community-membership
[mailing list]: https://groups.google.com/forum/#!forum/kubernetes-sig-cli
[bi-weekly meetings]: https://docs.google.com/document/d/1r0YElcXt6G5mOWxwZiXgGu_X6he3F--wKwg-9UBc29I/edit?usp=sharing
[slack channel]: https://kubernetes.slack.com/messages/sig-cli
Kustomize is a sub project of the Kubernetes [CLI special interest group] and follows the Kubernetes
project [contributor roles].
If you are interested in contributing towards Kustomize or getting more involved with the community,
reach out on the [mailing list] or join one of the [bi-weekly meetings] (alternating Wednesdays at
9:00am Pacific Time).
If you are interested in contributing towards Kustomize or getting more involved with the community:
- join the [mailing list] and reach out
- join the [slack channel] and reach out
- attend one of the [bi-weekly meetings] (alternating Wednesdays at 9:00am Pacific Time)

38
site/content/en/contributing/features/_index.md Normal file
View File

@@ -0,0 +1,38 @@
---
title: "Contributing Features"
linkTitle: "Contributing Features"
type: docs
weight: 21
description: >
How to contribute features
---
[issue]: https://github.com/kubernetes-sigs/kustomize/issues
[sig-cli]: /kustomize/contributing/community/
[meeting agenda]: https://docs.google.com/document/d/1r0YElcXt6G5mOWxwZiXgGu_X6he3F--wKwg-9UBc29I/edit#heading=h.himo1st0tqyy
[KEP]: https://github.com/kubernetes/enhancements/tree/master/keps/sig-cli
[table-driven]: https://github.com/kubernetes-sigs/kustomize/blob/a8b9741866cf8e0c43e643ab7a9f40a3bd7e2a4d/api/filters/imagetag/imagetag_test.go#L15
[eschewed feature list]: https://kubernetes-sigs.github.io/kustomize/faq/eschewedfeatures/
[kind/feature]: https://github.com/kubernetes-sigs/kustomize/labels/kind%2Ffeature
Following is the process for proposing a new Kustomize feature:
1. Check the [eschewed feature list] to see if the feature has already been proposed
2. File an [issue] describing the desired feature
- label it [kind/feature]
- the motivation for the feature
- example of how you would accomplish the motivating task *without* the feature
- example of how you would accomplish the motivating task *with* the feature
3. Email the [sig-cli] mailing list with the issue
4. Present the issue at [sig-cli] bi-weekly meeting on Zoom
- add it to the [meeting agenda] doc
- be present to discuss the feature
- response may be -- move forward with a PoC, not to move forward, defer and come back later,
or more information is needed.
5. Address the feedback on the issue
- Possibly write a KEP for tracking the feature
6. Implement the feature and send a PR
- Add [table-driven] tests
- Expect comments on the PR within 2 weeks
7. Kustomize team will release the kustomize `api` and `kustomize` modules

10
site/content/en/contributing/howitworks/_index.md
View File

@@ -4,9 +4,17 @@ linkTitle: "Writing Code"
type: docs
weight: 40
description: >
How Kustomize is implemented
How to modify Kustomize
---
{{% pageinfo color="info" %}}
To build kustomize using the locally modified modules, `replace` statements must be added to
the `kustomize/go.mod`.
e.g. if code in `api` was modified, a `replace` statement would need to be added for the
`kustomize/api` module.
{{% /pageinfo %}}
Call stack when running `kustomize build`, with links to code.
## Run build