docs: add documentation for the Developer Portal host rules credentia…

…ls (#32542) Co-authored-by: Justin Clareburt <[email protected]> Co-authored-by: Rhys Arkins <[email protected]>
renovatebot · Nov 19, 2024 · c80a052 · c80a052
1 parent 741488f
commit c80a052
Show file tree

Hide file tree

Showing 6 changed files with 19 additions and 3 deletions.
diff --git a/docs/usage/assets/images/app-settings/add-host-rule.png b/docs/usage/assets/images/app-settings/add-host-rule.png
diff --git a/docs/usage/assets/images/app-settings/host-rules.png b/docs/usage/assets/images/app-settings/host-rules.png
diff --git a/docs/usage/getting-started/private-packages.md b/docs/usage/getting-started/private-packages.md
@@ -611,7 +611,7 @@ If you need to provide credentials to the Mend Renovate App, please do this:
    }
    ```
 
-For more details, see [Using Secrets with Mend Cloud Apps](../mend-hosted/app-secrets.md).
+For more details, see [Using Secrets with Mend Cloud Apps](../mend-hosted/credentials.md).
 
 ### Access to GitHub Actions Secrets
 

diff --git a/docs/usage/mend-hosted/.pages b/docs/usage/mend-hosted/.pages
@@ -1,5 +1,5 @@
 title: Mend-hosted Apps
 nav:
   - 'Configuration': 'hosted-apps-config.md'
-  - 'App Secrets': 'app-secrets.md'
+  - 'Credentials': 'credentials.md'
   - 'Migrating Secrets': 'migrating-secrets.md'
diff --git a/docs/usage/mend-hosted/app-secrets.md → docs/usage/mend-hosted/credentials.md b/docs/usage/mend-hosted/app-secrets.md → docs/usage/mend-hosted/credentials.md
@@ -31,6 +31,7 @@ To add a secret for the Mend cloud app:
    ![Credentials settings page](../assets/images/app-settings/app-credentials.png)
 
 4. Reference the secret from Renovate config files inside the repo.
+   Alternatively, you can use the Host Rules UI (see below).
 
    ```json
    {
@@ -43,6 +44,21 @@ To add a secret for the Mend cloud app:
    }
    ```
 
+### Adding a host rule through the UI
+
+You can centrally add/configure Host Rules through the Mend UI as an alternative to including them in Renovate presets.
+
+1. Open the _Credentials_ section of the settings page for the relevant Org or Repo.
+2. Select `ADD HOST RULE` to open the "Add a Host Rule" dialog box.
+
+   ![Add Host Rule](../assets/images/app-settings/add-host-rule.png)
+
+3. Fill out the details for your host rule.
+
+   As an example, if you are a Bitbucket or Azure DevOps user, and you want to specify a github.com token to fetch release notes and enable github-based datasources, you could create a host rule like this:
+
+   ![Host Rules dialog box](../assets/images/app-settings/host-rules.png)
+
 ## Organization secrets vs repository secrets
 
 ### Secret scope

diff --git a/docs/usage/mend-hosted/migrating-secrets.md b/docs/usage/mend-hosted/migrating-secrets.md
@@ -102,4 +102,4 @@ If you were expecting to import a secret originally encrypted by Renovate:
 
 ## Related links
 
-- [Using Secrets with Mend Cloud Apps](app-secrets.md)
+- [Using Secrets with Mend Cloud Apps](credentials.md)
-Original file line number
+Diff line change
@@ Expand Up @@
        }
        ```
-    For more details, see [Using Secrets with Mend Cloud Apps](../mend-hosted/app-secrets.md).
+    For more details, see [Using Secrets with Mend Cloud Apps](../mend-hosted/credentials.md).
     ### Access to GitHub Actions Secrets
@@ Expand Down @@
Original file line number	Diff line number	Diff line change
Expand Up		@@ -102,4 +102,4 @@ If you were expecting to import a secret originally encrypted by Renovate:

		## Related links

		- [Using Secrets with Mend Cloud Apps](app-secrets.md)
		- [Using Secrets with Mend Cloud Apps](credentials.md)