We love to share and hope this site will help you find your way in realising your personal Smart Home Solution',
As OpenSource community we like to share our efforts, DrozmotiX develops and maintains several ioBroker-Adapters and here you can find all related documentation how to use them and some additional basic guidance for ioBroker Setup.
We created a basic Documentation Page based on Vuepress with some additional logic to handle translations and navigations structures efficient. Files are editable in MarkDown at our Documentation Repository and published to the git.io page repository
If you would like to adopt this setup, please feel free to copy the structure and have a look at the config_Template.js to understand how this site is configured.
All main settings are handled in this file (you must rename it to config.js) including automated SideBar creation for each language.
The DrozmotiX-OSS docu page is published at https://drozmotix.github.io
Option 1) Directly in github/webbrowser
At every page, you find a link at the bottom left "You can help us by editing this page hier", hit it !
You will be redirected to github and the file you where just looking at, please feel free to make changes and provide a PR request
Option 2) Forking the repository
For larger changes, or if you prefer this option, feel free to fork the Documentation Repository and make your chances.
We would be very happy to receive pull request keeping the documentation up-to-date and solve misunderstandings !
Documentation root is based on language locals, so your starting point should be here languagesFolder
Each adapter/main section has his own directory with sub-files. If you are able to, please provide your changes in EN & DE.
If not, don't worry we still would like to have your PR and will manage the translation anyway :-)
If you would like to support this OSS-Project in another way, we accept donations to buy products supporting our development activities
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
Examples of behavior that contributes to creating a positive environment include:
- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
- The use of sexualized language or imagery and unwelcome sexual attention or advances
- Trolling, insulting/derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or electronic address, without explicit permission
- Other conduct which could reasonably be considered inappropriate in a professional setting
- Our Responsibilities
Contributors are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
Contributors have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at oss@DrozmotiX.eu. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
Contributors who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.