Skip to content

Fix/docs todo link#4393

Open
SurbhiAgarwal1 wants to merge 3 commits intokptdev:mainfrom
SurbhiAgarwal1:fix/docs-todo-link
Open

Fix/docs todo link#4393
SurbhiAgarwal1 wants to merge 3 commits intokptdev:mainfrom
SurbhiAgarwal1:fix/docs-todo-link

Conversation

@SurbhiAgarwal1
Copy link

@SurbhiAgarwal1 SurbhiAgarwal1 commented Feb 15, 2026

Summary

Improves the tenant onboarding documentation by replacing a TODO comment with a helpful reference to example tenant packages, making it easier for users to understand and create proper tenant onboarding pull requests.

Problem

The tenant onboarding guide contained an unresolved TODO comment that left users without clear guidance on what their pull requests should look like:

# make a pull request for platform team to merge
# TODO 

…b URL

Signed-off-by: Surbhi <agarwalsurbhi1807@gmail.com>
Copilot AI review requested due to automatic review settings February 15, 2026 18:29
@netlify
Copy link

netlify bot commented Feb 15, 2026

Deploy Preview for kptdocs ready!

Name Link
🔨 Latest commit a3b5b21
🔍 Latest deploy log https://app.netlify.com/projects/kptdocs/deploys/699430708b21b3000840b87b
😎 Deploy Preview https://deploy-preview-4393--kptdocs.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.

@dosubot dosubot bot added the documentation Improvements or additions to documentation label Feb 15, 2026
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

…ved outdated TODO comment and added a helpful reference to example\ntenant packages in the repository. This provides users with concrete\nexamples to follow when creating their own tenant onboarding PRs."

Signed-off-by: Surbhi <agarwalsurbhi1807@gmail.com>
Copy link
Contributor

@liamfallon liamfallon left a comment

Choose a reason for hiding this comment

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

Hi @SurbhiAgarwal1 ,

This PR brings up other questions @CsatariGergely @mozesl-nokia @efiacor @ciaranjohnston:

  1. This guide is not listed on the guide page in our documentation guides, I don't remember if this was deliberate when we cleaned up the dcumentation but you can get at it at this link
  2. We need to decide if we should include this page in the documentation
  3. There's a "drawing" referenced in the Package orchestration
  4. The summary refers to a non existant "next guide", that should show how to scale to hundreds of tenants. We should remove that reference.

@SurbhiAgarwal1
Copy link
Author

Hi @liamfallon,

Thank you for the detailed review.

Regarding the guide not being listed — I’m happy to follow the team’s direction. If the intention is to keep it unlisted, I’ll leave it as is. If it should be included in the documentation index, I can update the guide page accordingly.

I’ll remove the reference to the non-existent “next guide” to avoid confusion.

I’ll also check and address the missing “drawing” reference in the Package orchestration section.

Please let me know how you’d prefer to proceed regarding including this guide in the main documentation.

Thanks again for the guidance.

@mozesl-nokia
Copy link

@liamfallon I think it might be worthwhile to keep, but it needs a rewrite.

For now, we could add it to the list of guides and "tag" it as WIP perhaps? ...and have a big warning at the start saying that it is due a rewrite and might not be 100% relevant/accurate to current kpt.

@liamfallon
Copy link
Contributor

@liamfallon I think it might be worthwhile to keep, but it needs a rewrite.

For now, we could add it to the list of guides and "tag" it as WIP perhaps? ...and have a big warning at the start saying that it is due a rewrite and might not be 100% relevant/accurate to current kpt.

Yes, that sounds like a good idea.

@SurbhiAgarwal1
Copy link
Author

Hi @mozesl-nokia and @liamfallon,

Thanks for the discussion — that makes sense.

I’ll:

Add the guide to the documentation list

Clearly tag it as WIP

Add a prominent warning at the beginning indicating that it is due for a rewrite and may not fully reflect the current state of kpt

Let me know if there’s any preferred wording or formatting for WIP notices in the docs

Copilot AI review requested due to automatic review settings February 17, 2026 02:21
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

Copilot AI review requested due to automatic review settings February 17, 2026 09:10
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants