From 5bdf2e469257fc78ff52d6578beddab86a8a7232 Mon Sep 17 00:00:00 2001 From: Alicia Sykes Date: Sun, 22 Aug 2021 19:18:44 +0100 Subject: [PATCH 1/3] :star2: Adds screenshots to showcase --- docs/showcase.md | 2 +- docs/showcase/readme.md | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) create mode 100644 docs/showcase/readme.md diff --git a/docs/showcase.md b/docs/showcase.md index 4c899078..34ba17a9 100644 --- a/docs/showcase.md +++ b/docs/showcase.md @@ -70,7 +70,7 @@ ## Submitting your Dashboard #### How to Submit -- [Open an Issue](https://git.io/Jceik) +- [Open an Issue](https://git.io/JEtgM) - [Open a PR](https://github.com/Lissy93/dashy/compare) #### What to Include diff --git a/docs/showcase/readme.md b/docs/showcase/readme.md new file mode 100644 index 00000000..eb4bf98b --- /dev/null +++ b/docs/showcase/readme.md @@ -0,0 +1,2 @@ + +See: [Showcase](/docs/showcase.md). \ No newline at end of file From 31da34386a56f00260eb1f34ab5ef3c47e7daa9b Mon Sep 17 00:00:00 2001 From: Alicia Sykes Date: Sun, 22 Aug 2021 19:19:30 +0100 Subject: [PATCH 2/3] :adhesive_bandage: Fixes broken links in docs --- README.md | 8 ++++---- docs/contributing.md | 2 +- docs/troubleshooting.md | 11 ++++++----- 3 files changed, 11 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index c2291eac..01f2bdbf 100644 --- a/README.md +++ b/README.md @@ -69,8 +69,8 @@ - 📏 Customizable layout, sizes, text, component visibility, behavior and colors etc - 🖼️ Option for full-screen background image, custom nav-bar links, html footer, title, and more - 🚀 Easy to setup with Docker, or on bare metal, or with 1-Click cloud deployment -- 🤏 Small bundle size, fully responsive UI and PWA makes the app easy to use on any device - ⚙️ Easy single-file YAML-based configuration, with option to configure app directly through the UI +- 🤏 Small bundle size, fully responsive UI and PWA makes the app easy to use on any device - ✨ Under active development with improvements and new features added regularly - 🆓 100% free and open source - 🔐 Strong focus on privacy @@ -446,9 +446,9 @@ If you're having trouble getting things up and running, feel free to ask a quest Found a bug, or something that isn't working as you'd expect? Please raise it as an issue so that it can be resolved. Feature requests are also welcome. Similarlty, feedback is very useful, as it helps me know what areas of Dashy need some improvement. -- [Raise a Bug 🐛](https://github.com/Lissy93/dashy/issues/new?assignees=Lissy93&labels=%F0%9F%90%9B+Bug&template=bug-report---.md&title=%5BBUG%5D) -- [Submit a Feature Request 🦄](https://github.com/Lissy93/dashy/issues/new?assignees=Lissy93&labels=%F0%9F%A6%84+Feature+Request&template=feature-request---.md&title=%5BFEATURE_REQUEST%5D) -- [Share Feedback 🌈](https://github.com/Lissy93/dashy/issues/new?assignees=&labels=%F0%9F%8C%88+Feedback&template=share-feedback---.md&title=%5BFEEDBACK%5D) +- [Raise a Bug 🐛](https://github.com/Lissy93/dashy/issues/new?assignees=lissy93&labels=%F0%9F%90%9B+Bug&template=bug.yml&title=%5BBUG%5D+%3Ctitle%3E) +- [Submit a Feature Request 🦄](https://github.com/Lissy93/dashy/issues/new?template=feature-request.yml) +- [Share Feedback 🌈](https://github.com/Lissy93/dashy/issues/new?assignees=&labels=%F0%9F%8C%88+Feedback&template=share-feedback.md&title=%5BFEEDBACK%5D) **Issue Status** [![Resolution Time](http://isitmaintained.com/badge/resolution/lissy93/dashy.svg) ![Open Issues](http://isitmaintained.com/badge/open/lissy93/dashy.svg) ![Closed Issues](https://badgen.net/github/closed-issues/lissy93/dashy)](https://isitmaintained.com/project/lissy93/dashy) [![GitHub Discussions](https://img.shields.io/github/discussions/lissy93/dashy) ](https://github.com/Lissy93/dashy/discussions) diff --git a/docs/contributing.md b/docs/contributing.md index e24b3d2d..2b3f00c1 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -25,7 +25,7 @@ All content is located either in the [`./README.md`](/README.md) or [`/docs/`](/ ## Raise a bug If you've found a bug, then please do raise it as an issue. This will help me know if there's something that needs fixing. Try and include as much detail as possible, such as your environment, steps to reproduce, any console output and maybe an example screenshot or recording if necessary. -[![Raise a Bug](https://img.shields.io/badge/Raise_a-Bug-%23dc2d76?style=for-the-badge&logo=dependabot)](https://github.com/Lissy93/dashy/issues/new?assignees=Lissy93&labels=%F0%9F%90%9B+Bug&template=bug-report---.md&title=%5BBUG%5D) +[![Raise a Bug](https://img.shields.io/badge/Raise_a-Bug-%23dc2d76?style=for-the-badge&logo=dependabot)](https://github.com/Lissy93/dashy/issues/new?assignees=lissy93&labels=%F0%9F%90%9B+Bug&template=bug.yml&title=%5BBUG%5D+%3Ctitle%3E) ## Join the discussion I've enabled the discussion feature on GitHub, here you can share tips and tricks, useful information, or your dashboard. You can also ask questions, and offer basic support to other users. diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index 9d13832d..8ba2912d 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -57,6 +57,8 @@ Alternatively, as a workaround, you have several options: In V 1.6.5 an update was made that in the future will become a breaking change. You will need to update you config to reflect this before V 2.0.0 is released. In the meantime, your previous config will continue to function normally, but you will see a validation warning. The change means that the structure of the `appConfig.auth` object is now an object, which has a `users` property. +For more info, see [this announcement](https://github.com/Lissy93/dashy/discussions/177). + You can fix this by replacing: ```yaml @@ -68,11 +70,10 @@ auth: with ```yaml -appConfig: - auth: - users: - - user: xxx - hash: xxx +auth: + users: + - user: xxx + hash: xxx ``` --- From be7369f2060f2b7884d7c017792942d3e026dc3a Mon Sep 17 00:00:00 2001 From: Alicia Sykes Date: Sun, 22 Aug 2021 19:20:05 +0100 Subject: [PATCH 3/3] :lipstick: Minor style improvments --- src/components/Configuration/CustomCss.vue | 4 ++ src/components/Workspace/SideBar.vue | 2 +- src/styles/color-themes.scss | 45 ++++++++++++++++++++++ 3 files changed, 50 insertions(+), 1 deletion(-) diff --git a/src/components/Configuration/CustomCss.vue b/src/components/Configuration/CustomCss.vue index 8ffa02c9..c9f6fe5e 100644 --- a/src/components/Configuration/CustomCss.vue +++ b/src/components/Configuration/CustomCss.vue @@ -75,6 +75,10 @@ div.css-editor-outer { display: flex; flex-direction: column; + div.css-wrapper { + display: flex; + flex-direction: column; + } h2.css-input-title { margin: 0.5rem 0 0.2rem; } diff --git a/src/components/Workspace/SideBar.vue b/src/components/Workspace/SideBar.vue index c85c6f9c..eb4e0779 100644 --- a/src/components/Workspace/SideBar.vue +++ b/src/components/Workspace/SideBar.vue @@ -1,6 +1,6 @@