Skip to content

Commit 7c1d87c

Browse files
mblackstockknolleary
authored andcommitted
add notes on requiring some javascript, modifying objects (#70)
* add notes on requiring some javascript, modifying objects * added another primer link * Keep only link to MDN * JavaScript not Javascript
1 parent f5b9953 commit 7c1d87c

3 files changed

Lines changed: 18 additions & 2 deletions

File tree

docs/configuration.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,10 @@ Node-RED includes a default `settings.js` file that will be used in absence of a
1717
user-provided settings file. It can also be used as a starting point for creating
1818
your own settings file. It can be seen on GitHub [here](https://github.com/node-red/node-red/blob/master/settings.js).
1919

20+
<div class="doc-callout">
21+
<em>Note</em>: The <code>settings.js</code> file exports a <em>JavaScript object</em>. To configure Node-RED you should understand how to modify a JavaScript object by adding new or modifying existing key/value pairs.
22+
</div>
23+
2024
When [embedded](embedding), they are passed in the call to `RED.init()`.
2125
However, when run in this mode, certain properties are ignored and are left to
2226
the embedding application to implement.

docs/user-guide/index.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ title: User Guide
66

77
There's lots more to write in this guide, we're just getting started.
88

9-
109
- [Configuring Node-RED](/docs/configuration)
1110
- [Security](/docs/security)
1211
- [Logging](/docs/user-guide/logging)
@@ -16,6 +15,13 @@ There's lots more to write in this guide, we're just getting started.
1615
- [Working with messages](/docs/user-guide/messages)
1716
- [Embedding into an existing app](/docs/embedding)
1817

18+
<div class="doc-callout">
19+
<em>Note</em>: Parts of the user guide assume the reader is somewhat familiar with
20+
<strong>JavaScript</strong> (not Java). There are many online resources to get up
21+
to speed with JavaScript. Mozilla, for example, has a good
22+
<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/A_re-introduction_to_JavaScript">re-introduction to JavaScript</a>
23+
that should get you headed in the right direction.
24+
</div>
1925

2026
### Other places to get help
2127

docs/user-guide/projects/index.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,12 +38,18 @@ enabled in the settings file.
3838
To enable the projects feature, edit your `settings.js` file and add the following
3939
option within the `module.exports` block and restart Node-RED.
4040

41+
<div class="doc-callout">
42+
<em>Note</em>: The <code>settings.js</code> file exports a <em>JavaScript object</em>.
43+
To configure Node-RED you should understand how to modify a JavaScript object by adding
44+
new or modifying existing key/value pairs like the <code>editorTheme</code> below.
45+
</div>
46+
4147
```
4248
editorTheme: {
4349
projects: {
4450
enabled: true
4551
}
46-
}
52+
},
4753
```
4854

4955
The feature relies on having the `git` and `ssh-keygen` command line tools available.

0 commit comments

Comments
 (0)