OpenHAB
/
openhab-webui
mirror of https://github.com/openhab/openhab-webui.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

[skip ci] [orga] Further improvements to the issue templates & README (#530) 

Signed-off-by: Yannick Schaus <github@schaus.net>
pull/540/head
Yannick Schaus 2020-11-17 22:59:35 +01:00 committed by GitHub
parent 668bb82734
commit dae0086a0b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 117 additions and 80 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
.github/ISSUE_TEMPLATE/MAIN_UI_BUG_TEMPLATE.md vendored
View File

@ -1,32 +1,27 @@
---
name: Report a bug with the main UI
about: Use when you have a problem related to the openHAB main web UI that you feel is a issue in the code.
about: Use when you encountered a problem related to the openHAB main web UI that you feel is an issue with the code.
labels: bug,main ui
---
<!--
Please DO NOT ERASE this template, but fill in the details as requested. This will ensure your issue is properly considered. If not, we reserve the right to close it without further action.
Please DO NOT ERASE this template, but fill in the details as requested. This will ensure your issue is properly filed and will be considered. Otherwise, we may reserve the right to close it without further action.
-->
## Your environment
<!--
As an admin, in the main UI, choose *Help & About* on the left sidebar, expand *Technical information* and click on *View details*, then click *Copy* and paste the results here. You may omit information that is not pertinent to this issue if you feel it's divulging information you'd like not to share.
-->
```yaml
```
## The problem
<!--
Describe the issue you're having. In most cases it is appreciated to share screenshots or
even animated GIFs of your issue.
To make screenshots:
* On Windows: use Win+Shift+S
* On macOS: use Cmd+Shift+4
To make animated GIFs we recommend:
* On Windows: ShareX - https://getsharex.com/
* On macOS: Giphy Capture - https://giphy.com/apps/giphycapture
* On Linux: peek - https://github.com/phw/peek#about
* On GNU/Linux: Peek - https://github.com/phw/peek
-->
## Expected behavior
@ -43,6 +38,17 @@ Provide accurate steps to reproduce the issue, including pastes of widget/page c
1.
## Your environment
<!--
As an admin, in the main UI, choose *Help & About* on the left sidebar, expand *Technical information* and click on *View details*, then click *Copy* and paste the results here. You may omit information that is not pertinent to this issue if you feel it's divulging information you'd like not to share.
-->
```yaml
```
## JavaScript Console Output
<!--

41
.github/ISSUE_TEMPLATE/MAIN_UI_FEATURE_SUGGEST_TEMPLATE.md vendored
View File

@ -1,11 +1,32 @@
---
name: Suggest a feature for the main UI
about: Use when you have a idea of improvement for the openHAB main web UI.
about: Use when you have an idea to improve the openHAB main web UI.
labels: enhancement,main ui
---
<!--
Please DO NOT ERASE this template, but fill in the details as requested. This will ensure your issue is properly considered. If not, we reserve the right to close it without further action.
Please DO NOT ERASE this template, but fill in the details as requested. This will ensure your issue is properly filed and will be considered. Otherwise, we may reserve the right to close it without further action.
-->
## The problem
<!--
Describe the issue you're having. In most cases it is appreciated to share screenshots or even animated GIFs of your issue.
To make screenshots:
* On Windows: use Win+Shift+S
* On macOS: use Cmd+Shift+4
To make animated GIFs we recommend:
* On Windows: ShareX - https://getsharex.com/
* On macOS: Giphy Capture - https://giphy.com/apps/giphycapture
* On GNU/Linux: Peek - https://github.com/phw/peek
-->
## Your suggestion
<!--
Describe what your idea is for solving the problem above.
-->
## Your environment
@ -18,22 +39,6 @@ As an admin, in the main UI, choose *Help & About* on the left sidebar, expand *
```
## The problem
<!--
Describe the issue you're having. In most cases it is appreciated to share screenshots or even animated GIFs of your issue.
To make animated GIFs we recommend:
* On Windows: ShareX - https://getsharex.com/
* On macOS: Giphy Capture - https://giphy.com/apps/giphycapture
* On Linux: peek - https://github.com/phw/peek#about
-->
## Your suggestion
<!--
Describe what your idea is for solving the problem above.
-->
## Additional information
<!--

41
.github/ISSUE_TEMPLATE/OTHER_UI_BUG_TEMPLATE.md vendored
View File

@ -1,39 +1,36 @@
---
name: Report a bug with another UI
about: Use when you have a problem related to another UI than the openHAB main web UI.
about: Use when you encountered a problem related to another UI than the openHAB main web UI.
labels: bug
---
<!--
Please DO NOT ERASE this template, but fill in the details as requested. This will ensure your issue is properly considered. If not, we reserve the right to close it without further action.
Please DO NOT ERASE this template, but fill in the details as requested. This will ensure your issue is properly filed and will be considered. Otherwise, we may reserve the right to close it without further action.
-->
## Your environment
<!--
As an admin, in the main UI, choose *Help & About* on the left sidebar, expand *Technical information* and click on *View details*, then click *Copy* and paste the results here. You may omit information that is not pertinent to this issue if you feel it's divulging information you'd like not to share.
-->
```yaml
```
## Which UI are you reporting an issue for?
[ ] Basic UI
[ ] HABPanel
[ ] HABot
[ ] CometVisu
<!-- Note: legacy UIs such as Paper UI, Classic UI or HABmin are not maintained anymore, we don't accept issues for them -->
- [ ] Basic UI
- [ ] HABPanel
- [ ] HABot
- [ ] CometVisu
## The problem
<!--
Describe the issue you're having. In most cases it is appreciated to share screenshots or
even animated GIFs of your issue.
To make screenshots:
* On Windows: use Win+Shift+S
* On macOS: use Cmd+Shift+4
To make animated GIFs we recommend:
* On Windows: ShareX - https://getsharex.com/
* On macOS: Giphy Capture - https://giphy.com/apps/giphycapture
* On Linux: peek - https://github.com/phw/peek#about
* On GNU/Linux: Peek - https://github.com/phw/peek
-->
## Expected behavior
@ -50,6 +47,16 @@ Provide accurate steps to reproduce the issue, including pastes of widget/page c
1.
## Your environment
<!--
As an admin, in the main UI, choose *Help & About* on the left sidebar, expand *Technical information* and click on *View details*, then click *Copy* and paste the results here. You may omit information that is not pertinent to this issue if you feel it's divulging information you'd like not to share.
-->
```yaml
```
## JavaScript Console Output
<!--

57
.github/ISSUE_TEMPLATE/OTHER_UI_FEATURE_SUGGEST_TEMPLATE.md vendored
View File

@ -1,11 +1,41 @@
---
name: Suggest a feature for another UI
about: Use when you have a idea of improvement for an UI other than the openHAB main web UI.
about: Use when you have an idea to improve an UI other than the openHAB main web UI.
labels: enhancement
---
<!--
Please DO NOT ERASE this template, but fill in the details as requested. This will ensure your issue is properly considered. If not, we reserve the right to close it without further action.
Please DO NOT ERASE this template, but fill in the details as requested. This will ensure your issue is properly filed and will be considered. Otherwise, we may reserve the right to close it without further action.
-->
## Which UI are you reporting an issue for?
<!-- Note: legacy UIs such as Paper UI, Classic UI or HABmin are not maintained anymore, we don't accept issues for them -->
- [ ] Basic UI
- [ ] HABPanel
- [ ] HABot
- [ ] CometVisu
## The problem
<!--
Describe the issue you're having. In most cases it is appreciated to share screenshots or even animated GIFs of your issue.
To make screenshots:
* On Windows: use Win+Shift+S
* On macOS: use Cmd+Shift+4
To make animated GIFs we recommend:
* On Windows: ShareX - https://getsharex.com/
* On macOS: Giphy Capture - https://giphy.com/apps/giphycapture
* On GNU/Linux: Peek - https://github.com/phw/peek
-->
## Your suggestion
<!--
Describe what your idea is for solving the problem above.
-->
## Your environment
@ -18,29 +48,6 @@ As an admin, in the main UI, choose *Help & About* on the left sidebar, expand *
```
## Which UI are you reporting an issue for?
[ ] Basic UI
[ ] HABPanel
[ ] HABot
[ ] CometVisu
## The problem
<!--
Describe the issue you're having. In most cases it is appreciated to share screenshots or even animated GIFs of your issue.
To make animated GIFs we recommend:
* On Windows: ShareX - https://getsharex.com/
* On macOS: Giphy Capture - https://giphy.com/apps/giphycapture
* On Linux: peek - https://github.com/phw/peek#about
-->
## Your suggestion
<!--
Describe what your idea is for solving the problem above.
-->
## Additional information
<!--

15
.github/move.yml vendored
View File

@ -8,4 +8,17 @@ closeSourceIssue: true
lockSourceIssue: false
# Set custom aliases for targets
aliases:
core: openhab-core
core: openhab-core
addons: openhab-addons
distro: openhab-distro
docs: openhab-docs
website: website
android: openhab-android
ios: openhab-ios
zwave: org.openhab.binding.zwave
zigbee: org.openhab.binding.zigbee
openhabian: openhabian
docker: openhab-docker
linuxpkg: openhab-linuxpkg
snap: openhab-snap
vscode: openhab-vscode

11
README.md
View File

@ -13,11 +13,10 @@ openHAB has a main web UI but more can be installed thanks to its modular add-on
Most UIs rely on openHAB's REST API which is largely implemented in openHAB Core bundles, but sometimes on individual add-ons.
Therefore, a significant chunk of issues that can be mistakenly assumed to be UI issues could in fact be depending on an extension of the REST API.
Therefore, if your issue is not strictly UI-related it will eventually be transferred or closed with an indication that it requires a change in openHAB Core to be implemented.
If your issue is not strictly UI-related be aware it could eventually be transferred or closed with an indication that it requires a change in openHAB Core to be implemented.
Should you be interested in openHAB Core development, we invite you to check out https://github.com/openhab/openhab-core.
If you are interested in openHAB Core development, we invite you to come by on https://github.com/openhab/openhab-core.
If you have a problem with the web UIs, head over to https://github.com/openhab/openhab-webui/issues.
That being said, if you feel you have a genuine problem with one of the web UIs, please review the existing issues at https://github.com/openhab/openhab-webui/issues first, then file a new one at https://github.com/openhab/openhab-webui/issues/new/choose if appropriate - the menu will guide you.
## Development / Repository Organization
@ -54,14 +53,14 @@ You find the following repository structure:
### How to contribute
You **don't** need a Java development for UI development, in most cases.
In most cases, you **don't** need a Java development environment for UI development.
Instead, make sure you have NodeJS 12.16 or later and npm 6.14 or later installed.
Then identify in the `bundles` directories where the frontend code is - for instance, for the main UI it is `bundles/org.openhab.ui/web/`.
Then follow the instructions in the specific add-on's `CONTRIBUTING.md` file to get started. In the main UI's case, it is located in [bundles/org.openhab.ui/CONTRIBUTING.md](https://github.com/openhab/openhab-webui/blob/master/bundles/org.openhab.ui/CONTRIBUTING.md). In many cases it will involve executing some `npm` commands to install dependencies and start a development server.
However, if you want to compile the final .jar add-ons, we have assembled some step-by-step guides for different IDEs on our developer documentation website:
However, if you want to compile the final `.jar` add-ons, we have assembled some step-by-step guides for different IDEs on our developer documentation website:
https://www.openhab.org/docs/developer/#setup-the-development-environment