Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add parameterized CMPs proposal #8103

Merged
merged 60 commits into from
Mar 16, 2022
Merged
Show file tree
Hide file tree
Changes from 59 commits
Commits
Show all changes
60 commits
Select commit Hold shift + click to select a range
3c5b5ab
docs: add cmp parameters proposal draft
crenshaw-dev Jan 5, 2022
51f1cd6
chore: more detail
crenshaw-dev Jan 7, 2022
3c972d4
chore: add note about parameter schema w.r.t. CRDs
crenshaw-dev Jan 7, 2022
798b35d
chore: rename description field to metadata to avoid ambiguity
crenshaw-dev Jan 7, 2022
4b1175b
chore: fix typo, fix name of param section
crenshaw-dev Jan 7, 2022
272f92c
chore: even clearer field name
crenshaw-dev Jan 7, 2022
edde8e7
chore: clarify value field of parameter schema
crenshaw-dev Jan 7, 2022
2aa512d
chore: use code and better naming
crenshaw-dev Jan 7, 2022
2a81b36
chore: comments are good
crenshaw-dev Jan 7, 2022
32e7cba
chore: don't claim that the plugin needs to describe the parts of an …
crenshaw-dev Jan 7, 2022
cdb37d4
chore: explain why 'parameters' is plural in 'parameters announcement'
crenshaw-dev Jan 7, 2022
b10ac3b
chore: formatting, fix type name
crenshaw-dev Jan 7, 2022
9c10238
chore: fix header levels
crenshaw-dev Jan 8, 2022
c4b68a8
chore: more details
crenshaw-dev Jan 10, 2022
035fab6
chore: rename proposal, add more features/fixes we need to consider
crenshaw-dev Jan 11, 2022
4117401
docs: add another example
crenshaw-dev Jan 13, 2022
499c6ac
docs: add section about changed plugin config schema
crenshaw-dev Jan 13, 2022
5b7d0fa
docs: note that the param discovery command should also get the curre…
crenshaw-dev Jan 13, 2022
e83106b
docs: add another example
crenshaw-dev Jan 13, 2022
774a2be
docs: add screenshot of what we're trying to mimic
crenshaw-dev Jan 13, 2022
77b7a34
docs: add toc
crenshaw-dev Jan 13, 2022
f6312a9
docs: add open questions
crenshaw-dev Jan 13, 2022
5ae0a0a
chore: fix TOC
crenshaw-dev Jan 13, 2022
7efbcc5
chore: typos
crenshaw-dev Jan 13, 2022
badb948
docs: correct incomplete example
crenshaw-dev Jan 13, 2022
e52f901
Address ParameterDefinition to reflect review discussion
leoluz Jan 25, 2022
ab18930
Address review comments
leoluz Jan 25, 2022
338acf1
docs: improvements based on convo w/ Alex & Leo
crenshaw-dev Jan 25, 2022
b82f13e
Merge pull request #1 from leoluz/cmp-params-proposal-leo
crenshaw-dev Jan 26, 2022
b4b7ec9
docs: further clarify env var names
crenshaw-dev Jan 26, 2022
3ed2b5b
chore: merge upstream
crenshaw-dev Jan 26, 2022
3fa17f8
chore: fix broken links
crenshaw-dev Jan 26, 2022
862fa8d
docs: add comparison between integrated and separate UI/param config
crenshaw-dev Jan 26, 2022
4fac60e
chore: make 2nd example match 1st more closely
crenshaw-dev Jan 26, 2022
f6debd6
chore: split pro into 2 bullet points
crenshaw-dev Jan 26, 2022
ac43cec
chore: add another pro
crenshaw-dev Jan 26, 2022
20b02a3
chore: add another con
crenshaw-dev Jan 26, 2022
c2b3c02
Merge pull request #2 from crenshaw-dev/cmp-parameters-proposal-impro…
crenshaw-dev Jan 26, 2022
546963f
chore: fix json format
crenshaw-dev Jan 26, 2022
51f9462
docs: add examples for new schema proposal
crenshaw-dev Jan 27, 2022
b345749
docs: add example
crenshaw-dev Jan 27, 2022
054ef19
docs: finish example
crenshaw-dev Jan 27, 2022
2ad712e
docs: add another question
crenshaw-dev Jan 27, 2022
5ef98ae
docs: more suggestions
crenshaw-dev Jan 27, 2022
6bb16fa
docs: add another question
crenshaw-dev Jan 27, 2022
f9d1c20
docs: more questions
crenshaw-dev Jan 27, 2022
c34e9c6
docs: remove no-longer-applicable requirements
crenshaw-dev Jan 27, 2022
9d48814
docs: add another prerequisite
crenshaw-dev Jan 27, 2022
5675b25
docs: update main doc based on new conclusions
crenshaw-dev Jan 27, 2022
58406ff
chore: typo
crenshaw-dev Jan 27, 2022
9f03f80
docs: add tentative data structures
crenshaw-dev Jan 27, 2022
1ba5dbf
docs: default to new schema (WIP)
crenshaw-dev Jan 28, 2022
3bedf49
docs: flatten announcement and param spec
crenshaw-dev Jan 28, 2022
a6e66e4
docs: promote sub-proposal portion to actual proposal
crenshaw-dev Jan 31, 2022
43b3166
docs: remove no-longer-needed images
crenshaw-dev Jan 31, 2022
37e2edf
docs: fix param JSON generation command
crenshaw-dev Jan 31, 2022
94e1820
docs: update from old structure
crenshaw-dev Jan 31, 2022
ccb6479
docs: remove string type since it's assumed
crenshaw-dev Jan 31, 2022
ba0c199
Merge pull request #3 from crenshaw-dev/cmp-parameters-proposal-impro…
crenshaw-dev Feb 1, 2022
452de2b
docs: address comment about env vars, add note about languages
crenshaw-dev Feb 4, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/proposals/001-proposal-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Neat-enhancement-idea
authors:
- "@sbose78" # Authors' github accounts here.
sponsors:
- TBD # List all intereste parties here.
crenshaw-dev marked this conversation as resolved.
Show resolved Hide resolved
- TBD # List all interested parties here.
reviewers:
- "@alexmt"
- TBD
Expand Down Expand Up @@ -58,10 +58,10 @@ This is where we get down to details of what the proposal is about.

Add a list of detailed use cases this enhancement intends to take care of.

## Use case 1:
#### Use case 1:
As a user, I would like to understand the drift. (This is an example)

## Use case 2:
#### Use case 2:
As a user, I would like to take an action on the deviation/drift. (This is an example)

### Implementation Details/Notes/Constraints [optional]
Expand Down
Binary file added docs/proposals/images/helm-parameters.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading