Skip to content

feat: Better CRD docs - #319

Merged
adwk67 merged 16 commits into
mainfrom
feat/better-crd-docs
Dec 14, 2023
Merged

feat: Better CRD docs#319
adwk67 merged 16 commits into
mainfrom
feat/better-crd-docs

Conversation

@fhennig

@fhennig fhennig commented Dec 11, 2023 •
edited by adwk67
Loading

Copy link
Copy Markdown
Contributor

Description

Better CRD docs

Definition of Done Checklist

  • Not all of these items are applicable to all PRs, the author should update this template to only leave the boxes in that are relevant
  • Please make sure all these things are done and tick the boxes
# Author
- [x] Changes are OpenShift compatible
- [x] CRD changes approved
- [x] Helm chart can be installed and deployed operator works
- [x] Integration tests passed (for non trivial changes)
- [x] Changes need to be "offline" compatible

# Reviewer
- [x] Code contains useful comments
- [x] (Integration-)Test cases added
- [x] Documentation added or updated
- [x] Changelog updated
- [x] Cargo.toml only contains references to git tags (not specific commits or branches)

# Acceptance
- [ ] Feature Tracker has been updated
- [ ] Proper release label has been added

@fhennig fhennig mentioned this pull request Dec 11, 2023
Closed
@fhennig

fhennig commented Dec 11, 2023

Copy link
Copy Markdown
Contributor Author

I consider this blocked on this ticket: #320

@adwk67 adwk67 linked an issue Dec 12, 2023 that may be closed by this pull request
Lots of optional properties shouldn't be optional #320
Closed
@adwk67

adwk67 commented Dec 12, 2023

Copy link
Copy Markdown
Member

Jenkins 🟢 https://ci.stackable.tech/view/02%20Operator%20Tests%20(custom)/job/spark-k8s-operator-it-custom/114/

@sbernauer
sbernauer self-requested a review December 13, 2023 07:25
sbernauer
sbernauer requested changes Dec 13, 2023
View reviewed changes

@sbernauer sbernauer left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks for working on this and sorry for all these comments! But every Option<> we can get rid of IMHO makes the code better and less error-prone and prevents configuration errors. I'm also happy to do the proposed changes, in that case ping me :)

Comment thread Cargo.toml Outdated
Comment thread rust/crd/src/lib.rs Outdated
Comment thread rust/crd/src/lib.rs Outdated
Comment thread rust/crd/src/lib.rs
Comment thread rust/crd/src/lib.rs Outdated
Comment thread rust/crd/src/lib.rs Outdated
Comment thread rust/crd/src/lib.rs Outdated
Comment thread rust/crd/src/lib.rs Outdated
Comment thread CHANGELOG.md
Comment thread rust/crd/src/lib.rs Outdated
sbernauer
sbernauer previously approved these changes Dec 13, 2023
View reviewed changes

@sbernauer sbernauer left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

It would be awesome if you could address the two remaining comments (also technically the changelog entry would be below Changed instead of Added)
I have to leave for vacation, please don't block the merge on me

@adwk67

adwk67 commented Dec 13, 2023

Copy link
Copy Markdown
Member

Thanks @sbernauer! I'm working on the last 2-3 points...

@adwk67

adwk67 commented Dec 13, 2023 •
edited
Loading

Copy link
Copy Markdown
Member

Jenkins 🟢 https://ci.stackable.tech/view/02%20Operator%20Tests%20(custom)/job/spark-k8s-operator-it-custom/118/

maltesander
maltesander approved these changes Dec 14, 2023
View reviewed changes

@maltesander maltesander left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM!

@adwk67
adwk67 added this pull request to the merge queue Dec 14, 2023
Merged via the queue into main with commit 97301f5 Dec 14, 2023
@adwk67
adwk67 deleted the feat/better-crd-docs branch December 14, 2023 08:41
@lfrancke lfrancke added the release-note/action-required Denotes a PR that introduces potentially breaking changes that require user action. label Sep 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@adwk67 adwk67 adwk67 left review comments
@maltesander maltesander maltesander approved these changes
@sbernauer sbernauer sbernauer left review comments

Assignees

No one assigned

Labels

release-note/action-required Denotes a PR that introduces potentially breaking changes that require user action.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Lots of optional properties shouldn't be optional

5 participants

@fhennig @adwk67 @maltesander @sbernauer @lfrancke