capsule icon indicating copy to clipboard operation
capsule copied to clipboard

Documentation Discrepancy: Tenant Name Mismatch in the documentation

Open santhakali opened this issue 5 months ago • 5 comments
trafficstars

Issue:

In the "Assigning Ownership to Users" subsection, the descriptive text states:

"Bill creates a new tenant "oil" in the CaaS management portal according to the tenant’s profile:"

However, the subsequent sample code block and the kubectl get tenant command output consistently refer to a tenant named "solar":

apiVersion: capsule.clastix.io/v1beta2
kind: Tenant
metadata:
  name: solar # <--- Here, it's 'solar'
spec:
  owners:
  - name: alice
    kind: User

and

kubectl get tenant solar # <--- Here, it's 'solar'
NAME     STATE      NAMESPACE QUOTA    NAMESPACE COUNT    NODE SELECTOR        AGE
solar       Active                                            0                                                                      33m

This creates a minor point of confusion as the example switches tenant names mid-explanation. There are inconsistency throughout.

Suggested Improvement: Please update the documentation to ensure consistency. It would be best to change the text "oil" to "solar" to match the provided code examples and the subsequent kubectl get tenant command, or vice-versa if "oil" is the intended example. Given the commands, aligning the text with "solar" seems to be the most straightforward fix.

It would also be beneficial to conduct a general review of the documentation for other similar discrepancies or typos to enhance clarity and user experience.

Thank you for your consideration!

santhakali avatar Jun 09 '25 11:06 santhakali