Skip to content

Conversation

@NickLarsenNZ
Copy link
Member

@NickLarsenNZ NickLarsenNZ commented May 20, 2025

The audience for doc-comments are quite different to those for the hosted CRD docs, so we should override CRD descriptions when they contain developer-level details.

Note

There are likely more changes required, but these are the few I noticed when bumping stackable-operator for druid-operator.

image

Description

Please add a description here. This will become the commit message of the merge request later.

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
- [ ] Changes are OpenShift compatible
- [ ] CRD changes approved
- [ ] Integration tests passed (for non trivial changes)
# Reviewer
- [ ] Code contains useful comments
- [ ] (Integration-)Test cases added
- [ ] Documentation added or updated
- [ ] Changelog updated
- [ ] 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

…riptions

This is because the audience for doc-comments are quite different to those for the hosted CRD docs.
@NickLarsenNZ NickLarsenNZ self-assigned this May 20, 2025
@NickLarsenNZ NickLarsenNZ moved this to Development: Waiting for Review in Stackable Engineering May 20, 2025
@Techassi Techassi moved this from Development: Waiting for Review to Development: In Review in Stackable Engineering May 20, 2025
@NickLarsenNZ NickLarsenNZ enabled auto-merge May 20, 2025 10:37
@NickLarsenNZ
Copy link
Member Author

It passes locally:

❯ pre-commit run --from-ref origin/main --to-ref HEAD
trim trailing whitespace.................................................Passed
fix end of files.........................................................Passed
detect aws credentials...................................................Passed
detect private key.......................................................Passed
clippy...................................................................Passed
yamllint.............................................(no files to check)Skipped
markdownlint.........................................(no files to check)Skipped
ShellCheck v0.10.0...................................(no files to check)Skipped
Lint GitHub Actions workflow files...................(no files to check)Skipped
Lint Dockerfiles.....................................(no files to check)Skipped
.scripts/verify-crate-versions...........................................Passed
rustfmt..................................................................Passed

@NickLarsenNZ NickLarsenNZ disabled auto-merge May 20, 2025 10:49
@NickLarsenNZ NickLarsenNZ added this pull request to the merge queue May 20, 2025
Merged via the queue into main with commit 9a4c959 May 20, 2025
7 of 8 checks passed
@NickLarsenNZ NickLarsenNZ deleted the chore/split-crd-docs branch May 20, 2025 11:00
NickLarsenNZ added a commit to stackabletech/druid-operator that referenced this pull request May 20, 2025
Note: Common CRD structs are now versioned. The CRD descriptions will be improved once changes like stackabletech/operator-rs#1040
@Techassi Techassi moved this from Development: In Review to Development: Done in Stackable Engineering May 20, 2025
github-merge-queue bot pushed a commit to stackabletech/druid-operator that referenced this pull request May 20, 2025
* chore: Bump stackable_operator to 0.93.0

Note: Common CRD structs are now versioned. The CRD descriptions will be improved once changes like stackabletech/operator-rs#1040

* chore: Replace docs URL with placeholder

* chore: Update changelog

* chore: Bump built dep
@lfrancke lfrancke moved this from Development: Done to Done in Stackable Engineering May 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

2 participants