Skip to content

Commit

Permalink
updated issue templated and changed workflow for docs (#867)
Browse files Browse the repository at this point in the history
* updated issue templated

* updated "supporting this project" section

* Updated Node.js version for GitHub Pages workflow

* Update README.md

* Update README.md

---------

Co-authored-by: Louisvdw <26077665+Louisvdw@users.noreply.github.com>
  • Loading branch information
mr-manuel and Louisvdw authored Nov 20, 2023
1 parent 3681748 commit 4617419
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 4 deletions.
12 changes: 10 additions & 2 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,17 @@ body:
In the case you have difficulties to write in english, try the [deepl.com](https://www.deepl.com) translator.
## 🚨 IMPORTANT 🚨
* Please carefully read all the instructions below including the descriptions! Very often we have to request the data again, because it was not provided in the first place.
* Please try the `nightly` build from the `dev` first, if you are not already using it. It's very likely that the bug is already fixed. See [here](https://louisvdw.github.io/dbus-serialbattery/general/install#nightly-build) how to install it.
- type: textarea
id: description
attributes:
label: Describe the bug
description: A clear and concise description of what the bug is. Paste also screenshots, if needed.
description: A clear and concise description of what the bug is. Paste also screenshots and pictures, if needed. The more informations you give, the faster we find a solution.
placeholder: |
NOTE: Paste the logfields in the appropriate field below.
validations:
Expand Down Expand Up @@ -69,7 +75,9 @@ body:
- Ekrano GX
- GX Card (integrated in Victron device)
- Octo GX
- Raspberry Pi
- Raspberry Pi 2
- Raspberry Pi 3
- Raspberry Pi 4
- VANcu GX
- Venus_GX
validations:
Expand Down
4 changes: 4 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ body:
In the case you have difficulties to write in english, try the [deepl.com](https://www.deepl.com) translator.
## 🚨 IMPORTANT 🚨
* Please try the `nightly` build from the `dev` first, if you are not already using it. Maybe the feature was already developed. See [here](https://louisvdw.github.io/dbus-serialbattery/general/install#nightly-build) how to install it.
- type: textarea
id: idea
attributes:
Expand Down
6 changes: 6 additions & 0 deletions .github/ISSUE_TEMPLATE/support_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,12 @@ body:
In the case you have difficulties to write in english, try the [deepl.com](https://www.deepl.com) translator.
## 🚨 IMPORTANT 🚨
* Please carefully read all the instructions below including the descriptions! Very often we have to request the data again, because it was not provided in the first place.
* Please try the `nightly` build from the `dev` first, if you are not already using it. It's very likely that the bug is already fixed. See [here](https://louisvdw.github.io/dbus-serialbattery/general/install#nightly-build) how to install it.
- type: textarea
id: description
attributes:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/github-pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ jobs:
- name: Set up Node.js
uses: actions/setup-node@v3
with:
node-version: 16.x
node-version: 21.x
cache: yarn
cache-dependency-path: './docs/yarn.lock' # THIS PATTERN did the trick for me.

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,12 @@ If you find this driver helpful please consider supporting this project. You can

### Support [mr-manuel](https://github.com/mr-manuel)
* Added a lot of features, optimizations and improvements with `v1.0.x`
* Assistance with the issues and discussions of forum
* Added a lot of documentation to the config file and notes that are displayed after installation for better understanding
* Introduced the new documentation page of the driver and reworked a great part of it for easier understanding

[<img src="https://github.md0.eu/uploads/donate-button.svg" height="38">](https://www.paypal.com/donate/?hosted_button_id=3NEVZBDM5KABW)


### Developer Remarks
To develop this project, install the requirements. This project makes use of velib_python which is pre-installed on
Venus-OS Devices under `/opt/victronenergy/dbus-systemcalc-py/ext/velib_python`. To use the python files locally,
Expand Down

0 comments on commit 4617419

Please sign in to comment.