| A | B | C | D | E | F | G | H | I | J | K | L | M | N | O | P | Q | R | S | T | U | V | W | X | Y | Z | AA | AB | |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
1 | FA | Page Group | Page | Migrate | Suggested location | Assignee | Comments | PR | Merged | |||||||||||||||||||
2 | kustomize.io | home page | partial | home page | Use as inspiration rather than directly porting. Some content is outdated (e.g. the screenshot at the top uses "bases") and we need to point to community content only. We want the style of kubernetes.io. See also David's overview of the content here: https://docs.google.com/document/d/1galldpW27fSyKr9JAdKcCHVJ2qEa40Mng1jTop7xong/edit#heading=h.v9bl9a59oume | |||||||||||||||||||||||
3 | guides | introduction / kustomize | yes | docs/getting_started/first_kustomization (UPDATE: should move under tutorials?) | rob8714 | Replacing with a more thourough tutorial to contribute to https://github.com/kubernetes-sigs/kustomize/issues/3973 | https://github.com/kubernetes-sigs/kustomize/pull/4516 | |||||||||||||||||||||
4 | resources and controllers | partial | docs/concepts/resources | Move over a merger of the relevant parts of the "Resources" section. Perhaps add some key points from https://github.com/kubernetes/design-proposals-archive/blob/main/architecture/resource-management.md, or a link to it. | ||||||||||||||||||||||||
5 | configuration management | introduction | partial | docs/concepts/object_mangement | Replace with a brief paragraph about the existence of multiple techniques and the fact that Kustomize supports declarative object configuration. Mainly just ink to https://kubernetes.io/docs/concepts/overview/working-with-objects/object-management/. | |||||||||||||||||||||||
6 | partial | docs/getting_started/deploying | Existing content isn't very useful, but we should have a section briefly explaining how to use Kustomize with version control + `kubectl apply` and with `kubectl -k` / `kubectl kustomize` | |||||||||||||||||||||||||
7 | secrets and configmaps | partial | docs/tasks/configmaps_and_secrets | ncapps | Move examples consisting of a short sequence of steps into Tasks. Conceptual information should live in Concepts. | https://github.com/kubernetes-sigs/kustomize/pull/5368 | ||||||||||||||||||||||
8 | container images | partial | docs/tasks/container_images | ncapps | Move examples consisting of a short sequence of steps into Tasks. Conceptual information should live in Concepts. | https://github.com/kubernetes-sigs/kustomize/pull/5368 | ||||||||||||||||||||||
9 | namespaces and names | partial | docs/tasks/namespaces_and_names | ncapps | Move examples consisting of a short sequence of steps into Tasks. Conceptual information should live in Concepts. | https://github.com/kubernetes-sigs/kustomize/pull/5383 | ||||||||||||||||||||||
10 | labels and annotations | partial | docs/tasks/labels_and_annotations | ncapps | Move examples consisting of a short sequence of steps into Tasks. Conceptual information should live in Concepts. | https://github.com/kubernetes-sigs/kustomize/pull/5383 | ||||||||||||||||||||||
11 | bespoke application | partial | docs/tutorials/custom_application | Consider moving the new 'docs/getting_started/first_kustomization' page here instead, since it seems like a better version of the content here. Keep the workflow image though. | ||||||||||||||||||||||||
12 | off the shelf application | yes | docs/tutorials/off_the_shelf_application | aisuko | Switch focus from "deploying" to "configuring". Ideally this would be a tutorial they can actually follow, but just move it to start. Remove references to kubectl. | https://github.com/kubernetes-sigs/kustomize/pull/5121 | ||||||||||||||||||||||
13 | components | yes | Split up: docs/concepts/components docs/tutorials/components AND docs/reference/component | The use case information belongs under "concepts". The walkthrough belongs under "tuorials". Since Component is a top-level object kind, we should have an entry for it under Reference. Since it is also a field, that field should have a subpage under reference/kustomization | ||||||||||||||||||||||||
14 | resource printing | (all) | no | |||||||||||||||||||||||||
15 | container debugging | (all) | no | |||||||||||||||||||||||||
16 | app deployment | diffing local and remote resources | no | |||||||||||||||||||||||||
17 | access multiple clusters | no | ||||||||||||||||||||||||||
18 | pushing bases | yes | docs/tutorials | Consider combining with the "off the shelf" tutorial--this is the publishing side of that same coin | ||||||||||||||||||||||||
19 | extending kubectl | (all) | no | |||||||||||||||||||||||||
20 | extending kustomize | root page | yes | docs/extending_kustomize AND concepts/extensions | Add a basic explanation with cross-links to the "concepts" section (where the "functions" placeholder is). Majority can go as-is in a new "Extending Kustomize" section. | |||||||||||||||||||||||
21 | containerized krm functions | yes | docs/extending_kustomize/containerized_krm_functions | |||||||||||||||||||||||||
22 | exec krm functions | yes | docs/extending_kustomize/exec_krm_functions | |||||||||||||||||||||||||
23 | exec plugins | yes | docs/extending_kustomize/exec_plugins | |||||||||||||||||||||||||
24 | go plugins | yes | docs/extending_kustomize/go_plugins | |||||||||||||||||||||||||
25 | examples | multibase | no | We already have a better version of this migrated | ||||||||||||||||||||||||
26 | inline patching | yes | docs/tutorials/patches | This should focus on showing the different ways catches can be written, not "inline" specifically (it mostly does this already but is oddly titled). Ideally we would also have a "patches" section in the Concept docs. | ||||||||||||||||||||||||
27 | reference | kubectl | no | |||||||||||||||||||||||||
28 | kustomize built-ins | yes | SPLIT: docs/reference/transformers and docs/reference/generators | I think the "built-ins" terminology is confusing. This is essentially a way to access more advanced configuration for functionality exposed through Kustomization fields. Split according to which field of Kustomization they actually work in. Eventually, we should replace the Go-oriented "arguments" section with an end-user-oriented adaptation of that info. Instead of two "usage via..." headings, I'd add a simpler cross-reference to the field docs and focus the content here on the advanced version only. | ||||||||||||||||||||||||
29 | AnnotationsTransformer | yes | docs/reference/transformers | annasong20 | https://github.com/kubernetes-sigs/kustomize/pull/5247 | |||||||||||||||||||||||
30 | commands | yes | docs/reference/kustomize_cli | ncapps | Lots of missing content here. MVP is to validate and move existing. | https://github.com/kubernetes-sigs/kustomize/pull/5304 | ||||||||||||||||||||||
31 | glossary | yes | docs/reference/glossary | ashnehete | https://github.com/kubernetes-sigs/kustomize/pull/5774 | |||||||||||||||||||||||
32 | kustomization | yes | docs/concepts/kustomization_file | The content of the root page belongs in concept docs. The rest is field reference for `kind: Kustomization` | ||||||||||||||||||||||||
33 | kustomization/[field] | yes | SPLIT: docs/concepts/[field] and docs/tasks/[field] | bugoverdose | The reference section should only contain field syntax. These pages contain an amalgamation of general information about the fields. High-level explanations should fall under Concepts, whereas concrete examples with a specific purpose belong in Tasks. Ideally, these fields should reference their syntax in the Reference section. | |||||||||||||||||||||||
34 | FAQ | kubectl | no | |||||||||||||||||||||||||
35 | kustomize/eschewed features | yes | contribute/features#eschewed_features | ashnehete | Could also be its own page under contribute/, but I feel like the audience for this is anyone who is going to propose something, since they should know what we automatically reject | https://github.com/kubernetes-sigs/kustomize/pull/5774 | ||||||||||||||||||||||
36 | kustomize/versioning policy | yes | docs/reference/versioning_policy | ashnehete | Not sure where to put this one, but I don't think FAQ is where folks would look for it intuitively. | https://github.com/kubernetes-sigs/kustomize/pull/5774 | ||||||||||||||||||||||
37 | blog | no | ||||||||||||||||||||||||||
38 | contributing | kubectl | no | |||||||||||||||||||||||||
39 | kustomize | yes | contribute | dani-santos-code | https://github.com/kubernetes-sigs/kustomize/pull/4709 | |||||||||||||||||||||||
40 | kustomize/features | yes | contribute/features | Replace most of the content with a pointer to proposals/README.md in the repo + a link to open an issue. Move issue filing instructions into the issue template itself. | ||||||||||||||||||||||||
41 | documentation | yes | contribute/documentation | Needs re-writing for this new site! | ||||||||||||||||||||||||
42 | Repo | Page | Migrate | Suggested location | Assignee | Comments | PR | Merged | ||||||||||||||||||||
43 | kubernetes-sigs/kustomize | proposals/README.md | partial | contribute/features | Need to reconcile with contribute/features + the issue template itself | |||||||||||||||||||||||
44 | .github/ISSUE_TEMPLATE | partial | contribute/features | Need to reconcile with contribute/features + the readme | ||||||||||||||||||||||||
45 | examples/transformerconfigs | yes | docs/reference/transformers|generators subsections | Although the subdirectories are tested and so need the same strategy as other examples/ content, the README here is not. It contains content that belongs with advanced transformer/generator docs in general (e.g. FieldSpec explanation) and in particular (individual transformer examples, some of which are missing from the old site). Apparently (https://github.com/kubernetes-sigs/kustomize/issues/4772) this page is highly ranked in Google, so we should leave a breadcrumb pointing to the new location. | ||||||||||||||||||||||||
46 | examples/* | yes | docs/tutorials/* | INTERESTING TASK ALERT! These examples are actually run against our test suite! Most of them probably belong in the "tutorials" section of the site, but we need to develop a way to get them there while still preserving their test coverage. With this many tutorials, we'll need to divide them into sections (and I don't think the existing headings are useful fwiw) | ||||||||||||||||||||||||
47 | functions/examples | partial | docs/tutorials/extensions | Maybe just a breadcrumb pointing to the repo in this case? These are also tested, and would be much more difficult to cross-embed usefully than the main examples directory. | ||||||||||||||||||||||||
48 | https://github.com/replicatedhq/kustomize-demo-api and https://github.com/replicatedhq/kustomize-demo | yes | This is a project in and of itself, since it requires standing up and securing infrastructure to run the demo. The contributor will need to figure out how to do this on k8s infrastructure. Kustomize's maintainers don't know any more about this than you do. :) | |||||||||||||||||||||||||
49 | TODO(annasong): kustomize-training-cohort-content | |||||||||||||||||||||||||||
50 | TODO(annasong): repo content, especially repo urls | |||||||||||||||||||||||||||
51 | New Content | Page Group (N/A) | Page (N/A) | Migrate (N/A) | Suggested location | Assignee | Comments | PR | ||||||||||||||||||||
52 | Kustomize API Reference | docs/reference/API/Kustomization File/<field> | Each field should have a page under Reference with its syntax. An example is https://github.com/kubernetes-sigs/kustomize/pull/5247. Ideally, add a cross-reference to the "advanced" version in the transformer/generator reference. | |||||||||||||||||||||||||
53 | ||||||||||||||||||||||||||||
54 | ||||||||||||||||||||||||||||
55 | ||||||||||||||||||||||||||||
56 | ||||||||||||||||||||||||||||
57 | ||||||||||||||||||||||||||||
58 | ||||||||||||||||||||||||||||
59 | ||||||||||||||||||||||||||||
60 | ||||||||||||||||||||||||||||
61 | ||||||||||||||||||||||||||||
62 | ||||||||||||||||||||||||||||
63 | ||||||||||||||||||||||||||||
64 | ||||||||||||||||||||||||||||
65 | ||||||||||||||||||||||||||||
66 | ||||||||||||||||||||||||||||
67 | ||||||||||||||||||||||||||||
68 | ||||||||||||||||||||||||||||
69 | ||||||||||||||||||||||||||||
70 | ||||||||||||||||||||||||||||
71 | ||||||||||||||||||||||||||||
72 | ||||||||||||||||||||||||||||
73 | ||||||||||||||||||||||||||||
74 | ||||||||||||||||||||||||||||
75 | ||||||||||||||||||||||||||||
76 | ||||||||||||||||||||||||||||
77 | ||||||||||||||||||||||||||||
78 | ||||||||||||||||||||||||||||
79 | ||||||||||||||||||||||||||||
80 | ||||||||||||||||||||||||||||
81 | ||||||||||||||||||||||||||||
82 | ||||||||||||||||||||||||||||
83 | ||||||||||||||||||||||||||||
84 | ||||||||||||||||||||||||||||
85 | ||||||||||||||||||||||||||||
86 | ||||||||||||||||||||||||||||
87 | ||||||||||||||||||||||||||||
88 | ||||||||||||||||||||||||||||
89 | ||||||||||||||||||||||||||||
90 | ||||||||||||||||||||||||||||
91 | ||||||||||||||||||||||||||||
92 | ||||||||||||||||||||||||||||
93 | ||||||||||||||||||||||||||||
94 | ||||||||||||||||||||||||||||
95 | ||||||||||||||||||||||||||||
96 | ||||||||||||||||||||||||||||
97 | ||||||||||||||||||||||||||||
98 | ||||||||||||||||||||||||||||
99 | ||||||||||||||||||||||||||||
100 |