search

openhab / openhab-qnap-qpkg

openHAB Packages for QNAP NAS systems
Eclipse Public License 2.0
77 stars 21 forks source link

Update documentation screenshots #17

Open kaikreuzer opened 7 years ago

kaikreuzer commented 7 years ago

Hi @thopiekar,

many thanks for putting together a package with the final 2.0 release!

I'd like to mention this on social media, so that people know about it. I wonder if you could update the screenshots to reflect that release? Here in the README.md and on http://docs.openhab.org/installation/qnap.html it shows version 1.9.9.b3 and a file openHAB_2.0.0-b3-1.qpkg in the images. This might be irritating for a few users, so an update would be great!

thopiekar commented 7 years ago

Done. Here in my repo.. Only needs an update in openhab.docs..

6r15u commented 6 years ago

@kaikreuzer how can the double work with the readme.md here and the documentation in openhab-docs be reduced? I checked and makeup langugae doesn't allow include of other pages. Is referring of wiki (openhab-docs) to the readme here or from here to the wiki better?

kaikreuzer commented 6 years ago

@6r15u We usually maintain the content in the repo itself (either as the README.md or as an additional USAGE.md) and then have it copied into the openhab-docs like e.g. here: https://github.com/openhab/openhab-docs/blob/5c7229bfc07969e2d0e3d243e5594ca73f91ee3b/pom.xml#L463-L473

@ThomDietrich Might be able to help you on finding the best way here.

ThomDietrich commented 6 years ago

@6r15u exactly. It would be nice to do just that with this repository as well. All you need to do is provide a USAGE.md file. Please look at these similar issues/prs where I've already described the process and things to do: