Skip to content

Commit

Permalink
wip
Browse files Browse the repository at this point in the history
  • Loading branch information
StarfallProjects committed Jan 8, 2024
1 parent 55413c6 commit bfa1a15
Show file tree
Hide file tree
Showing 10 changed files with 15 additions and 13 deletions.
2 changes: 1 addition & 1 deletion docs/1-0-migration-checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ docker run --rm -it --user root -v ~/.n8n:/home/node/.n8n --entrypoint chown n8n

#### Image removal

We have removed the Debian and RHEL images. If you were using these you need to change the image you use. This shouldn't result in any errors unless you were making a custom image based on one of those images.
We've removed the Debian and RHEL images. If you were using these you need to change the image you use. This shouldn't result in any errors unless you were making a custom image based on one of those images.

Check warning on line 75 in docs/1-0-migration-checklist.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/1-0-migration-checklist.md#L75

[from-microsoft.We] Try to avoid using first-person plural like 'We'.
Raw output
{"message": "[from-microsoft.We] Try to avoid using first-person plural like 'We'.", "location": {"path": "docs/1-0-migration-checklist.md", "range": {"start": {"line": 75, "column": 1}}}, "severity": "WARNING"}

#### Entrypoint change

Expand Down
4 changes: 2 additions & 2 deletions docs/code/jmespath.md
Original file line number Diff line number Diff line change
Expand Up @@ -281,9 +281,9 @@ Given this JSON from a webhook node:

```


<!-- vale off -->
Use multiselect list to get the first and last names and create new lists containing both names:

<!-- vale on -->
=== "Expressions (JavaScript)"

[[% raw %]]
Expand Down
4 changes: 2 additions & 2 deletions docs/code/luxon.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ Luxon provides functions to handle conversions for a range of formats. Refer to

Use Luxon's [Ad-hoc parsing](https://moment.github.io/luxon/#/parsing?id=ad-hoc-parsing){:target="_blank" .external-link}. To do this, use the `fromFormat()` function, providing the string and a set of [tokens](https://moment.github.io/luxon/#/parsing?id=table-of-tokens){:target="_blank" .external-link} that describe the format.

For example, you have n8n's founding date, 23rd June 2019, formatted as '23-06-2019'. You want to turn this into a Luxon object:
For example, you have n8n's founding date, 23rd June 2019, formatted as `23-06-2019`. You want to turn this into a Luxon object:

=== "Expressions (JavaScript)"

Expand Down Expand Up @@ -166,7 +166,7 @@ For more detailed information and examples, refer to:

In [Get n days from today](#get-n-days-from-today), the example gets the date seven days before the current date, and returns it as `[Object: "yyyy-mm-dd-T00:00:00.000+00:00"]` (for expressions) or `yyyy-mm-dd-T00:00:00.000+00:00` (in the Code node). To make this more readable, you can use Luxon's formatting functions.

For example, you want the field containing the date to be formatted as DD/MM/YYYY, so that on the 23rd June 2019, it returns 23/06/2019.
For example, you want the field containing the date to be formatted as DD/MM/YYYY, so that on the 23rd June 2019, it returns `23/06/2019`.

Check warning on line 169 in docs/code/luxon.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/code/luxon.md#L169

[from-write-good.Passive] 'be formatted' may be passive voice. Use active voice if you can.
Raw output
{"message": "[from-write-good.Passive] 'be formatted' may be passive voice. Use active voice if you can.", "location": {"path": "docs/code/luxon.md", "range": {"start": {"line": 169, "column": 56}}}, "severity": "WARNING"}

This expression gets the date seven days before today, and converts it to the DD/MM/YYYY format.

Expand Down
2 changes: 1 addition & 1 deletion docs/data/data-mapping/data-mapping-ui.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ Given the following data:

n8n displays it in table form like this:

!["Screenshot of a table in the INPUT panel. It includes a top level field named "nested". This field contains nested data, which is indicated in bold."](/_images/data/data-mapping/nested-data.png)
!["Screenshot of a table in the INPUT panel. It includes a top level field named "nested." This field contains nested data, which is indicated in bold."](/_images/data/data-mapping/nested-data.png)

Check warning on line 65 in docs/data/data-mapping/data-mapping-ui.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/data/data-mapping/data-mapping-ui.md#L65

[from-write-good.Passive] 'is indicated' may be passive voice. Use active voice if you can.
Raw output
{"message": "[from-write-good.Passive] 'is indicated' may be passive voice. Use active voice if you can.", "location": {"path": "docs/data/data-mapping/data-mapping-ui.md", "range": {"start": {"line": 65, "column": 131}}}, "severity": "WARNING"}

## Map data in the expressions editor

Expand Down
2 changes: 1 addition & 1 deletion docs/data/data-structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ In n8n, all data passed between nodes is an array of objects. It has the followi
]
```

