mirror of
https://github.com/Lissy93/dashy.git
synced 2024-12-26 02:14:27 +03:00
39 lines
32 KiB
HTML
39 lines
32 KiB
HTML
<!doctype html>
|
|
<html lang="en" dir="ltr">
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
|
<meta name="generator" content="Docusaurus v2.0.0-beta.2">
|
|
<title data-react-helmet="true">Contributing | Dashy</title><meta data-react-helmet="true" property="og:url" content="https://dashy.to/docs/contributing"><meta data-react-helmet="true" name="docusaurus_locale" content="en"><meta data-react-helmet="true" name="docusaurus_version" content="current"><meta data-react-helmet="true" name="docusaurus_tag" content="docs-default-current"><meta data-react-helmet="true" property="og:title" content="Contributing | Dashy"><meta data-react-helmet="true" name="description" content="First off, thank you for considering contributing towards Dashy! 🙌"><meta data-react-helmet="true" property="og:description" content="First off, thank you for considering contributing towards Dashy! 🙌"><link data-react-helmet="true" rel="shortcut icon" href="/img/favicon.ico"><link data-react-helmet="true" rel="canonical" href="https://dashy.to/docs/contributing"><link data-react-helmet="true" rel="alternate" href="https://dashy.to/docs/contributing" hreflang="en"><link data-react-helmet="true" rel="alternate" href="https://dashy.to/docs/contributing" hreflang="x-default"><link rel="stylesheet" href="/assets/css/styles.becbbfc3.css">
|
|
<link rel="preload" href="/assets/js/runtime~main.02cab8fc.js" as="script">
|
|
<link rel="preload" href="/assets/js/main.dc7bf884.js" as="script">
|
|
</head>
|
|
<body>
|
|
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}()</script><div id="__docusaurus">
|
|
<div><a href="#main" class="skipToContent_1oUP">Skip to main content</a></div><nav class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><a class="navbar__brand" href="/"><img src="/img/dashy.png" alt="Dashy Logo" class="themedImage_1VuW themedImage--light_3UqQ navbar__logo"><img src="/img/dashy.png" alt="Dashy Logo" class="themedImage_1VuW themedImage--dark_hz6m navbar__logo"><b class="navbar__title">Dashy</b></a></div><div class="navbar__items navbar__items--right"><div class="react-toggle displayOnlyInLargeViewport_GrZ2 react-toggle--disabled"><div class="react-toggle-track" role="button" tabindex="-1"><div class="react-toggle-track-check"><span class="toggle_71bT">🌜</span></div><div class="react-toggle-track-x"><span class="toggle_71bT">🌞</span></div><div class="react-toggle-thumb"></div></div><input type="checkbox" class="react-toggle-screenreader-only" aria-label="Switch between dark and light mode"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div><div class="navbar-sidebar"><div class="navbar-sidebar__brand"><a class="navbar__brand" href="/"><img src="/img/dashy.png" alt="Dashy Logo" class="themedImage_1VuW themedImage--light_3UqQ navbar__logo"><img src="/img/dashy.png" alt="Dashy Logo" class="themedImage_1VuW themedImage--dark_hz6m navbar__logo"><b class="navbar__title">Dashy</b></a></div><div class="navbar-sidebar__items"><div class="menu"><ul class="menu__list"></ul></div></div></div></nav><div class="main-wrapper docs-wrapper doc-page"><div class="docPage_31aa"><aside class="docSidebarContainer_3Kbt"><div class="sidebar_15mo"><nav class="menu menu--responsive thin-scrollbar menu_Bmed menuWithAnnouncementBar_2WvA" aria-label="Sidebar navigation"><button aria-label="Open menu" aria-haspopup="true" class="button button--secondary button--sm menu__button" type="button"><svg class="sidebarMenuIcon_fgN0" width="24" height="24" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><ul class="menu__list"><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!">Running Dashy</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/quick-start">Quick Start</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/deployment">Deployment</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/configuring">Configuring</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/management">Management</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/troubleshooting">Troubleshooting</a></li></ul></li><li class="menu__list-item"><a class="menu__link menu__link--sublist menu__link--active" href="#!">Community</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/showcase">User Showcase</a></li><li class="menu__list-item"><a aria-current="page" class="menu__link menu__link--active active" tabindex="0" href="/docs/contributing">Contributing</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/developing">Developing</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/development-guides">Development Guides</a></li></ul></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!">Feature Docs</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/icons">Icons</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/theming">Theming</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/status-indicators">Status Indicators</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/authentication">Authentication</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/searching">Keyboard Shortcuts</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/alternate-views">Alternate Views & Opening Methods</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/multi-language-support">Internationalization</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/backup-restore">Cloud Backup and Restore</a></li></ul></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!">Misc</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/privacy">Privacy & Security</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/changelog">Changelog</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/license">license</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/code-of-conduct">Contributor Covenant Code of Conduct</a></li></ul></li></ul></nav></div></aside><main class="docMainContainer_3ufF"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_3FnS"><div class="docItemContainer_33ec"><article><div class="markdown"><header><h1 class="h1Heading_27L5">Contributing</h1></header><p>First off, thank you for considering contributing towards Dashy! 🙌
|
|
There are several ways that you can help out (but don't feel you have to).
|
|
Any contributions, however small will always be very much appreciated, and you will be appropriately credited in the readme - huge thank you to <a href="/docs/credits">everyone who has helped</a> so far 💞</p><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_2LWZ" id="submit-a-pr"></a>Submit a PR<a class="hash-link" href="#submit-a-pr" title="Direct link to heading">#</a></h2><p>Contributing to the code or documentation is super helpful. You can fix a bug, add a new feature or improve an existing one. I've written <a href="https://github.com/Lissy93/dashy/blob/master/docs/development-guides" target="_blank" rel="noopener noreferrer">several guides</a> to help you get started. For setting up the development environment, outline of the standards, and understanding the PR flow, see the <a href="https://github.com/Lissy93/dashy/blob/master/docs/development" target="_blank" rel="noopener noreferrer">Development Docs</a>. I've tried to keep the code neat and documentation thorough, so understanding what everything does should be fairly straight forward, but feel free to ask if you have any questions.</p><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_2LWZ" id="add-translations"></a>Add Translations<a class="hash-link" href="#add-translations" title="Direct link to heading">#</a></h2><p>If you speak another language, then adding translations would be really helpful, and you will be credited in the readme for your work. Multi-language support makes Dashy accessible for non-English speakers, which I feel is important. This is a very quick and easy task, as all application text is located in <a href="https://github.com/Lissy93/dashy/blob/master/src/assets/locales/en.json" target="_blank" rel="noopener noreferrer"><code>locales/en.json</code></a>, so adding a new language is as simple as copying this file and translating the values. You don't have to translate it all, as any missing attributes will just fallback to English. For a full tutorial, see the <a href="https://github.com/Lissy93/dashy/blob/master/docs/multi-language-support" target="_blank" rel="noopener noreferrer">Multi-Language Support Docs</a>.</p><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_2LWZ" id="take-a-2-minute-survey"></a>Take a 2-minute survey<a class="hash-link" href="#take-a-2-minute-survey" title="Direct link to heading">#</a></h2><p>Help improve Dashy by taking a very short, 6-question survey. This will give me a better understanding of what is important to you, so that I can make Dashy better in the future :)</p><p><a href="https://n9fy6xak9yd.typeform.com/to/gl0L68ou" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/Take_the-Survey-%231a86fd?style=for-the-badge&logo=buddy" alt="Take the Survey"></a></p><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_2LWZ" id="share-your-dashboard"></a>Share your dashboard<a class="hash-link" href="#share-your-dashboard" title="Direct link to heading">#</a></h2><p>Dashy now has a <a href="https://github.com/Lissy93/dashy/blob/master/docs/showcase#dashy-showcase-" target="_blank" rel="noopener noreferrer">Showcase</a> where you can show off a screenshot of your dashboard, and get inspiration from other users. I also really enjoy seeing how people are using Dashy. To <a href="https://github.com/Lissy93/dashy/blob/master/docs/showcase#submitting-your-dashboard" target="_blank" rel="noopener noreferrer">submit your dashboard</a>, please either open a PR or raise an issue.</p><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_2LWZ" id="improve-the-docs"></a>Improve the Docs<a class="hash-link" href="#improve-the-docs" title="Direct link to heading">#</a></h2><p>Found a typo, or something that isn't as clear as it could be? Maybe I've missed something off altogether, or you hit a roadblock that took you a while to figure out. Submitting a pull request to add to or improve the documentation will help future users get Dashy up and running more easily.
|
|
All content is located either in the README or <a href="/docs"><code>/docs/</code></a> directory, and synced to the Wiki and website using a GH action (workflows/wiki-sync.yml).</p><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_2LWZ" id="raise-a-bug"></a>Raise a bug<a class="hash-link" href="#raise-a-bug" title="Direct link to heading">#</a></h2><p>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.</p><p><a href="https://github.com/Lissy93/dashy/issues/new?assignees=lissy93&labels=%F0%9F%90%9B+Bug&template=bug.yml&title=%5BBUG%5D+%3Ctitle%3E" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/Raise_a-Bug-%23dc2d76?style=for-the-badge&logo=dependabot" alt="Raise a Bug"></a></p><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_2LWZ" id="join-the-discussion"></a>Join the discussion<a class="hash-link" href="#join-the-discussion" title="Direct link to heading">#</a></h2><p>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.</p><p><a href="https://github.com/Lissy93/dashy/discussions" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/Join_the-Discussion-%23ffd000?style=for-the-badge&logo=livechat" alt="Join the Discussion on GitHub"></a></p><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_2LWZ" id="spread-the-word"></a>Spread the word<a class="hash-link" href="#spread-the-word" title="Direct link to heading">#</a></h2><p>Dashy is still a relatively young project, and as such not many people know of it. It would be great to see more users, and so it would be awesome if you could consider sharing on social platforms.</p><p><a href="https://mastodon.social/?text=Check%20out%20Dashy%2C%20the%20privacy-friendly%2C%20self-hosted%20startpage%20for%20organizing%20your%20life%3A%20https%3A%2F%2Fgithub.com%2FLissy93%2Fdashy%20-%20By%20%40lissy93%40mastodon.social" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/Share-Mastodon-%232b90d9?style=for-the-badge&logo=mastodon" alt="Share Dashy on Mastodon"></a>
|
|
<a href="http://www.reddit.com/submit?url=https://github.com/Lissy93/dashy&title=Dashy%20-%20The%20self-hosted%20dashboard%20for%20your%20homelab%20%F0%9F%9A%80" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/Share-Reddit-%23FF5700?style=for-the-badge&logo=reddit" alt="Share Dashy on Reddit"></a>
|
|
<a href="https://twitter.com/intent/tweet?url=https://github.com/lissy93/dashy&text=Check%20out%20Dashy%20by%20@Lissy_Sykes,%20the%20self-hosted%20dashboard%20for%20your%20homelab%20%F0%9F%9A%80" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/Share-Twitter-%231DA1F2?style=for-the-badge&logo=twitter" alt="Share Dashy on Twitter"></a>
|
|
<a href="https://www.facebook.com/sharer/sharer.php?u=https://github.com/lissy93/dashy" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/Share-Facebook-%234267B2?style=for-the-badge&logo=facebook" alt="Share Dashy on Facebook"></a>
|
|
<a href="https://www.linkedin.com/shareArticle?mini=true&url=https://github.com/lissy93/dashy" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/Share-LinkedIn-%230077b5?style=for-the-badge&logo=linkedin" alt="Share Dashy on LinkedIn"></a>
|
|
<a href="https://pinterest.com/pin/create/button/?url=https://github.com/lissy93/dashy&media=https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/1-home-lab-material.png&description=Check%20out%20Dashy,%20the%20self-hosted%20dashboard%20for%20your%20homelab%20%F0%9F%9A%80" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/Share-Pinterest-%23E60023?style=for-the-badge&logo=pinterest" alt="Share Dashy on Pinterest"></a>
|
|
<a href="https://vk.com/share.php?url=https%3A%2F%2Fgithub.com%2Flissy93%2Fdashy%2F&title=Check%20out%20Dashy%20-%20The%20Self-Hosted%20Dashboard%20for%20your%20Homelab%20%F0%9F%9A%80" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/Share-VK-%234C75A3?style=for-the-badge&logo=vk" alt="Share Dashy on VK"></a>
|
|
<a href="viber://forward?text=https%3A%2F%2Fgithub.com%2Flissy93%2Fdashy%0ACheck%20out%20Dashy%2C%20the%20self-hosted%20dashboard%20for%20your%20homelab%20%F0%9F%9A%80" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/Share-Viber-%238176d6?style=for-the-badge&logo=viber" alt="Share Dashy via Viber"></a>
|
|
<a href="https://t.me/share/url?url=https%3A%2F%2Fgithub.com%2Flissy93%2Fdashy&text=Check%20out%20Dashy%2C%20the%20self-hosted%20dashboard%20for%20your%20homelab%20%F0%9F%9A%80" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/Share-Telegram-%230088cc?style=for-the-badge&logo=telegram" alt="Share Dashy via Telegram"></a>
|
|
<a href="mailto:info@example.com?&subject=Check%20out%20Dashy%20-%20The%20self-hosted%20dashboard%20for%20your%20homelab%20%F0%9F%9A%80&cc=&bcc=&body=https://github.com/lissy93/dashy" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/Share-Email-%238A90C7?style=for-the-badge&logo=protonmail" alt="Share Dashy via Email"></a></p><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_2LWZ" id="star-upvote-or-leave-a-review"></a>Star, Upvote or Leave a Review<a class="hash-link" href="#star-upvote-or-leave-a-review" title="Direct link to heading">#</a></h2><p>Dashy is on the following platforms, and if you could spare a few seconds to give it an upvote or review, this will also help new users find it.</p><p><a href="https://www.producthunt.com/posts/dashy" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/Review-ProductHunt-%23b74424?style=for-the-badge&logo=producthunt" alt="ProductHunt"></a>
|
|
<a href="https://alternativeto.net/software/dashy/about/" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/Review-AlternativeTo-%235581a6?style=for-the-badge&logo=abletonlive" alt="AlternativeTo"></a>
|
|
<a href="https://www.slant.co/improve/topics/27783/viewpoints/1/~self-hosted-homelab-startpage~dashy" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/Review-Slant-%2346a1df?style=for-the-badge&logo=capacitor" alt="Slant"></a>
|
|
<a href="https://github.com/Lissy93/dashy/stargazers" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/github/stars/Lissy93/Dashy?color=ba96d6&label=Star%20-%20GitHub&logo=github&style=for-the-badge" alt="Star on GitHub"></a>
|
|
<a href="https://hub.docker.com/r/lissy93/dashy" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/docker/stars/lissy93/dashy?color=4cb6e0&label=Star%20-%20Docker&logo=docker&style=for-the-badge" alt="Star on DockerHub"></a></p><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_2LWZ" id="make-a-small-donation"></a>Make a small donation<a class="hash-link" href="#make-a-small-donation" title="Direct link to heading">#</a></h2><p>Please only do this is you can definitely afford to. Don't feel any pressure to donate anything, as Dashy and my other projects will always be 100% free, for everyone, for ever.</p><p><a href="https://github.com/sponsors/Lissy93" target="_blank" rel="noopener noreferrer"><img src="https://raw.githubusercontent.com/Lissy93/dashy/master/docs/assets/sponsor-button.svg" alt="Sponsor Lissy93 on GitHub"></a></p><p>Sponsoring will give you several perks, from $1 / £0.70 per month, as well as a sponsor badge on your profile, you can also be credited on the readme, with a link to your website/ profile/ socials, get priority support, have your feature ideas implemented, plus lots more. For more info, see <a href="https://github.com/sponsors/Lissy93" target="_blank" rel="noopener noreferrer">@Lissy93's Sponsor Page</a>.</p><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_2LWZ" id="request-a-feature-via-bountysource"></a>Request a feature via BountySource<a class="hash-link" href="#request-a-feature-via-bountysource" title="Direct link to heading">#</a></h2><p>BountySource is a platform for sponsoring the development of certain features on open source projects. If there is a feature you'd like implemented into Dashy, but either isn't high enough priority or is deemed to be more work than it's worth, then you can instead contribute a bounty towards it's development. You won't pay a penny until your proposal is fully built, and you are satisfied with the result. This helps support the developers, and makes Dashy better for everyone.</p><p><a href="https://www.bountysource.com/teams/dashy" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/BountySource-Dashy-%23F67909?style=for-the-badge&logo=openbugbounty" alt="Request a Feature on BountySource"></a></p><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_2LWZ" id="enable-anonymous-bug-reports"></a>Enable Anonymous Bug Reports<a class="hash-link" href="#enable-anonymous-bug-reports" title="Direct link to heading">#</a></h2><p><a href="https://github.com/getsentry/sentry" target="_blank" rel="noopener noreferrer">Sentry</a> is an open source error tracking and performance monitoring tool, which enables the identification any errors which occur in the production app (only if you enable it). It helps me to discover bugs I was unaware of, and then fix them, in order to make Dashy more reliable long term. This is a simple, yet really helpful step you can take to help improve Dashy.</p><p>To enable error reporting:</p><div class="codeBlockContainer_K1bP"><div class="codeBlockContent_hGly yaml"><pre tabindex="0" class="prism-code language-yaml codeBlock_23N8 thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_39YC"><span class="token-line" style="color:#393A34"><span class="token key atrule" style="color:#00a4db">appConfig</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token key atrule" style="color:#00a4db">enableErrorReporting</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> </span><span class="token boolean important" style="color:#36acaa">true</span></span></code></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_Ue-o clean-btn">Copy</button></div></div><p>All reporting is <strong>disabled</strong> by default, and no data will ever be sent to any external endpoint without your explicit consent. In fact, the error tracking package will not even be imported unless you have actively enabled it. All statistics are anonomized and stored securely. For more about privacy and security, see the <a href="https://sentry.io/security/" target="_blank" rel="noopener noreferrer">Sentry Docs</a>.</p><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_2LWZ" id="follow-for-more"></a>Follow for More<a class="hash-link" href="#follow-for-more" title="Direct link to heading">#</a></h2><p>If you've enjoyed Dashy, you can follow the me to get updates about other projects that I am working on.</p><p><a href="https://twitter.com/Lissy_Sykes" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/twitter/follow/Lissy_Sykes?style=social&logo=twitter" alt="Alicia Sykes on Twitter"></a>
|
|
<a href="https://github.com/Lissy93" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/github/followers/lissy93?label=Lissy93&style=social" alt="Alicia Sykes on GitHub"></a>
|
|
<a href="https://mastodon.social/web/accounts/1032965" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/mastodon/follow/1032965?domain=https%3A%2F%2Fmastodon.social" alt="Alicia Sykes on Mastodon"></a>
|
|
<a href="https://keybase.io/aliciasykes" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/aliciasykes--lightgrey?style=social&logo=Keybase" alt="Alicia Sykes on Keybase"></a>
|
|
<a href="https://keybase.io/aliciasykes/pgp_keys.asc" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/PGP--lightgrey?style=social&logo=Let%E2%80%99s%20Encrypt" alt="Alicia Sykes's PGP"></a>
|
|
<a href="https://aliciasykes.com" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/aliciasykes.com--lightgrey?style=social&logo=Tencent%20QQ" alt="Alicia Sykes's Website"></a>
|
|
<a href="https://notes.aliciasykes.com/" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/Blog--lightgrey?style=social&logo=micro.blog" alt="Alicia Sykes's Blog"></a></p><p>If you like, you could also consider <a href="https://notes.aliciasykes.com/subscribe" target="_blank" rel="noopener noreferrer">subscribing to my mailing list</a> for very occasional blog post updates, or even <a href="https://stars.github.com/nominate/" target="_blank" rel="noopener noreferrer">nominating me (<code>@lissy93</code>)</a> on the GitHub Star Programme.</p><hr><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_2LWZ" id="contributors"></a>Contributors<a class="hash-link" href="#contributors" title="Direct link to heading">#</a></h3><p>For a full list of Dashy's contributors, see the <a href="/docs/credits">Credits Page</a></p><p><img src="https://raw.githubusercontent.com/Lissy93/dashy/master/docs/assets/CONTRIBUTORS.svg" alt="Auto-generated contributors"></p><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_2LWZ" id="star-gazers-over-time"></a>Star-Gazers Over Time<a class="hash-link" href="#star-gazers-over-time" title="Direct link to heading">#</a></h3><p><img src="https://starchart.cc/Lissy93/dashy.svg" alt="Stargazers"></p></div><footer class="row docusaurus-mt-lg"><div class="col"><a href="https://github.com/Lissy93/dashy/edit/gh-pages/docs/docs/contributing.md" target="_blank" rel="noreferrer noopener"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_2_ui" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_3DPF"></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages navigation"><div class="pagination-nav__item"><a class="pagination-nav__link" href="/docs/showcase"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">« User Showcase</div></a></div><div class="pagination-nav__item pagination-nav__item--next"><a class="pagination-nav__link" href="/docs/developing"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Developing »</div></a></div></nav></div></div><div class="col col--3"><div class="tableOfContents_35-E thin-scrollbar"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#submit-a-pr" class="table-of-contents__link">Submit a PR</a></li><li><a href="#add-translations" class="table-of-contents__link">Add Translations</a></li><li><a href="#take-a-2-minute-survey" class="table-of-contents__link">Take a 2-minute survey</a></li><li><a href="#share-your-dashboard" class="table-of-contents__link">Share your dashboard</a></li><li><a href="#improve-the-docs" class="table-of-contents__link">Improve the Docs</a></li><li><a href="#raise-a-bug" class="table-of-contents__link">Raise a bug</a></li><li><a href="#join-the-discussion" class="table-of-contents__link">Join the discussion</a></li><li><a href="#spread-the-word" class="table-of-contents__link">Spread the word</a></li><li><a href="#star-upvote-or-leave-a-review" class="table-of-contents__link">Star, Upvote or Leave a Review</a></li><li><a href="#make-a-small-donation" class="table-of-contents__link">Make a small donation</a></li><li><a href="#request-a-feature-via-bountysource" class="table-of-contents__link">Request a feature via BountySource</a></li><li><a href="#enable-anonymous-bug-reports" class="table-of-contents__link">Enable Anonymous Bug Reports</a></li><li><a href="#follow-for-more" class="table-of-contents__link">Follow for More</a><ul><li><a href="#contributors" class="table-of-contents__link">Contributors</a></li><li><a href="#star-gazers-over-time" class="table-of-contents__link">Star-Gazers Over Time</a></li></ul></li></ul></div></div></div></div></main></div></div><footer class="footer footer--dark"><div class="container"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Intro</div><ul class="footer__items"><li class="footer__item"><a href="https://github.com/lissy93/dashy" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub</a></li><li class="footer__item"><a href="https://demo.dashy.to" target="_blank" rel="noopener noreferrer" class="footer__link-item">Live Demo</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/quick-start">Quick Start</a></li><li class="footer__item"><a class="footer__link-item" href="/docs">Documentation</a></li></ul></div><div class="col footer__col"><div class="footer__title">Setup Guide</div><ul class="footer__items"><li class="footer__item"><a class="footer__link-item" href="/docs/deployment">Deploying</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/configuring">Configuring</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/management">Management</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/troubleshooting">Troubleshooting</a></li></ul></div><div class="col footer__col"><div class="footer__title">Feature Docs Pt 1</div><ul class="footer__items"><li class="footer__item"><a class="footer__link-item" href="/docs/authentication">Authentication</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/alternate-views">Alternate Views</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/backup-restore">Backup & Restore</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/icons">Icons</a></li></ul></div><div class="col footer__col"><div class="footer__title">Feature Docs Pt 2</div><ul class="footer__items"><li class="footer__item"><a class="footer__link-item" href="/docs/multi-language-support">Language Switching</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/status-indicators">Status Indicators</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/searching">Searching & Shortcuts</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/theming">Theming</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items"><li class="footer__item"><a class="footer__link-item" href="/docs/developing">Developing</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/development-guides">Development Guides</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/contributing">Contributing</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/showcase">Showcase</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/credits">Credits</a></li></ul></div><div class="col footer__col"><div class="footer__title">Misc</div><ul class="footer__items"><li class="footer__item"><a class="footer__link-item" href="/docs/privacy">Privacy & Security</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/license">License</a></li><li class="footer__item"><a href="https://github.com/Lissy93/dashy/blob/master/.github/LEGAL.md" target="_blank" rel="noopener noreferrer" class="footer__link-item">Legal</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/code-of-conduct">Code of Conduct</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/changelog">Changelog</a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright"><a href="https://dashy.to">Dashy</a> - The Self-Hosted Dashboard for your Homelab<br>License under <a href="https://github.com/Lissy93/dashy/blob/master/LICENSE">MIT</a>. Copyright © 2021 <a href="https://aliciasykes.com">Alicia Sykes</a></div></div></div></footer></div>
|
|
<script src="/assets/js/runtime~main.02cab8fc.js"></script>
|
|
<script src="/assets/js/main.dc7bf884.js"></script>
|
|
</body>
|
|
</html> |