From 0a27df794c7736c61ef4424e8e79780a6ff83aac Mon Sep 17 00:00:00 2001 From: StevenMcElligott <89483932+StevenMcElligott@users.noreply.github.com> Date: Tue, 26 Dec 2023 07:20:36 -0500 Subject: [PATCH] docs(Homepage): Redo Integration section (#16550) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit **Description** ⚒️ Fixes # **⚙️ Type of change** - [ ] ⚙️ Feature/App addition - [ ] 🪛 Bugfix - [ ] ⚠️ Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] 🔃 Refactor of current code **🧪 How Has This Been Tested?** **📃 Notes:** **✔️ Checklist:** - [ ] ⚖️ My code follows the style guidelines of this project - [ ] 👀 I have performed a self-review of my own code - [ ] #️⃣ I have commented my code, particularly in hard-to-understand areas - [ ] 📄 I have made corresponding changes to the documentation - [ ] ⚠️ My changes generate no new warnings - [ ] 🧪 I have added tests to this description that prove my fix is effective or that my feature works - [ ] ⬆️ I increased versions for any altered app according to semantic versioning **➕ App addition** If this PR is an app addition please make sure you have done the following. - [ ] 🪞 I have opened a PR on [truecharts/containers](https://github.com/truecharts/containers) adding the container to TrueCharts mirror repo. - [ ] 🖼️ I have added an icon in the Chart's root directory called `icon.png` --- _Please don't blindly check all the boxes. Read them and only check those that apply. Those checkboxes are there for the reviewer to see what is this all about and the status of this PR with a quick glance._ --- charts/stable/homepage/docs/hp-integration.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/charts/stable/homepage/docs/hp-integration.md b/charts/stable/homepage/docs/hp-integration.md index 4b81357dd68..fada81ce34a 100644 --- a/charts/stable/homepage/docs/hp-integration.md +++ b/charts/stable/homepage/docs/hp-integration.md @@ -63,12 +63,13 @@ And you will be able to have outputs similar to this to see memory and CPU: To edit an existing chart with ingress, go to the ingress section and enable the Homepage integration checkbox. -:white_check_mark: Name can be left blank or use the name of your choice. -:white_check_mark: Description can be left blank or you can use the description of your choice. -:exclamation: Group is important and required. It will allow you to group different apps together. For example, all your media apps may be in a group called "Media". You can also use the group names you may have already defined in services.yaml, and it will add the discovered app to that group. -:exclamation: API Key is where you will enter an API key for your application if needed. If this is a new install and you do not have an API key yet, you can come back and add this later. -:white_check_mark: Adding custom options will allow you to add fields to the widget, or define username/password when there is no API key to apply. You can see the various fields available in the widgets section of the Homepage documentation at their site above. -:white_check_mark: Enable Widget. If the app does not have a widget option set, leave this unchecked. +- **Name** can be left blank or use the name of your choice. +- **Description** can be left blank or you can use the description of your choice. +- **Icon** can be left blank or link to the icon of your choice. +- **Group** This is important and required. It will allow you to group different apps together. For example, all your media apps may be in a group called "Media". You can also use the group names you may have already defined in services.yaml, and it will add the discovered app to that group. +- **Enable Widget**: If the app does not have a widget option set, leave this unchecked. +- **API Key**: This is where you will enter an API key for your application if needed. If this is a new install and you do not have an API key yet, you can come back and add this later. +- **Custom-Options** Adding custom options will allow you to add fields to the widget, or define username/password when there is no API key to apply. You can see the various fields available in the widgets section of the Homepage documentation at their site above. ![integration options](img/intop.png)