I’m going to keep my reply short because it’s veering off topic. Clearly I failed in that.
If you want to have a discussion on adding something to the marketplace please open a new thread and we can continue there in depth.
But I do want to say the following and answer the non-rhetorical questions (and the one’s I’m going to pretend are not rhetorical).
We’ve done our best to make contributing to the marketplace as easy as possible. If anyone has technically feasible ideas to make it even easier we welcome issues. I like the idea of being able to publish to the forum straight from MainUI, but doubt that would address even half of your complaints.
I don’t understand the question. But the general convention in documentation involving computers, stuff in [ ]
or < >
denote something that you need to replace with your content. The [ ]
or < >
are removed. To make this more obvious, the _
and are an attempt to make it even more clear these are the parts that you have to replace.
But what never ceases to amaze me is how few people are willing to just experiment. Create a post and see how it looks. See how it works. Adjust and see what changes.
The assumption is that anyone contributing to the marketplace is going to be somewhat even a little bit active on the forum. The number of # is the header level.
Yes.
Not really beyond the obvious stuff like don’t use the same name as someone else’s widget, be polite, etc.
In the description or in the title and the description. You can also add tags to the post. It’s up to you to decide how to document your widget.
However, it should not use hard coded Item names. Item should be parameters so the end users can name their Items how they see fit or use the Items they already have created.
Use what ever makes sense to you. Tags are useful to readers of the forum to help find and identify relevant posts. The only tags that are required is the maturity level which you supply and the “published” tag which a forum moderator will add after review, as described in the template.
You can decide to version it how ever you want. This is all information you are providing to the users of the widget. Whatever you think is best to inform your users what your widget it and how to use it is good.
Given that the very first reply to any post made to this forum where code is posted without code fences is
Please use code fences for all code and logs.
```
Code goes here
```
coupled with the assumption that these users are at least a little bit familiar with the forum, yes, we assume just about everyone would understand that. Note there are also icons at the top of the reply pane to add code fences.
Are these users likely to be publishing to the marketplace in the first place? Do we want these sorts of users publishing to the marketplace?
Personally, it never even occurred to me that these users would even want to publish to the marketplace. And I worry if these users do because for the beginners their offering might have quality issues and the user who isn’t engaged with OH that much is likely to abandon their contribution leaving the marketplace littered with broken and forgotten contributions.
There should be at least a little bit of friction to contributing to the marketplace. That doesn’t mean it shouldn’t be easier but the actual audience for marketplace contributors should be identified.
You don’t have to make yourself “comfortable” with GitHub. The page that opens up when you click the link walks you through all the steps necessary to make the edit and create the PR. @Oliver2 demonstrated above (? maybe it was another thread) even if you don’t know what you are doing, don’t know the difference between a Pull Request and a Press Release, managed to create and submit a PR. In his attempt to show how hard it is he managed to show that even someone who doesn’t know anything about the tools can figure it out.
We also have numerous tutorials here on the forum and have lots of people who will jump at the chance to help if necessary.
What other tools do you need to make updates to the docs? I routinely make small updates to the docs using nothing by a browser and my GitHub account. If you are going to make code changes then yes, you need lots of tools but that’s just software development which always requires lots of tools.
If you don’t even create an issue your problem will most likely never be addressed. You are the one with the problem. You are the one who is best able to provide the detail to solve the problem.
There are many alternative home automation products that are much less complicated. They are much less capable too but that is the trade off. If OH is too complicated to set up and keep up and your home automation needs are modest, perhaps OH isn’t the best choice for your. However, you can’t have your cake and eat it too. You can’t have both the flexibility and capability without the added complexity.
Home automation is hard. That’s just the way it is. We have thousands of little walled gardens, billions of unique use cases (or user stories if Agile is your thing), incompatible licensing, services that start up and close down, etc. The fact that OH does as much as it does, as well as it does, and makes this all as simple as it does is astonishing to me. Could it be even better and simpler? Yes! Absolutely!
But it’s never ever going to be so simple that my spouse will have the patience and willingness to set it up. For that to even become possible, there will have to be a massive consolidation in home automation technologies and APIs and a huge reduction in possibilities down to something about at the level of what Google Home offers as of this writing. Most users of OH though recognize that as the toy that it is though, it’s so limiting, and even that toy is beyond what a lot of users can handle.
I posted this above I think but here it is again: [Wiki] How to contribute to the openHAB Documentation
This is way more detailed and thorough than is necessary but it explains everything. It’s a great resource. When I get lost or forget something (I’m always forgetting how to properly sign off, for example), I always search for this post.