tyler.durden/dashy
1
0
Fork 0
mirror of https://github.com/Lissy93/dashy.git synced 2025-07-27 15:44:27 +02:00
Code Issues Packages Projects Releases Wiki Activity

🩹 Fix more broken relative links

Browse Source
This commit is contained in:
Alicia Sykes 2021-09-19 23:21:55 +01:00
parent c67e7ae195
commit be1571f7fa
4 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/configuring.md
View File

@ -31,7 +31,7 @@ Tips:
- You may find it helpful to look at some sample config files to get you started, a collection of which can be found [here](https://gist.github.com/Lissy93/000f712a5ce98f212817d20bc16bab10) - You may find it helpful to look at some sample config files to get you started, a collection of which can be found [here](https://gist.github.com/Lissy93/000f712a5ce98f212817d20bc16bab10)
- You can check that your config file fits the schema, by running `yarn validate-config` - You can check that your config file fits the schema, by running `yarn validate-config`
- After modifying your config, the app needs to be recompiled, by running `yarn build` - this happens automatically whilst the app is running if you're using Docker - After modifying your config, the app needs to be recompiled, by running `yarn build` - this happens automatically whilst the app is running if you're using Docker
- It is recommended to make and keep a backup of your config file. You can download your current config through the UI either from the Config menu, or using the `/download` endpoint. Alternatively, you can use the [Cloud Backup](./docs/backup-restore) feature. - It is recommended to make and keep a backup of your config file. You can download your current config through the UI either from the Config menu, or using the `/download` endpoint. Alternatively, you can use the [Cloud Backup](/docs/backup-restore) feature.
- The config can also be modified directly through the UI, validated and written to the conf.yml file. - The config can also be modified directly through the UI, validated and written to the conf.yml file.
- All fields are optional, unless otherwise stated. - All fields are optional, unless otherwise stated.

2
docs/developing.md
View File

@ -2,7 +2,7 @@
# Developing # Developing
This article outlines how to get Dashy running in a development environment, and outlines the basics of the architecture. This article outlines how to get Dashy running in a development environment, and outlines the basics of the architecture.
If you're adding new features, you may want to check out the [Development Guides](./docs/development-guides) docs, for tutorials covering basic tasks. If you're adding new features, you may want to check out the [Development Guides](/docs/development-guides) docs, for tutorials covering basic tasks.
- [Setting up the Development Environment](#setting-up-the-dev-environment) - [Setting up the Development Environment](#setting-up-the-dev-environment)
- [Prerequisites](#prerequisites) - [Prerequisites](#prerequisites)

10
docs/development-guides.md
View File

@ -28,13 +28,13 @@ html[data-theme='tiger'] {
Then you can go ahead and write you're own custom CSS. Although all CSS is supported here, the best way to define you're theme is by setting the CSS variables. You can find a [list of all CSS variables, here](https://github.com/Lissy93/dashy/blob/master/docs/theming#css-variables). Then you can go ahead and write you're own custom CSS. Although all CSS is supported here, the best way to define you're theme is by setting the CSS variables. You can find a [list of all CSS variables, here](https://github.com/Lissy93/dashy/blob/master/docs/theming#css-variables).
For a full guide on styling, see [Theming Docs](./theming). For a full guide on styling, see [Theming Docs](/docs/theming).
Note that if you're theme is just for yourself, and you're not submitting a PR, then you can instead just pass it under `appConfig.cssThemes` inside your config file. And then put your theme in your own stylesheet, and pass it into the Docker container - [see how](https://github.com/Lissy93/dashy/blob/master/docs/theming#adding-your-own-theme). Note that if you're theme is just for yourself, and you're not submitting a PR, then you can instead just pass it under `appConfig.cssThemes` inside your config file. And then put your theme in your own stylesheet, and pass it into the Docker container - [see how](https://github.com/Lissy93/dashy/blob/master/docs/theming#adding-your-own-theme).
## Writing Translations ## Writing Translations
For full docs about Dashy's multi-language support, see [Multi-Language Support](./multi-language-support) For full docs about Dashy's multi-language support, see [Multi-Language Support](/docs/multi-language-support)
Dashy is using [vue-i18n](https://vue-i18n.intlify.dev/guide/) to manage multi-language support. Dashy is using [vue-i18n](https://vue-i18n.intlify.dev/guide/) to manage multi-language support.
@ -92,7 +92,7 @@ If you are not comfortable with making pull requests, or do not want to modify t
This section is for, if you're adding a new component or setting, that requires an additional item to be added to the users config file. This section is for, if you're adding a new component or setting, that requires an additional item to be added to the users config file.
All of the users config is specified in `./public/conf.yml` - see [Configuring Docs](./configuring) for info. All of the users config is specified in `./public/conf.yml` - see [Configuring Docs](/docs/configuring) for info.
Before adding a new option in the config file, first ensure that there is nothing similar available, that is is definitely necessary, it will not conflict with any other options and most importantly that it will not cause any breaking changes. Ensure that you choose an appropriate and relevant section to place it under. Before adding a new option in the config file, first ensure that there is nothing similar available, that is is definitely necessary, it will not conflict with any other options and most importantly that it will not cause any breaking changes. Ensure that you choose an appropriate and relevant section to place it under.
Next decide the most appropriate place for your attribute: Next decide the most appropriate place for your attribute:
@ -124,13 +124,13 @@ Next, if you're property should have a default value, then add it to [`defaults.
If your property needs additional logic for fetching, setting or processing, then you can add a helper function within [`ConfigHelpers.js`](https://github.com/Lissy93/dashy/blob/master/src/utils/ConfigHelpers.js). If your property needs additional logic for fetching, setting or processing, then you can add a helper function within [`ConfigHelpers.js`](https://github.com/Lissy93/dashy/blob/master/src/utils/ConfigHelpers.js).
Finally, add your new property to the [`configuring.md`](./configuring) API docs. Put it under the relevant section, and be sure to include field name, data type, a description and mention that it is optional. If your new feature needs more explaining, then you can also document it under the relevant section elsewhere in the documentation. Finally, add your new property to the [`configuring.md`](/docs/configuring) API docs. Put it under the relevant section, and be sure to include field name, data type, a description and mention that it is optional. If your new feature needs more explaining, then you can also document it under the relevant section elsewhere in the documentation.
Checklist: Checklist:
- [ ] Ensure the new attribute is actually necessary, and nothing similar already exists - [ ] Ensure the new attribute is actually necessary, and nothing similar already exists
- [ ] Update the [Schema](https://github.com/Lissy93/dashy/blob/master/src/utils/ConfigSchema.js) with the parameters for your new option - [ ] Update the [Schema](https://github.com/Lissy93/dashy/blob/master/src/utils/ConfigSchema.js) with the parameters for your new option
- [ ] Set a default value (if required) within [`defaults.js`](https://github.com/Lissy93/dashy/blob/master/src/utils/defaults.js) - [ ] Set a default value (if required) within [`defaults.js`](https://github.com/Lissy93/dashy/blob/master/src/utils/defaults.js)
- [ ] Document the new value in [`configuring.md`](./configuring) - [ ] Document the new value in [`configuring.md`](/docs/configuring)
- [ ] Test that the reading of the new attribute is properly handled, and will not cause any errors when it is missing or populated with an unexpected value - [ ] Test that the reading of the new attribute is properly handled, and will not cause any errors when it is missing or populated with an unexpected value
--- ---

2
docs/quick-start.md
View File

@ -121,7 +121,7 @@ Then edit `./public/conf.yml` and rebuild the app with `yarn build`
## Alternative Deployment Method 2 - Netlify ## Alternative Deployment Method 2 - Netlify
Don't have a server? No problem! You can run Dashy for free on Netlify (as well as many [other cloud providers](./docs/deployment#deploy-to-cloud-service)). All you need it a GitHub account. Don't have a server? No problem! You can run Dashy for free on Netlify (as well as many [other cloud providers](/docs/deployment#deploy-to-cloud-service)). All you need it a GitHub account.
1. Fork Dashy's repository on GitHub 1. Fork Dashy's repository on GitHub
2. [Log in](https://app.netlify.com/login/) to Netlify with GitHub 2. [Log in](https://app.netlify.com/login/) to Netlify with GitHub
3. Click "New site from Git" and select your forked repo, then click **Deploy**! 3. Click "New site from Git" and select your forked repo, then click **Deploy**!