Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: node export with images #141

Merged
merged 11 commits into from
Jan 5, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
![GitHub package.json version](https://img.shields.io/github/package-json/v/zwave-js/zwavejs2mqtt)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
[![MadeWithVueJs.com shield](https://madewithvuejs.com/storage/repo-shields/1897-shield.svg)](https://madewithvuejs.com/p/zwavejs2mqtt/shield-link)
[![MIT Licence](https://badges.frapsoft.com/os/mit/mit.png?v=103)](https://opensource.org/licenses/mit-license.php)
[![MIT Licence](https://badges.frapsoft.com/os/mit/mit.png)](https://opensource.org/licenses/mit-license.php)
[![ci](https://github.com/zwave-js/zwavejs2mqtt/workflows/ci/badge.svg?branch=master)](https://github.com/zwave-js/zwavejs2mqtt/actions?query=workflow%3Aci+branch%3Amaster)
[![Docker Build](https://github.com/zwave-js/zwavejs2mqtt/workflows/Docker%20Build/badge.svg?branch=master)](https://github.com/zwave-js/zwavejs2mqtt/actions?query=workflow%3A%22Docker+Build%22+branch%3Amaster)
[![GitHub All Releases](https://img.shields.io/github/downloads/zwave-js/zwavejs2mqtt/total)](https://github.com/zwave-js/zwavejs2mqtt/releases)
Expand All @@ -21,9 +21,9 @@
[![dockeri.co](https://dockeri.co/image/zwavejs/zwavejs2mqtt)](https://hub.docker.com/r/zwavejs/zwavejs2mqtt)

<div>
<img src="/_images/zwavejs_logo.svg" width="300" alt="zwavejs">
<img src="docs/_images/zwavejs_logo.svg" width="300" alt="zwavejs">
<span style="font-size: 25px">TO</span>
<img src="/_images/MQTT-Logo.png" alt="mqtt">
<img src="docs/_images/MQTT-Logo.png" alt="mqtt">
</div>

Fully configurable Zwave to MQTT **Gateway** and **Control Panel**.
Expand Down
6 changes: 3 additions & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
![GitHub package.json version](https://img.shields.io/github/package-json/v/zwave-js/zwavejs2mqtt)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
[![MadeWithVueJs.com shield](https://madewithvuejs.com/storage/repo-shields/1897-shield.svg)](https://madewithvuejs.com/p/zwavejs2mqtt/shield-link)
[![MIT Licence](https://badges.frapsoft.com/os/mit/mit.png?v=103)](https://opensource.org/licenses/mit-license.php)
[![MIT Licence](https://badges.frapsoft.com/os/mit/mit.png)](https://opensource.org/licenses/mit-license.php)
[![ci](https://github.com/zwave-js/zwavejs2mqtt/workflows/ci/badge.svg?branch=master)](https://github.com/zwave-js/zwavejs2mqtt/actions?query=workflow%3Aci+branch%3Amaster)
[![Docker Build](https://github.com/zwave-js/zwavejs2mqtt/workflows/Docker%20Build/badge.svg?branch=master)](https://github.com/zwave-js/zwavejs2mqtt/actions?query=workflow%3A%22Docker+Build%22+branch%3Amaster)
[![GitHub All Releases](https://img.shields.io/github/downloads/zwave-js/zwavejs2mqtt/total)](https://github.com/zwave-js/zwavejs2mqtt/releases)
Expand All @@ -21,9 +21,9 @@
[![dockeri.co](https://dockeri.co/image/zwavejs/zwavejs2mqtt)](https://hub.docker.com/r/zwavejs/zwavejs2mqtt)

<div>
<img src="/_images/zwavejs_logo.svg" width="300" alt="zwavejs">
<img src="_images/zwavejs_logo.svg" width="300" alt="zwavejs">
<span style="font-size: 25px">TO</span>
<img src="/_images/MQTT-Logo.png" alt="mqtt">
<img src="_images/MQTT-Logo.png" alt="mqtt">
</div>

Fully configurable Zwave to MQTT **Gateway** and **Control Panel**.
Expand Down
Binary file added docs/_images/troubleshoot_export.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/troubleshoot_export_2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/troubleshoot_node_json.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/troubleshoot_node_select.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions docs/_sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@

- [Introduction](development/intro.md)

- Troubleshooting

- [Exporting Node Json](troubleshooting/node_export.md)

- [Screenshots](screenshots.md)
- [Thanks](thanks.md)
- [Author](author.md)
22 changes: 22 additions & 0 deletions docs/troubleshooting/node_export.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Report a Node Bug

When it comes to node issues, it is best to export specific information, which can help us debug and help with the problem
varet80 marked this conversation as resolved.
Show resolved Hide resolved

## Export node json

Each node hass an Export button, this will export all data of this specific node. To perform this export, use our screen shots and steps as your guide.

1. Select node from the web ui
![Selected node](../_images/troubleshoot_node_select.png)

Will result showing you more details of the node at the bottom of your interface.

![Export location](../_images/troubleshoot_export.png)

2. Export Node json by clicking on export shown on screenshot! this will generate a json of this specific node.

![Selected node](../_images/troubleshoot_export_2.png)

3. Grab the file and attach it on your github Issue

![Grab file](../_images/troubleshoot_node_json.png)