docs: add documentation for the Developer Portal host rules credentials #32542
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…dd a Host Rule using the UI
Co-authored-by: Rhys Arkins <[email protected]>
|
|
HonkingGoose
suggested changes
Nov 14, 2024
| @@ -43,6 +44,21 @@ To add a secret for the Mend cloud app: | |||
| } | |||
| ``` | |||
|
|
|||
| ### Adding a host rule through the UI | |||
There was a problem hiding this comment.
Screenshots are good, but keep the text too
The screenshots are nice! But we should keep the plain text instructions!
Keeping the text helps users who can't see the image, or can't read the text in the image.
Hide the text within a collapsible admonition
You can "clean up" the page, by putting the text in a collapsible admonition. 1 The format is:
??? note "Select me to read how to ..."
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
massa, nec semper lorem quam in massa.
How it works
- The
???bit makes it so the admonition only shows the text after the user selects the admonition - I'm also adding a good title to the admonition, 2 so users know what to do
"Select me to read how to ..."title
Footnotes
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
Update docs in the Mend-hosted Apps section to show how to use the Host Rules UI in Developer Portal credentials settings.
Context
Developer Portal for Mend-hosted apps now provides the ability for users to specify host rules.
This PR includes updates to the documentation to describe the new feature.
Documentation (please check one with an [x])
How I've tested my work (please select one)
I have verified these changes via: