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

[WIP] Visual Studio Code IDE Documentation #2400

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

pgfeller
Copy link
Contributor

@pgfeller pgfeller commented Nov 12, 2024

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

  • ...

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 openhab#2276
---
## TODO
- [ ] ....
Copy link

netlify bot commented Nov 12, 2024

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 d984b76
🔍 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...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@dalgwen
Copy link
Contributor

dalgwen commented Dec 30, 2024

Hello,
I don't know if it's revelant, but I added an option to launch the demo project with maven.
#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.

@pgfeller
Copy link
Contributor Author

pgfeller commented Jan 7, 2025

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants