Document What Parameters Mean

[kornpow]

[ ] 🐞 Bug [ ] 🚀 Feature [ ] 🛠 Task [x] 📄 Documentation

Description

Please provide variable descriptions! A lot of them are self-explanatory, but when they are not, it involves a million pipeline runs to try and decipher what some of the lines mean.

s3Upload: file: self-explanatory? bucket: self-explanatory? workingDir: Mostly self-explanatory sort of includePathPattern: ? path: I am not sure how this relates to above path variables.

It just seems super baffling that these aren't documented from the get-go? Why are all Jenkins plugin documentation written for "Jenkins Plugin Developers" instead of normal people using Jenkins? If I had a nickle for every plugin that doesn't say how to actually use the plugin in Pipeline, I'd have a handful of nickels.

Thanks for your hard work!