openhab-docs
openhab-docs copied to clipboard
openhab
[WIP] Visual Studio Code IDE Documentation
As the documentation already improved significantly since the issue was created, the improvements planed for this PR are minor. The main "feature" planed for this PR is, how docker image(s) can be used to develop & debug a binding without actually installing openHAB on the development system.
This also simplifies to work with different versions (e.g. if you analyze an issue of a released version, or if you develop/test on nightly builds). The proposed changes should also help to improve developer experience, e.g. add-on's and task configurations to locally check code formating rules (linting).
Fixes #2276
TODO
- [ ] ....
References
- ...
Thanks for your pull request to the openHAB documentation! The result can be previewed at the URL below (this comment and the preview will be updated if you add more commits).
Built without sensitive environment variables
| Name | Link |
|---|---|
| Latest commit | d984b76205301ae867e704d56f02b32e6137eb37 |
| Latest deploy log | https://app.netlify.com/sites/openhab-docs-preview/deploys/67336f0f487abe00083040bd |
| Deploy Preview | https://deploy-preview-2400--openhab-docs-preview.netlify.app |
| Preview on mobile | Toggle QR Code...Use your smartphone camera to open QR code link. |
To edit notification comments on pull requests, go to your Netlify site configuration.
![netlify[bot] avatar](https://avatars.githubusercontent.com/in/13473?v=4 "Published by a pub.dev verified publisher"){kind=small}
Hello, I don't know if it's revelant, but I added an option to launch the demo project with maven. https://github.com/openhab/openhab-docs/pull/2435
With this, by checkout-ing the relevant openhab-distro version branch, you can target a specific version to run and debug your addon with.
Hi @dalgwen Gwendal,
thank you for making me aware of this - yes; that's very relevant and exactly in line with what I would like to do: more time to code, less time to setup the environment 🙂.
Unfortunately this wip is not the first one in my queue yet - but I'll try to work in parallel on that one as well. As I know from experience, that if you decide to contribute to the project, the start/setup should be as easy as possible. As especially a first contributors frustration tolerance in that phase is typically low - and the time can be invested better in function rather than learning the "internals" you only need in a later phase (if at all).
with kind regards, Patrik