🔀 Merge pull request #775 from Lissy93/REFACTOR/widget-and-docs-impro…

…vments

[REFACTOR] Fix themes and widget improvements

.github/CHANGELOG.md

@@ -1,5 +1,27 @@
 # Changelog
 
+## ✨ 2.1.1 Improvements [PR #775](https://github.com/Lissy93/dashy/pull/775)
+- Stop status checks when item destroyed
+ - #767 by @marekful
+- Add Elizabeth + non-underground lines to TFL widget
+ - #766 by @dougaldhub
+- Ensure first SSL certificate check finished before second
+ - #760 by @marekful
+- Huge improvment to the way widgets are defined
+ - #758 by @patrickheeney
+- Update APOD widget to use https://apod.as93.net
+ - #745 by @k073l 
+- Small docs update
+ - #741 by @markusdd 
+- A set of awesome NextCloud widgets
+ - #740 by @marekful
+- Option to show / hide detailed info for StatPing widget
+ - #714 by @marekful
+- Korean translations
+ - #711 by @boggy-cs
+- Small docs update
+ - #705 by @pablomalo
+
 ## ✨ 2.0.9 Adds Multi-Page Support [PR #685](https://github.com/Lissy93/dashy/pull/685)
 - Adds Widgets for AdGuard
 

.github/LATEST_CHANGELOG.md

