-
Notifications
You must be signed in to change notification settings - Fork 31
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Adds external.platform.(apiKey/autoSleep/autoDelete) docs #194
Conversation
✅ Deploy Preview for vcluster-docs-site ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Setting this as draft until the createRBAC apiKey changes are merged and I can update. |
I talked with Russ and Denise and Denise about this one and where the platform config options should reside given that the vcluster.yaml docs are on the OSS side of the docs. The plan is to have the generator produce the partials in the regular location and only have it the platform specific fields show up in a new |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's not obvious to me if fields like autoSleep and external are top level vcluster.yaml fields from this page: https://deploy-preview-194--vcluster-docs-site.netlify.app/docs/platform/api/resources/vcluster-yaml/
I know external is, so I assume autoSleep is too from the structure of the docs, but maybe we can add a comment on the vcluster.yaml page in platform to make this clearer?
@rohantmp very good point. I've updated to build the partials for the hierarchy and put that at the top level |
Shouldn't there be updates on vcluster.yaml and the support in there? I don't see it in this PR. |
@deniseschannon Added those to the vCluster side with pro labels. |
vcluster.yaml in vCluster Preview Comments The layout for the new pages look different than the older pages, where we generally have a small blurb about what the key is about. A simple explanation of how to use it. Then we have an example section and finally the config reference. |
vcluster.yaml in vCluster Preview Comments Somehow we're missing pages for It would be good for us to explain what anything under external means and what does platform. If you need help with that explanation, let me know. |
Platform Comments I'm fine with adding this in resources, but also think we need somewhere in the Virtual Cluster section which describes how externally deployed vclusters could connect to the platform. Unfortunately, I haven't gotten around to adding in content about externally deployed vs. platform deployed. But if we add a new page for "Connecting to the Platform" that might be a good starting point. |
…vcluster.yaml docs for OSS. TODO: Pull in latest vcluster with CreateRBAC changes to the ApiKey
Reorganizes pro vcluster.yaml docs to be more like the OSS docs.
This is difficult for reviews, so I'll merge as is and update it afterwards. |
…)" This reverts commit 7b94c6c.
Resolves DOC-192 and DOC-196
vCluster preview: https://deploy-preview-194--vcluster-docs-site.netlify.app/docs/vcluster/configure/vcluster-yaml/
vCluster Platform preview: https://deploy-preview-194--vcluster-docs-site.netlify.app/docs/platform/virtual-clusters/configure/vcluster-yaml/