JSR223 Helper Libraries/ Jython Support Install Guide - openHAB 2.5 (WIP)

Mind letting the community know what steps here are incorrect?

As indicated in the other other thread, I posted the steps I did for troubleshooting purposes. I also commented there in regards to that. I’m unaware of a 3rd place I posted steps, let alone bad steps. Please forgive me.

Last time I made a suggestion about documentation I was greatly insulted and my ideas were not well received so I decided to stick to the community. That said, there are several issues with that link I based this on.

Improvement Suggestions to Existing Documentation (IMHO) (WIP):

  • Helper Libraries Installation is impossible to find unless you know where to link
  • JSR223 Scripting link doesnt link to the Helper Libraries Installation guide! (If it does, it isn’t obvious)
  • There is no version information in the Helper Libraries Installation so you have no idea if you just came across yet another irrelevant guide, or the “real deal”.
  • Helper Libraries Installation doesn’t indicate anything of such that it’s an official guide. This guide here comes across as just as official as that one, or maybe this one seems more official given the domain & location it’s in. (Why isn’t that guide on the openhab.org website in the official documentation?)
  • The standalone jython jar link gives a 404
  • Some of the steps aren’t clear to (me). Maybe minor or personal preference, but take #1 for example: this isn’t a step, its just a comment so why is it step 1? And Steps 2, 3, & 4 to my understanding aren’t needed either, rather for debugging & development steps.
  • I clearly put in my Guide this is for Raspberry Pi, which I understand is a very common HW choice. My guide is specific to that. So step 7 & 8, and all file locations are specified from root to help expedite the conf locations & such. Again, my goal was to make this a 1 stop shop to install this component and eliminate cross-research.
  • This guide is tagged with “Beginners”. Step 10 is a good example on what I mean: while I’m extremely proficient in Windows, I’m more of an amateur with Linux. So I spell out how to modify a file with nano, save it & exit.

Nonetheless, I greatly appreciate that guide because it did ultimately help me get this running. Those above are just my opinion, coming from an “openhab first-time technical user”. I will not take it personally if you ignore them.

Thanks Scott for your feedback.

UPDATE: I’m updating this post to clearly identify in bullets what I personally think is wrong with the current documentation. (Just constructive criticism) I know this is not the process (I’m supposed to create PR, etc), but given some of the remarks in this thread alone I’m sure you’ll understand why I’m not going to give “my worthless opinion” there - you guys might actually break me over in that arena!