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.

Sign up for GitHub

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

Jump to bottom

docs/spec: document v2beta2 API #828

Merged
merged 19 commits into from
Dec 11, 2023
Merged

docs/spec: document v2beta2 API #828

merged 19 commits into from
Dec 11, 2023

Conversation

hiddeco
Copy link
Member

@hiddeco hiddeco commented Dec 6, 2023 •
edited
Loading

Would be nice to add (but could be added later):

  • More advanced examples on some subjects.

@hiddeco hiddeco added the area/docs Documentation related issues and pull requests label Dec 6, 2023
@hiddeco hiddeco force-pushed the document-v2beta2 branch 3 times, most recently from 6d9673c to ce9ab63 Compare December 6, 2023 11:19
@hiddeco hiddeco force-pushed the document-v2beta2 branch 11 times, most recently from 482f026 to 5942f39 Compare December 7, 2023 09:48
@hiddeco hiddeco marked this pull request as ready for review December 7, 2023 09:48
@hiddeco hiddeco mentioned this pull request Dec 7, 2023
Merged
@hiddeco hiddeco force-pushed the document-v2beta2 branch 3 times, most recently from cfa1f70 to 8230c00 Compare December 8, 2023 16:21
aryan9600
aryan9600 reviewed Dec 8, 2023
View reviewed changes
docs/spec/v2beta2/helmreleases.md Outdated Show resolved Hide resolved
docs/spec/v2beta2/helmreleases.md Outdated Show resolved Hide resolved
docs/spec/v2beta2/helmreleases.md Outdated Show resolved Hide resolved
docs/spec/v2beta2/helmreleases.md Outdated Show resolved Hide resolved
docs/spec/v2beta2/helmreleases.md Outdated Show resolved Hide resolved
docs/spec/v2beta2/helmreleases.md Outdated Show resolved Hide resolved
docs/spec/v2beta2/helmreleases.md Outdated Show resolved Hide resolved
docs/spec/v2beta2/helmreleases.md Show resolved Hide resolved
@hiddeco hiddeco force-pushed the document-v2beta2 branch 2 times, most recently from 26d4145 to 5b4ebf2 Compare December 11, 2023 14:43
darkowlzz
darkowlzz reviewed Dec 11, 2023
View reviewed changes
docs/spec/v2beta2/helmreleases.md Outdated Show resolved Hide resolved
docs/spec/v2beta2/helmreleases.md Outdated Show resolved Hide resolved
@hiddeco hiddeco force-pushed the document-v2beta2 branch 2 times, most recently from e6890e5 to a0af3d6 Compare December 11, 2023 15:43
darkowlzz
darkowlzz approved these changes Dec 11, 2023
View reviewed changes
Copy link
Contributor

@darkowlzz darkowlzz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

darkowlzz
darkowlzz reviewed Dec 11, 2023
View reviewed changes
README.md Show resolved Hide resolved
aryan9600
aryan9600 approved these changes Dec 11, 2023
View reviewed changes
Copy link
Member

@aryan9600 aryan9600 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! amazing job 🙇

makkes
makkes reviewed Dec 11, 2023
View reviewed changes
docs/spec/v2beta2/helmreleases.md Show resolved Hide resolved
docs/spec/v2beta2/helmreleases.md Outdated Show resolved Hide resolved
docs/spec/v2beta2/helmreleases.md Show resolved Hide resolved
docs/spec/v2beta2/helmreleases.md Outdated Show resolved Hide resolved
docs/spec/v2beta2/helmreleases.md Show resolved Hide resolved
docs/spec/v2beta2/helmreleases.md Show resolved Hide resolved
docs/spec/v2beta2/helmreleases.md Show resolved Hide resolved
docs/spec/v2beta2/helmreleases.md Show resolved Hide resolved
docs/spec/v2beta2/helmreleases.md Show resolved Hide resolved
hiddeco added 18 commits December 11, 2023 18:28
@hiddeco
docs/spec: start documenting v2beta2
436860f 
Signed-off-by: Hidde Beydals <hidde@hhh.computer>
@hiddeco
docs/spec/v2beta2: document RBAC
f267492 
Signed-off-by: Hidde Beydals <hidde@hhh.computer>
@hiddeco
doc/spec/v2beta2: document CRD lifecycle
eca8691 
Signed-off-by: Hidde Beydals <hidde@hhh.computer>
@hiddeco
docs/spec/v2beta2: document failure handling
2c48cf2 
Signed-off-by: Hidde Beydals <hidde@hhh.computer>
@hiddeco
docs/spec/v2beta2: document remote clusters
d741525 
Signed-off-by: Hidde Beydals <hidde@hhh.computer>
@hiddeco
docs/spec/v2beta2: add uninstall warnings
aeef72a 
Signed-off-by: Hidde Beydals <hidde@hhh.computer>
@hiddeco
docs/spec/v2beta2: make note of release triggers
1b0e5d7 
Signed-off-by: Hidde Beydals <hidde@hhh.computer>
@hiddeco
docs/spec/v2beta2: document debugging section
99303f3 
Signed-off-by: Hidde Beydals <hidde@hhh.computer>
@hiddeco
docs/spec/v2beta2: document most Status fields
04600fe 
Signed-off-by: Hidde Beydals <hidde@hhh.computer>
@hiddeco
docs/spec/v2beta2: explain example
875e605 
Signed-off-by: Hidde Beydals <hidde@hhh.computer>
@hiddeco
docs/spec/v2beta2: document Status Conditions
8a9acd6 
Signed-off-by: Hidde Beydals <hidde@hhh.computer>
@hiddeco
docs/spec/v2beta2: rewrite intro
0075f20 
Signed-off-by: Hidde Beydals <hidde@hhh.computer>
@hiddeco
docs/spec/v2beta2: add README
015eba0 
Signed-off-by: Hidde Beydals <hidde@hhh.computer>
@hiddeco
docs: add notes about drift detection support
2b80e30 
Signed-off-by: Hidde Beydals <hidde@hhh.computer>
@hiddeco
docs/spec/v2beta2: address review comments
9eefbf7 
Signed-off-by: Hidde Beydals <hidde@hhh.computer>
@hiddeco
docs/spec/v2beta2: add Ready characteristics
302978f 
Signed-off-by: Hidde Beydals <hidde@hhh.computer>
@hiddeco
docs/spec/v2beta2: address review comment
344bd82 
Signed-off-by: Hidde Beydals <hidde@hhh.computer>
@hiddeco
docs/spec: refer to v2beta2 doc for design details
d8966cd 
Signed-off-by: Hidde Beydals <hidde@hhh.computer>
@hiddeco
docs: various doc nits
bb5a03b 
Signed-off-by: Hidde Beydals <hidde@hhh.computer>
makkes
makkes approved these changes Dec 11, 2023
View reviewed changes
Copy link
Member

@makkes makkes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a great improvement over the current docs!

@hiddeco hiddeco merged commit 14a333d into main Dec 11, 2023
6 checks passed
@hiddeco hiddeco deleted the document-v2beta2 branch December 11, 2023 18:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@stefanprodan stefanprodan stefanprodan left review comments

@darkowlzz darkowlzz darkowlzz approved these changes

@aryan9600 aryan9600 aryan9600 approved these changes

@makkes makkes makkes approved these changes

Assignees
No one assigned
Labels
area/docs Documentation related issues and pull requests
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@hiddeco @makkes @darkowlzz @stefanprodan @aryan9600