Skip to content

docs: improve listener documentation - #318

Merged
xeniape merged 9 commits into
mainfrom
docs/handover
Jul 14, 2025
Merged

docs: improve listener documentation#318
xeniape merged 9 commits into
mainfrom
docs/handover

Conversation

@xeniape

@xeniape xeniape commented Jul 7, 2025

Copy link
Copy Markdown
Member

Description

Closes #316. Work was done by @nightkr as part of the handover.

Generated docs (after docs building again): https://docs.stackable.tech/home/nightly/listener-operator/listener/

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
  • CRD documentation for all fields, following the style guide.
  • Helm chart can be installed and deployed operator works
  • Integration tests passed (for non trivial changes)
  • Changes need to be "offline" compatible
  • Links to generated (nightly) docs added
  • Release note snippet added

Reviewer

  • Code contains useful comments
  • Code contains useful logging statements
  • (Integration-)Test cases added
  • Documentation added or updated. Follows the style guide.
  • 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
  • Links to generated (nightly) docs added
  • Release note snippet added
  • Add type/deprecation label & add to the deprecation schedule
  • Add type/experimental label & add to the experimental features tracker

@xeniape xeniape self-assigned this Jul 7, 2025
@adwk67
adwk67 self-requested a review July 8, 2025 09:40

@adwk67 adwk67 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.

Just a couple of minor points.

Comment thread docs/modules/listener-operator/pages/listener.adoc Outdated
Comment thread docs/modules/listener-operator/pages/listener.adoc Outdated
@xeniape
xeniape requested a review from adwk67 July 14, 2025 06:14

@adwk67 adwk67 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.

@xeniape
xeniape added this pull request to the merge queue Jul 14, 2025
Merged via the queue into main with commit 5e5aa0f Jul 14, 2025
17 checks passed
@xeniape
xeniape deleted the docs/handover branch July 14, 2025 11:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Nat handover documentation

4 participants