node-red
Update Configuration.md Documentation
This is a PR for updating the Node-red Configuration section in the user guide to match the latest settings.js options.
I used as a template the settings.js template file from here
Went through it and added the missing options and half way through copy/pasting i realized that some of these option wont apply for people using older versions of Node-red. Dont know how you want to handle that. a message at the top saying that its for version 3 ?
I tested it with Jekyll. Needs to be reviewed. Hope its useful
Yes - a vast improvement. Yes - I think a small note to say this is for version 3 would be a good idea. (I guess we could rename the existing ...old or something and link to that ?
We should also add a link to this page on the settings file page https://nodered.org/docs/user-guide/runtime/settings-file - as that talks about this file but doesn't then lead you to the options.
Might be better to mark min version for features
E.g. diagnostics >= v3.0.0
Ps, @unborn-andy thanks for this
I think a small note to say this is for version 3 would be a good idea. (I guess we could rename the existing ...old or something and link to that ?
yes maybe we can use both .. a note at the top saying "Some options may not apply for older versions of Node-red". With this wording we can avoid updating that note every time NR version changes ;) and also write under each option the version when this feature was introduced. Like we see in other parts of the docs. For example for functionExternalModules it says Since Node-RED 1.3.0.
We should also add a link to this page on the settings file page https://nodered.org/docs/user-guide/runtime/settings-file - as that talks about this file but doesn't then lead you to the options.
yes .. i noticed it also .. some changes are needed on other pages also but i avoided editing other sections so it would be easier for you guys to review ;)
Might be better to mark min version for features E.g. diagnostics >= v3.0.0
this is going to need someone more experienced with the inner workings of settings.js to add. i tried to look for some of this information from the changelog and from Releases but the new feature in not always mentioned in a way that i can easily search.
I propose it may be better to switch branch to 2.x and browse the source tree from there. You will see the differences. That should help with marking things as new to v3 or changed in v3