/// note | Skipping the 'json' key and array syntax
/// note | Skipping the `json` key and array syntax
From 0.166.0 on, when using the Function node or Code node, n8n automatically adds the `json` key if it's missing. It also automatically wraps your items in an array (`[]`) if needed. This is only the case when using the Function or Code nodes. When building your own nodes, you must still make sure the node returns data with the `json` key.

Check warning on line 37 in docs/data/data-structure.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/data/data-structure.md#L37

[from-write-good.Weasel] 'only' is a weasel word!
Raw output
{"message": "[from-write-good.Weasel] 'only' is a weasel word!", "location": {"path": "docs/data/data-structure.md", "range": {"start": {"line": 37, "column": 193}}}, "severity": "WARNING"}
///
## Data item processing
Expand Down
2 changes: 1 addition & 1 deletion docs/embed/deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Due to this, you don't need to use backups except in case of a catastrophic fail

## Backups

n8n recommends creating nightly backups by attaching another container, and copying all data to this second container. In this manner, RAM usage is negligible, and so does'nt impact the amount of users you can place on the server.
n8n recommends creating nightly backups by attaching another container, and copying all data to this second container. In this manner, RAM usage is negligible, and so doesn't impact the amount of users you can place on the server.

Check warning on line 19 in docs/embed/deployment.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/embed/deployment.md#L19

[from-write-good.Weasel] 'nightly' is a weasel word!
Raw output
{"message": "[from-write-good.Weasel] 'nightly' is a weasel word!", "location": {"path": "docs/embed/deployment.md", "range": {"start": {"line": 19, "column": 25}}}, "severity": "WARNING"}

## Restarting

Expand Down
2 changes: 1 addition & 1 deletion docs/flow-logic/waiting.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ Waiting allows you to pause a workflow mid-execution, then resume where the work

Making a workflow wait uses the [Wait](/integrations/builtin/core-nodes/n8n-nodes-base.wait/) node. Refer to the node documentation for usage details.

n8n provides a workflow template with a basice example of [Rate limiting and waiting for external events](https://n8n.io/workflows/1749-rate-limiting-and-waiting-for-external-events/){:target=_blank .external-link}.
n8n provides a workflow template with a basic example of [Rate limiting and waiting for external events](https://n8n.io/workflows/1749-rate-limiting-and-waiting-for-external-events/){:target=_blank .external-link}.
4 changes: 3 additions & 1 deletion docs/hosting/architecture/database-structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ To inspect the n8n database, you can use [DBeaver](https://dbeaver.io){:target=_
## Tables

These are the tables n8n creates during setup.

<!-- vale off -->
### auth_identity

Stores details of external authentication providers when using [SAML](/user-management/saml/).
Expand Down Expand Up @@ -114,3 +114,5 @@ Maps tags to workflows. [tag_entity](#tag_entity) contains tag details.
## Entity Relationship Diagram (ERD)

!["n8n ERD"](/_images/hosting/architecture/n8n-database-diagram.png)

<!-- vale on -->
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ export NODE_FUNCTION_ALLOW_EXTERNAL=moment,lodash

### Timezone

The default timezone is "America/New_York". For instance, the Schedule node uses it to know at what time the workflow should start. To set a different default timezone, set `GENERIC_TIMEZONE` to the appropriate value. For example, if you want to set the timezone to Berlin (Germany):
The default timezone is America/New_York. For instance, the Schedule node uses it to know at what time the workflow should start. To set a different default timezone, set `GENERIC_TIMEZONE` to the appropriate value. For example, if you want to set the timezone to Berlin (Germany):

```bash
export GENERIC_TIMEZONE=Europe/Berlin
Expand Down
4 changes: 2 additions & 2 deletions docs/hosting/environment-variables/environment-variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ By default, n8n uses memory to store binary data. Enterprise users can choose to
## User management SMTP, and two-factor authentication

Refer to [User management](/hosting/user-management-self-hosted/) for more information on setting up user management and emails.

<!-- vale off -->
| Variable | Type | Default | Description |
| :------- | :--- | :------ | :---------- |
| `N8N_EMAIL_MODE` | String | `smtp` | Enable emails. |
Expand All @@ -112,7 +112,7 @@ Refer to [User management](/hosting/user-management-self-hosted/) for more infor
| `N8N_UM_EMAIL_TEMPLATES_PWRESET` | String | - | Full path to your HTML email template. This overrides the default template for password reset emails. |
| `N8N_USER_MANAGEMENT_JWT_SECRET` | String | - | Set a specific JWT secret. By default, n8n generates one on start. |
| `N8N_MFA_ENABLED` | Boolean | `true` | Whether to enable two-factor authentication (true) or disable (false). n8n ignores this if existing users have 2FA enabled. |

<!-- vale on -->

## Endpoints

Expand Down

0 comments on commit bfa1a15

Please sign in to comment.