@@ -1,2 +1,45 @@
-## ✨ 2.0.9 Adds Multi-Page Support [PR #685](https://github.com/Lissy93/dashy/pull/685)
-- Adds Widgets for AdGuard
+## ✨ 2.1.1 Improvements [PR #775](https://github.com/Lissy93/dashy/pull/775)
+
+#### Bug Fixes 🐛
+
+- Update APOD widget to use https://apod.as93.net
+ - #745 by @k073l 
+- Fixes theme applying bug (#774)
+
+#### Improvements ⚡️
+
+- Stop status checks when item destroyed
+ - #767 by @marekful
+- Ensure first SSL certificate check finished before second
+ - #760 by @marekful
+- Huge improvement to the way widgets are defined
+ - #758 by @patrickheeney
+
+#### Features ✨
+
+- A set of awesome NextCloud widgets
+ - #740 by @marekful
+- Add Elizabeth + non-underground lines to TFL widget
+ - #766 by @dougaldhub
+- Option to show / hide detailed info for StatPing widget
+ - #714 by @marekful
+- Korean translations
+ - #711 by @boggy-cs
+- Adds option to force ignore widget errors
+
+#### Docs 📕
+
+- Small docs update
+ - #741 by @markusdd 
+- Small docs update
+ - #705 by @pablomalo
+- Adds Dipanghosh's dash to showcase
+
+---
+
+
+Big thanks to the above developers, for their awesome work on this release! 
+
+V 2.1.2 is in the works, and includes an overhaul of how the config is loaded, so stay tuned for that!
+
+And Happy Friday!

docs/showcase.md

@@ -9,6 +9,17 @@
 
 ---
 
+### Dipan's Dash
+
+> By [@Dipanghosh](https://github.com/dipanghosh) - [dipan.de](https://dipan.de/) <sup>Re: [#777](https://github.com/Lissy93/dashy/discussions/777)</sup>
+
+> With the option of embedding iframes, it becomes possible to combine and conquer. I have set up Dashy to include graphs from grafana, and set them so that they update automatically. I also have uptime monitors from uptime Kuma, panels from homeasistant are also possible to be included.<br>
+> Dashy is awesome!
+
+![screenshot-dipanghosh-dashboard](https://i.ibb.co/bPC6w2n/dipanghosh-dashboard.png)
+
+---
+
 ### Ratty222
 > By [@ratty222](https://github.com/ratty222) <sup>Re: [#384](https://github.com/Lissy93/dashy/discussions/384)</sup>
 
@@ -38,11 +49,13 @@
 
 ---
 
-### The Private Dashboard
 
-> By [@DylanBeMe](https://github.com/DylanBeMe) <sup>Re: [#419](https://github.com/Lissy93/dashy/issues/419)</sup>
+### The Dragons Lair
+> By [dr460nf1r3](https://github.com/dr460nf1r3) <sup>via [#684](https://github.com/Lissy93/dashy/issues/684)</sup>
 
-![screenshot-private-dashboard](https://i.ibb.co/hKS483T/private-dashboard-Dylan-Be-Me.png)
+> My new startpage featuring the stuff I use most. And of course dragons! 
+
+![screenshot-dragons-lair](https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/13-dragons-lair.png)
 
 ---
 
@@ -78,6 +91,14 @@
 
 ---
 
+### The Private Dashboard
+
+> By [@DylanBeMe](https://github.com/DylanBeMe) <sup>Re: [#419](https://github.com/Lissy93/dashy/issues/419)</sup>
+
+![screenshot-private-dashboard](https://i.ibb.co/hKS483T/private-dashboard-Dylan-Be-Me.png)
+
+---
+
 ### Networking Services
 > By [@Lissy93](https://github.com/lissy93)
 
@@ -185,15 +206,6 @@
 
 ---
 
-### The Dragons Lair
-> By [dr460nf1r3](https://github.com/dr460nf1r3) <sup>via [#684](https://github.com/Lissy93/dashy/issues/684)</sup>
-
-> My new startpage featuring the stuff I use most. And of course dragons! 
-
-![screenshot-dragons-lair](https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/13-dragons-lair.png)
-
----
-
 ## Submitting your Dashboard
 
 #### How to Submit

docs/troubleshooting.md

@@ -3,7 +3,7 @@
 > _**This document contains common problems and their solutions.**_<br>
 > Please ensure your issue isn't listed here, before opening a new ticket.
 >
-> _If you come across an issue not listed below, consider adding it, to help other users._
+> _Found something not listed here? Consider adding it, to help other users._
 
 ### Contents
 - [Refused to Connect in Web Content View](#refused-to-connect-in-modal-or-workspace-view)
@@ -30,10 +30,12 @@
 - [Status Checks Failing](#status-checks-failing)
 - [Diagnosing Widget Errors](#widget-errors)
 - [Fixing Widget CORS Errors](#widget-cors-errors)
+- [Widget Shows Error Incorrectly](#widget-shows-error-incorrectly)
 - [Weather Forecast Widget 401](#weather-forecast-widget-401)
 - [Font Awesome Icons not Displaying](#font-awesome-icons-not-displaying)
 - [Copy to Clipboard not Working](#copy-to-clipboard-not-working)
 - [How to Reset Local Settings](#how-to-reset-local-settings)
+- [How to make a bug report](#how-to-make-a-bug-report)
 - [How-To Open Browser Console](#how-to-open-browser-console)
 - [Git Contributions not Displaying](#git-contributions-not-displaying)
 
@@ -421,6 +423,15 @@ For testing purposes, you can use an addon, which will disable the CORS checks.
 
 ---
 
+## Widget Shows Error Incorrectly
+
+When there's an error fetching or displaying a widgets data, then it will be highlighted in yellow, and a message displayed on the UI.
+
+In some instances, this is a false positive, and the widget is actually functioning correctly.
+If this is the case, you can disable the UI error message of a given widget by setting: `ignoreErrors: true`
+
+---
+
 ## Weather Forecast Widget 401
 
 [Weather widget](/docs/widgets.md#weather-forecast) is working fine, but you are getting a `401` for the [Weather Forecast widget](/docs/widgets.md#weather-forecast), then this is most likely an OWM API key issue.
@@ -473,6 +484,47 @@ For a full list of all data that may be cached, see the [Privacy Docs](/docs/pri
 
 ---
 
+## How to make a bug report
+
+#### Step 1 - Where to open issues
+
+You will need a GitHub account in order to raise a ticket. You can then [click here](https://github.com/Lissy93/dashy/issues/new?assignees=lissy93&labels=%F0%9F%90%9B+Bug&template=bug.yml&title=%5BBUG%5D+%3Ctitle%3E) to open a new bug report.
+
+#### Step 2 - Checking it's not already covered
+
+Before submitting, please check that:
+- A similar ticket has not previously been opened
+- The issue is not covered in the [troubleshooting guide](https://github.com/Lissy93/dashy/blob/master/docs/troubleshooting.md) or [docs](https://github.com/Lissy93/dashy/tree/master/docs#readme)
+
+#### Step 3 - Describe the Issue
+
+Your ticket will likely be dealt with more effectively if you can explain the issue clearly, and provide all relevant supporting material.
+
+Complete the fields, asking for your environment info and version of Dashy.
+Then describe the issue, briefly explaining the steps to reproduce, expected outcome and actual outcome.
+
+#### Step 4 - Provide Supporting Info
+
+Where relevant please also include:
+
+- A screenshot of the issue
+- The relevant parts of your config file
+- Logs
+ - If client-side issue, then include the browser logs ([see how](#how-to-open-browser-console))
+ - If server-side / during deployment, include the terminal output
+
+_Take care to redact any personal info, (like IP addresses, auth hashes or API keys)_
+
+#### Step 5 - Fix Released
+
+A maintainer will aim to respond within 48 hours.
+The timeframe for resolving your issue, will vary depending on severity of the bug and the complexity of the fix.
+You will be notified on your ticket, when a fix has been released.
+
+Finally, be sure to remain respectful to other users and project maintainers, in line with the [Contributor Covenant Code of Conduct](https://github.com/Lissy93/dashy/blob/master/.github/CODE_OF_CONDUCT.md#contributor-covenant-code-of-conduct).
+
+---
+
 ## How-To Open Browser Console
 When raising a bug, one crucial piece of info needed is the browser's console output. This will help the developer diagnose and fix the issue.
 

docs/widgets.md

@@ -80,6 +80,7 @@ Dashy has support for displaying dynamic content in the form of widgets. There a
  - [Continuous Updates](#continuous-updates)
  - [Proxying Requests](#proxying-requests)
  - [Setting Timeout](#setting-timeout)
+ - [Ignoring Errors](#ignoring-errors)
  - [Custom CSS Styling](#widget-styling)
  - [Customizing Charts](#customizing-charts)
  - [Language Translations](#language-translations)
@@ -2264,6 +2265,21 @@ For example:
 
 ---
 
+### Ignoring Errors
+
+When there's an error fetching or displaying a widgets data, then it will be highlighted in yellow, and a message displayed on the UI.
+
+In some instances, this is a false positive, and the widget is actually functioning correctly. If this is the case, you can disable the UI error message of a given widget by setting: `ignoreErrors: true`
+
+```yaml
+- type: gl-disk-io
+ ignoreErrors: true
+ options:
+ hostname: https://glances.dns-device.local
+```
+
+---
+
 ### Widget Styling
 
 Like elsewhere in Dashy, all colours can be easily modified with CSS variables. 

package.json

@@ -1,6 +1,6 @@
 {
  "name": "Dashy",
- "version": "2.1.0",
+ "version": "2.1.1",
  "license": "MIT",
  "main": "server",
  "author": "Alicia Sykes <[email protected]> (https://aliciasykes.com)",