kcp
kcp copied to clipboard
docs: enhance virtual workspaces/apiserver documentation
Feature Description
Currently we have https://docs.google.com/document/d/1LDVQkCrX2Euu538XuH_cY8UbSnoKCLPJ-hEM1PHa3zE/edit#heading=h.qu0ei7nbzxvn which gives a high level overview about virtual workspaces and virtual apiservers.
Proposed Solution
We should update this document, add and fix missing terminology, and move the content into https://github.com/kcp-dev/kcp/blob/main/docs/virtual-workspaces.md
Alternative Solutions
No response
Want to contribute?
- [x] I would like to work on this issue.
Additional Context
No response
In case you're not going to be the one to pick this up, what kinds of questions should the new doc aim to answer? What items / concepts / workflows should someone walk away with after reading the doc?
@stevekuznetsov oh i didn't see the checkbox, i can definitely work on that, no problem 👍
what kinds of questions should the new doc aim to answer?
We have different kinds of virtual apiservers serving different purposes, hosted unter different paths (i.e. virtual apiexport apiserver, home workspaces and its virtual apiserver, syncer virtual workspace).
These different virtual apiserver concepts and their underlying workspace concepts are currently not well documented in this repository.
What items / concepts / workflows should someone walk away with after reading the doc?
The reader should be able to understand the above virtual apiserver types and their exposed workspace URLs as well as their intended use cases.
@s-urbaniak is the linked google doc publicly accessible?
@hasheddan it is now (to kcp-dev google group members) 😄
@ncdc thank you!