[WAIT TO MERGE] add custom install instructions docs #3622
Conversation
✅ Deploy Preview for replicated-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for replicated-docs-upgrade ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
alicenstar
force-pushed
the
update-custom-install-instructions-docs
branch
from
7a1c999 to
a612c33
Compare
alicenstar
force-pushed
the
update-custom-install-instructions-docs
branch
from
6b9f53c to
f73d4cd
Compare
alicenstar
changed the title
alicenstar
force-pushed
the
update-custom-install-instructions-docs
branch
from
bd0f810 to
bcb7200
Compare
There was a problem hiding this comment.
thanks @alicenstar !
Since this adds a lot of content, I ended up reformatting the page a bit to bump all the headings up by one level. so now, all the docs-related customization opens will have their own h2 heading. One benefit of this is that you can now see all the h3s under the channel-specific install instructions section from the mini toc on the page
also added a couple comments where I edited the instructions because they weren't matching what I saw in the vendor portal; would be good to get your 👍 for those changes
|
|
||
| 1. Scroll to the **Channel customizations** section. | ||
|
|
||
| 1. For the channel where you want to customize instructions, click **Enable**. |
There was a problem hiding this comment.
Note that I edited these instructions based on what I was seeing in the screenshots and in the vendor portal. Previously, these steps mentioned selecting the channel from a dropdown which doesn't seem to exist. Calling this out in case we want to keep the dropdown stuff
|
|
||
| 1. In the **Channel customizations** section, select the channel. | ||
|
|
||
| 1. For the target channel, click **Disable**. When channel customizations are disabled, the Enterprise Portal shows the default installation instructions for the channel. |
There was a problem hiding this comment.
also edited these steps based on what I was seeing in the vendor portal
|
|
||
| :::note | ||
| Your custom documentation is saved in the **Channel customizations** MDX template editor. You can enable the custom instructions again by clicking **Enable** for the channel. | ||
| ::: |
There was a problem hiding this comment.
^ added this note in case someone was worried about losing their custom docs if they disable them
|
|
||
| ### Supported MDX Components {#components} | ||
|
|
||
| The following components are available in MDX templates. For examples of each component, see [Example](#example) below. |
There was a problem hiding this comment.
added all these to tables instead of the lists
| - Dangerous HTML elements (script, iframe, embed) are not allowed | ||
| - Template size is limited to 1MB | ||
|
|
||
| ### Example |
There was a problem hiding this comment.
i put the example and then each of the previews into separate "details" buckets that can be opened and closed. since both the example and the screenshots are pretty long, this felt like a way to reduce scrolling between the example and the corresponding preview
We've recently added custom install instructions and so we wanted to document the components, how to use them, and their current limitations. This feature is under development.
Related shortcut: https://app.shortcut.com/replicated/story/128113/fully-customizable-install-instructions [128113]
Preview: https://deploy-preview-3622--replicated-docs.netlify.app/vendor/enterprise-portal-configure#customize-documentation