docs: update ephemeral kubernetes plugin documentation #5195
Conversation
|
The check-docs CI step has failed, could you check that, please? |
Thanks, forgot to re-generate the table of contents, fixed now. |
|
|
||
| Each user is granted a maximum of **20 hours per month** of ephemeral cluster usage where each cluster has a maximum lifetime of **4 hours**. After this period, the cluster is automatically destroyed. | ||
|
|
||
| If you need to destroy the cluster before its maximum lifetime of 4 hours expires, you can do so by visiting your [web dashboard](https://app.garden.io) and selecting the option to destroy the ephemeral cluster from there. This allows you to release resources and terminate the cluster when it's no longer needed. |
There was a problem hiding this comment.
IMO, this fits better under the Ephemeral Kubernetes Guide page..
Listing limitations is fine at plugin level but the usage fits better on the guide page where we introduce the ephemeral kubernetes clusters.
There was a problem hiding this comment.
Do we need that guide?
Isn't it basically the same as walking through the plugin configuration?
There was a problem hiding this comment.
yeah we could get rid of this guide completely and ensure that all of this is included in plugin docs section.
The original idea was to give more highlight to ephemeral clusters and we decided to go with a guide for that purpose, and have detailed plugin configuration separately.
There was a problem hiding this comment.
Yeah I get that.
But honestly I think we should keep this all under plugins for now.
We to want to err on consistency here and "train" people to look for things related to specific plugins under those sections, as opposed to some generic "Guides" section which currently is just all over the place.
We may change that structure at some point but until then, let's go for consistency.
There was a problem hiding this comment.
I've removed the separate guide and added the one additional information from it about logging in to the web dashboard to the plugin section for ephemeral-kubernetes.
There was a problem hiding this comment.
...looks like there are some conflicts. I'll re-approve when resolved.
twelvemo
force-pushed
the
update-docs-ephemeral-k8s
branch
from
62e0ae2 to
1d9e73c
Compare
What this PR does / why we need it:
Updates the ephemeral-k8s plugin docs to reflect the step-by-step nature of the plugin guide section better.
Which issue(s) this PR fixes:
Fixes #
Special notes for your reviewer: