docs: #1082 Update docs from CofeeScript to JavaScript examples #1587
Conversation
joeyguerra
changed the title
|
An idea for maybe later... I wonder if we can run the code examples in this as part of CI? 🤔 |
|
I was thinking the same thing. Parse out the code and run it. Later would be great. |
|
@technicalpickles I added you to the reviewers list because I assume that's required to pass the "review required" requirement. |
docs/scripting.md
Outdated
| ``` | ||
|
|
||
| The `robot` parameter is an instance of your robot friend. At this point, we can start scripting up some awesomeness. | ||
| The `robot` argument is an instance of your robot friend. At this point, we can start scripting up some awesomeness. |
There was a problem hiding this comment.
I think technically Javascript refers to them as parameters, but they are effectively synonyms.
scripts/help.js
Outdated
| @@ -0,0 +1,20 @@ | |||
| // Description: | |||
There was a problem hiding this comment.
Did you intend to include this?
There was a problem hiding this comment.
Yes. scripting.md references it:
The included
help.jslets a user ask for help across all commands, or with a search.
There was a problem hiding this comment.
Ah, I think that is actually referring to the help script that would have been auto-generated. I'm not sure when it changed, but that's actually an external script now: https://github.com/hubotio/hubot-help
We do generate an example.js with a bunch of examples though: https://github.com/hubotio/generator-hubot/blob/master/generators/app/templates/scripts/example.js
There was a problem hiding this comment.
Are you saying I should remove it then?
There was a problem hiding this comment.
If it was loaded on a default instance of Hubot, I could see it being useful. But it doesn't, so it doesn't "work" on default. I'm going to remove it.
|
Thank you for reviewing this so thoroughly. I've replaced |
…the docs was really supposed to be to something else
| * Two buckets of access: full and restricted with include/exclude list | ||
| * Specific access rules for every command (Role-based Access Control) | ||
| * Blacklisting/whitelisting commands in specific rooms | ||
| * Include/exclude listing commands in specific rooms |
There was a problem hiding this comment.
Just wanted to call this out, thanks for making the change! It is a change I try to do whenever I notice it.
Addresses issue #1082 . Update the documentation to use JavaScript examples instead of CofeeScript.