kcp icon indicating copy to clipboard operation
kcp copied to clipboard

bug: home/doc page is not clear about the top-level modularity

Open MikeSpreitzer opened this issue 2 years ago • 3 comments

Describe the bug

https://docs.kcp.io/kcp/main/ , equivalently https://github.com/kcp-dev/kcp/blob/main/README.md , starts off with an overview that mixes up features from the three main layers and the rest of the document does nothing to clarify.

If I understand correctly, the top level structure of kcp is three layers: lowest is the "core", which focuses on apiserver virtualization (possibly further split into a lower layer that does logical clusters and a higher layer that provides workspaces); middle is the kcp version of kube-bind; top is TMC. Although some of us are also working on adding Edge MC as a peer of Transparent MC.

Steps To Reproduce

  1. Read the doc

Expected Behaviour

I think the modularity is a key part of the idea and should be clearly stated in the root document.

Additional Context

No response

MikeSpreitzer avatar Dec 13 '22 20:12 MikeSpreitzer

I guess this is somewhat related to (or maybe a duplicate) of #1211? We are fully committed to rewriting the readme to be entirely clear, but are holding off doing so until after we split the repos (core, tenancy, tmc).

ncdc avatar Dec 14 '22 14:12 ncdc

Issues go stale after 90d of inactivity. After a furter 30 days, they will turn rotten. Mark the issue as fresh with /remove-lifecycle stale.

If this issue is safe to close now please do so with /close.

/lifecycle stale

kcp-ci-bot avatar Apr 15 '24 08:04 kcp-ci-bot

Stale issues rot after 30d of inactivity. Mark the issue as fresh with /remove-lifecycle rotten. Rotten issues close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

/lifecycle rotten

kcp-ci-bot avatar May 15 '24 08:05 kcp-ci-bot

Rotten issues close after 30d of inactivity. Reopen the issue with /reopen. Mark the issue as fresh with /remove-lifecycle rotten.

/close

kcp-ci-bot avatar Jun 14 '24 08:06 kcp-ci-bot

@kcp-ci-bot: Closing this issue.

In response to this:

Rotten issues close after 30d of inactivity. Reopen the issue with /reopen. Mark the issue as fresh with /remove-lifecycle rotten.

/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

kcp-ci-bot avatar Jun 14 '24 08:06 kcp-ci-bot