Fix/fix faq ciab descr link #292
Conversation
It can be deployed in a VM, but most of the time is not. Fix link to CiaB docs. Restructure the sections a bit. Signed-off-by: Kurt Garloff <[email protected]>
Signed-off-by: Kurt Garloff <[email protected]>
|
Cherry-picked to staging in case you want to view the result ... |
docs/index.mdx
Outdated
|
|
||
| #### Quick Start with Cloud-In-A-Box | ||
|
|
||
| The fastest way to get in touch with SCS is to deploy a SCS cloud virtually. The Cloud-In-A-Box was built explicitly for this scenario. Check it out [here](/docs/iaas/guides/deploy-guide/examples/cloud-in-a-box) | ||
| You can do a single node installation for learning, testing or development purposes. | ||
| The Cloud-In-A-Box configuration was built explicitly for this scenario. |
There was a problem hiding this comment.
Hmm, while I agree in a being lowercase, I consider the term Cloud-in-a-Box a single term rather than four words ... thus my preference to leave the hyphens in it. I believe we have used the form with hyphens at most places in the past. If we want to change that, we should probably grep through our repos and address it everywhere ...
There was a problem hiding this comment.
Partially addressed by 9fc2e2f.
docs/index.mdx
Outdated
| ### Container Layer | ||
|
|
||
| The Reference Implementation (v2) for the container (Kubernetes-as-a-Services = KaaS) layer |
There was a problem hiding this comment.
reference implementation? If Reference Implemention is correct it has to be changed in line 21.
Kubernetes-as-a-Services -> Kubernetes as a Service
There was a problem hiding this comment.
I capitalized Reference Implementation at both places now, giving it the property of a name. See 9fc2e2f.
There was a problem hiding this comment.
I have not removed the hyphens from Kubernetes-as-a-Service ... I consider this a single word.
In particular: - Capitalize Reference Implementation and Ceph. - Decapitalize the in-a from Cloud-in-a-Box. - Remove extra 's' from Kubernetes-as-a-Service*s*. - Use internal links where possible. Signed-off-by: Kurt Garloff <[email protected]>
|
Thanks for your diligent review, @berendt ! |
In the intro "about", the link to CiaB was broken.
Furthermore, it talked about CiaB as a virtual deployment.
While CiaB can be deployed virtually, it is typically not. The point of CiaB is that it's a single-node deployment.
Being at it: