Conversation
…b URL Signed-off-by: Surbhi <agarwalsurbhi1807@gmail.com>
✅ Deploy Preview for kptdocs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
…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>
887e427 to
6f6ab3c
Compare
liamfallon
left a comment
There was a problem hiding this comment.
Hi @SurbhiAgarwal1 ,
This PR brings up other questions @CsatariGergely @mozesl-nokia @efiacor @ciaranjohnston:
- 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
- We need to decide if we should include this page in the documentation
- There's a "drawing" referenced in the Package orchestration
- The summary refers to a non existant "next guide", that should show how to scale to hundreds of tenants. We should remove that reference.
|
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. |
|
@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. |
|
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 |
f6fa177 to
6f6ab3c
Compare
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: