Skip to content

Docs/fix subscription todo comments#6546

Merged
knative-prow[bot] merged 4 commits intoknative:mainfrom
Kunal1522:docs/fix-subscription-todo-comments
Jan 12, 2026
Merged

Docs/fix subscription todo comments#6546
knative-prow[bot] merged 4 commits intoknative:mainfrom
Kunal1522:docs/fix-subscription-todo-comments

Conversation

@Kunal1522
Copy link
Contributor

Resolve TODO comments in subscriptions.md

Problem

Two TODO comments in subscriptions.md needed resolution:

  1. Missing example output for kn subscription describe command
  2. Missing examples for updating subscriptions with kn CLI

Changes

  • Added kn subscription describe example output (lines 144-174)
    • Shows all key fields: Name, Namespace, Channel, Subscriber, Conditions
    • Uses proper formatting with Success admonition
  • Added "Updating a Subscription" section (lines 176-199)
    • Documents kn subscription update command
    • Provides comprehensive example showing sink, dead letter sink, and reply sink updates
    • Includes both kn and kubectl approaches

Release Notes

Completed subscription documentation by adding kn subscription describe example output and update examples

- Add example output for 'kn subscription describe' command
- Add comprehensive 'Updating a Subscription' section with kn and kubectl examples
- Include three practical update scenarios: changing sink, adding dead letter sink, and updating reply sink
- Remove TODO comments once addressed

Fixes knative/docs issue with incomplete subscription documentation
- Replace 'kn subscription create' with 'kn subscription update' for updating subscriptions
- Remove unnecessary --channel parameter from update commands
- Fix 'kubectl subscription delete' to 'kubectl delete subscription'
- Simplify update command examples based on actual kn CLI behavior

Verified with local Knative cluster testing.
Consolidated three separate update examples into one that shows all parameters together. Makes the documentation more concise while still covering all update scenarios.
Reverting kubectl command back to original syntax as requested.
@netlify
Copy link

netlify bot commented Dec 23, 2025

Deploy Preview for knative ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit f7b0116
🔍 Latest deploy log https://app.netlify.com/projects/knative/deploys/694b203116219400087abd1b
😎 Deploy Preview https://deploy-preview-6546--knative.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@knative-prow knative-prow bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Dec 23, 2025
@knative-prow knative-prow bot requested review from creydr and pierDipi December 23, 2025 23:05
@Kunal1522
Copy link
Contributor Author

cc @creydr / @pierDipi

Copy link
Member

@creydr creydr left a comment

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 @Kunal1522
/lgtm

@knative-prow
Copy link

knative-prow bot commented Jan 12, 2026

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: creydr, Kunal1522

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@knative-prow knative-prow bot added lgtm Indicates that a PR is ready to be merged. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Jan 12, 2026
@knative-prow knative-prow bot merged commit 3075c6c into knative:main Jan 12, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants