Onboarding docs #2678
Onboarding docs #2678
Conversation
replicated-ci
added
type::docs
✅ Deploy Preview for replicated-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview for replicated-docs-upgrade ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
docs/intro.md
Outdated
| </li> | ||
| <li> | ||
| <a href="/vendor/distributing-overview">About Distributing Applications with Replicated</a> | ||
| <a href="/vendor/quick-start">Replicated Quick Start</a> |
There was a problem hiding this comment.
Updated links on the landing page to add links to the new quick start and onboarding.
Also updated the Embedded Kubernetes tile to be Embedded Cluster (Beta) instead and include EC-specific links
There was a problem hiding this comment.
Deleted this topic as we no longer need a separate KOTS Onboarding page. Added a redirect for this topic in our netlify.toml
There was a problem hiding this comment.
This is the new Quick Start which walks users through installing a release with EC then creating a new release and upgrading. It uses steps from the existing tutorials on EC and preflights
There was a problem hiding this comment.
This is the new onboarding topic that provides the main tasks users need to complete to onboard to the platform. The goal is to list out everything and provide links for more detailed information, rather than provide a "copy/paste" experience which is possible in something like a quick start/tutorial
The content is totally different from what was here before, so probably best to ignore the track changes
|
|
||
| 1. Install the release in a cluster with the Helm CLI to test your changes. For more information, see [Installing with Helm](/vendor/install-with-helm). | ||
|
|
||
| ### Add Support for Air Gap Installations |
There was a problem hiding this comment.
I think the HelmChart steps we brought people through above would have touched on the builder field. Since we aren't expecting air gap integration until now, do we need to tell people to skip those steps earlier?
There was a problem hiding this comment.
Yeah I see what you're saying...I feel like I lean towards introducing as few caveats as possible to that Configuring HelmChart step since that topic is already a lot to follow...so that would mean if they already did the builder key above, then they can be pleasantly surprised down here that they are already part of the way done
|
|
||
| To add support for air gap installations: | ||
|
|
||
| 1. If there are any images for your application that are not listed in your Helm chart, list these images in the `additionalImages` attribute of the KOTS Application custom resource. This ensures that the images are included in the `.airgap` bundle for the release. See [Define Additional Images](/vendor/operator-defining-additional-images). |
There was a problem hiding this comment.
Might be fine as is, but could be worth mentioning (either here or on the linked page) why some images might not be included in your templates. I would guess an operator is one use case.
There was a problem hiding this comment.
Yeah that would be helpful--I can include the Operator example and if you think of any others lmk
|
|
||
| ### Add and Query Custom License Entitlements | ||
|
|
||
| You can add custom license entitlements for your application in the Vendor Portal. Custom license fields are useful when there is entitlement information that applies to a subset of customers. For example, you can create a custom license field to limit the number of active users permitted. Or, you can create a field that limits the number of nodes a customer is permitted on their cluster. |
There was a problem hiding this comment.
I mentioned above that license fields may be used in HelmChart values too (like if someone is on the premium plan, and some extra service gets deployed as part of that)
Co-authored-by: Alex Parker <7272359+ajp-io@users.noreply.github.com>
Co-authored-by: Alex Parker <7272359+ajp-io@users.noreply.github.com>
|
|
||
| To add support for air gap installations: | ||
|
|
||
| 1. If there are any images for your application that are not listed in your Helm chart, list these images in the `additionalImages` attribute of the KOTS Application custom resource. This ensures that the images are included in the air gap bundle for the release. One common use case for this is applications that use Kubernetes Operators, which might have images listed in objects created by the Operator and not in the Helm chart. See [Define Additional Images](/vendor/operator-defining-additional-images). |
There was a problem hiding this comment.
which might have images listed in objects created by the Operator and not in the Helm chart.
not sure if this is the best phrasing
paigecalvert
changed the title
paigecalvert
changed the title
New quick start: https://deploy-preview-2678--replicated-docs.netlify.app/vendor/quick-start
New onboarding flow: https://deploy-preview-2678--replicated-docs.netlify.app/vendor/replicated-onboarding
(The rest is partials, images, and editing links in other topics)