Skip to content

Commit

Permalink
Merge pull request #2708 from asashour/spelling
Browse files Browse the repository at this point in the history
fix: various spelling mistakes
  • Loading branch information
slvnperron committed Dec 17, 2019
2 parents 459c844 + b1cecc4 commit 8b185a3
Show file tree
Hide file tree
Showing 139 changed files with 438 additions and 563 deletions.
8 changes: 4 additions & 4 deletions docs/guide/docs/advanced/authentication.md
Expand Up @@ -68,7 +68,7 @@ You can clear the list of users by emptying (or deleting) the table `strategy_de

### OAuth2

Some OAuth2 implementations returns a JWT token containing all the user's informations, while some other returns a special token, which must then be used to query the user's informations.
Some OAuth2 implementations returns a JWT token containing all the user's information, while some other returns a special token, which must then be used to query the user's information.

```js
{
Expand All @@ -85,7 +85,7 @@ Some OAuth2 implementations returns a JWT token containing all the user's inform
"clientSecret": "your-client-secret",
"callbackURL": "http://localhost:3000/api/v1/auth/login-callback/oauth2/botpress",
/**
* If the token doesn't contain user informations, set the userInfoURL
* If the token doesn't contain user information, set the userInfoURL
*/
"userInfoURL": "https://example.auth0.com/userinfo",
/**
Expand Down Expand Up @@ -155,7 +155,7 @@ Here is a complete example
#### Prerequisite

- Botpress Pro enabled with a valid license key
- Informations to access the LDAP server
- Information to access the LDAP server

#### Quick Start

Expand Down Expand Up @@ -188,7 +188,7 @@ Here's a summary of the process:

1. User authenticate on your platform
2. Your platform returns a JWT token to the user and configure the webchat
3. The token is sent to Botpress everytime a message is sent
3. The token is sent to Botpress every time a message is sent
4. Botpress validates the token, decrypt the content and makes it available through `event.credentials`

### Prerequisite
Expand Down
10 changes: 5 additions & 5 deletions docs/guide/docs/advanced/configuration.md
Expand Up @@ -11,7 +11,7 @@ On this page, you will learn about the Botpress global configuration, individual

This is the main file used to configure the Botpress server. It will be created automatically when it is missing. Default values should be good when discovering Botpress, but in this page you will learn about the most common configuration you may need to change.

To get more informations about each individual options, check out the [comments on the configuration schema](https://github.com/botpress/botpress/blob/master/src/bp/core/config/botpress.config.ts)
To get more information about each individual options, check out the [comments on the configuration schema](https://github.com/botpress/botpress/blob/master/src/bp/core/config/botpress.config.ts)

## HTTP Server Configuration

Expand Down Expand Up @@ -39,7 +39,7 @@ When you start Botpress from the binary (or using the Docker image), the bot is

There are 4 different levels of logs:

- Debug: display very detailed informations about the bot operations
- Debug: display very detailed information about the bot operations
- Info: gives general information or "good to know" stuff
- Warn: means that something didn't go as expected, but the bot was able to recover
- Error: there was an error that should be addressed
Expand Down Expand Up @@ -115,7 +115,7 @@ Each module has a different set of possible configuration, so we won't go throug

Most of these variables can be set in the configuration file `data/global/botpress.config.json`. Infrastructure configuration (like the database, cluster mode, etc) aren't available in the configuration file, since they are required before the config is loaded.

Botpress supports `.env` files, so you don't have to set them everytime you start the app. Just add the file in the same folder as the executable.
Botpress supports `.env` files, so you don't have to set them every time you start the app. Just add the file in the same folder as the executable.

### Common

Expand All @@ -142,9 +142,9 @@ Botpress supports `.env` files, so you don't have to set them everytime you star
| FAST_TEXT_CLEANUP_MS | The model will be kept in memory until it receives no messages to process for that duration | 60000 |
| REVERSE_PROXY | When enabled, it uses "x-forwarded-for" to fetch the user IP instead of remoteAddress | false |

It is also possible to use environment variables to override module configuration. The pattern is `BP_%MODULE_NAME%_%OPTION_PATH%`, all in upper cases. For example, to define the `confidenceTreshold` option of the module `nlu`, you would use `BP_NLU_CONFIDENCETRESHOLD`. You can list the available environment variales for each modules by enabling the `DEBUG=bp:configuration:modules:*` flag.
It is also possible to use environment variables to override module configuration. The pattern is `BP_%MODULE_NAME%_%OPTION_PATH%`, all in upper cases. For example, to define the `confidenceTreshold` option of the module `nlu`, you would use `BP_NLU_CONFIDENCETRESHOLD`. You can list the available environment variables for each modules by enabling the `DEBUG=bp:configuration:modules:*` flag.

## More Informations
## More Information

- Check out the [database](../tutorials/database) page for details about `DATABASE_URL`
- Check out the [cluster](cluster) page for details about `CLUSTER_ENABLED` and `REDIS_URL`
6 changes: 3 additions & 3 deletions docs/guide/docs/advanced/custom-module.md
Expand Up @@ -140,7 +140,7 @@ const onServerReady = async (bp: SDK) => {

### onBotMount && onBotUnmount

These methods are called everytime a bot is started or stopped (either when starting Botpress or when creating or deleting a bot).
These methods are called every time a bot is started or stopped (either when starting Botpress or when creating or deleting a bot).

Example:

Expand Down Expand Up @@ -202,7 +202,7 @@ const botTemplates: sdk.BotTemplate[] = [

The definition is used by Botpress to setup your module.

Please refer to the [API Reference](https://botpress.io/reference/) for informations on the possible options
Please refer to the [API Reference](https://botpress.io/reference/) for information on the possible options

The only way to communicate with modules (or between them) is by using the API endpoint.
All modules are isolated and receives their own instance of `bp`
Expand Down Expand Up @@ -485,7 +485,7 @@ const entryPoint: sdk.ModuleEntryPoint = {

## Register Actions

Modules can register new actions that will be available on the flow editor. Please check out the [Custom Code](../main/code) section for more informations about Actions.
Modules can register new actions that will be available on the flow editor. Please check out the [Custom Code](../main/code) section for more information about Actions.
Those actions must be deployed to the `data/global/actions` folder to be recognized by Botpress. Here is how to do that:

1. Create a folder named `actions` in `src`
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/docs/advanced/monitoring.md
Expand Up @@ -122,7 +122,7 @@ When an incident is resolved, no other incident of the same nature (same name /

### Incident & Hook

Now that you have some incident rules, how do you get alerted when something happens? This is where hooks comes in handy. Everytime an incident is opened or resolved, Botpress will call the hook `on_incident_status_changed` with the incident as an object. When the property `endTime` is not defined, it means that the incident was opened. When it is set, the incident is resolved.
Now that you have some incident rules, how do you get alerted when something happens? This is where hooks comes in handy. Every time an incident is opened or resolved, Botpress will call the hook `on_incident_status_changed` with the incident as an object. When the property `endTime` is not defined, it means that the incident was opened. When it is set, the incident is resolved.

Here's an example of `data/global/hooks/on_incident_status_changed/alert.js`

Expand Down
2 changes: 1 addition & 1 deletion docs/guide/docs/channels/teams.md
Expand Up @@ -36,7 +36,7 @@ These instructions will guide you through any steps required to be up and runnin

### 2. Create your bot

1. Navigate to the [Bot Framework Registration Page](https://dev.botframework.com/bots/new) and fill the required informations:
1. Navigate to the [Bot Framework Registration Page](https://dev.botframework.com/bots/new) and fill the required information:

- Display name
- Bot handle
Expand Down
12 changes: 6 additions & 6 deletions docs/guide/docs/channels/web.md
Expand Up @@ -33,14 +33,14 @@ There is an example included in the default botpress installation at `http://loc

## Bot Information page

The information page displays informations like the website url, a phone number, an e-mail contact address, and links to terms of services and privacy policies. You can also include a cover picture and an avatar for your bot.
The information page displays information like the website url, a phone number, an e-mail contact address, and links to terms of services and privacy policies. You can also include a cover picture and an avatar for your bot.

![Bot Info Page](assets/webchat-bot-info.png)

How to set up the information page:

1. On the Admin UI, click on the link `Config` next to the name of the bot you want to change.
2. Edit your bot informations in the `More details` and `Pictures` sections.
2. Edit your bot information in the `More details` and `Pictures` sections.
3. Edit the file `data/global/config/channel-web.json` and set `showBotInfoPage` to `true` **\*\***
4. Refresh your browser.

Expand Down Expand Up @@ -105,7 +105,7 @@ The method `window.botpressWebChat.configure` allows you to change the configura

## Advanced Customization

Every message sent by the bot to a user consist of a `payload`. That payload has a `type` property, that tells the webchat how the other informations included on that payload should be rendered on screen.
Every message sent by the bot to a user consist of a `payload`. That payload has a `type` property, that tells the webchat how the other information included on that payload should be rendered on screen.

There are different ways to send that payload to the user:

Expand All @@ -114,11 +114,11 @@ There are different ways to send that payload to the user:

There are multiple types already built in Botpress (they are listed at the bottom of this page), but if you require more advanced components, you can create them easily.

### Prevent storing sensitive informations
### Prevent storing sensitive information

By default, the complete payload is stored in the database, so the information is not lost when the user refreshes the page. On some occasion, however, we may want to hide some properties deemed "sensitive" (ex: password, credit card, etc..).

To remove those informations, there is a special property that you need to set: `sensitive`. Here's an example:
To remove this information, there is a special property that you need to set: `sensitive`. Here's an example:

```js
const payload = {
Expand Down Expand Up @@ -167,7 +167,7 @@ payload: {

### What can I do in my component ?

There are a couple of properties that are passed down to your custom component. These can be used to customize the displayed informations, and/or to pursue interactions.
There are a couple of properties that are passed down to your custom component. These can be used to customize the displayed information, and/or to pursue interactions.

| Property | Description |
| --------------- | ------------------------------------------------------------------------------ |
Expand Down
6 changes: 3 additions & 3 deletions docs/guide/docs/main/code.md
Expand Up @@ -92,7 +92,7 @@ session.store = [{ id: 1, id: 2, id: 3 }]

The only way to register new actions is to add your javascript code in a `.js` file and put them in the folder `data/global/actions`. There is no way to programmatically add new ones during runtime.

There are already a [couple of actions](https://github.com/botpress/botpress/tree/master/modules/builtin/src/actions) that you can use to get some inspiration. We use JavaDoc comments to display meaningful informations (name, description, arguments, default values) on the dialog flow editor. It is possible to keep an action hidden in the flow editor by adding the flag `@hidden true` in the javadoc.
There are already a [couple of actions](https://github.com/botpress/botpress/tree/master/modules/builtin/src/actions) that you can use to get some inspiration. We use JavaDoc comments to display meaningful information (name, description, arguments, default values) on the dialog flow editor. It is possible to keep an action hidden in the flow editor by adding the flag `@hidden true` in the javadoc.

## Hooks

Expand All @@ -114,15 +114,15 @@ Parameters: `bp`

### After Bot Mount

This event is called everytime a bot is mounted, be it when the server is starting up or when new bots are added at runtime.
This event is called every time a bot is mounted, be it when the server is starting up or when new bots are added at runtime.

Location: `data/global/hooks/after_bot_mount`

Parameters: `bp`, `botId`

### After Bot Unmount

This event is called everytime a bot is unmounted. This is usually to do cleanup when a bot is deleted.
This event is called every time a bot is unmounted. This is usually to do cleanup when a bot is deleted.

Location: `data/global/hooks/after_bot_unmount`

Expand Down
4 changes: 2 additions & 2 deletions docs/guide/docs/main/memory.md
Expand Up @@ -102,13 +102,13 @@ You can consume a memory action just like any other action from the Botpress Flo

Variables set using the `user` namespace will be saved as attributes for the user. This means that those attributes will always follow the user, not notwithstanding conversations or time period.

When a user sends a message to the bot, the first middleware is tasked with loading that user's informations. After everything is processed, any changes to the `user` object will be persisted to the database.
When a user sends a message to the bot, the first middleware is tasked with loading that user's information. After everything is processed, any changes to the `user` object will be persisted to the database.

This means that you can alter the `user` object using middlwares and actions, and it will be saved at the end.

#### User Memory - Data Retention

Since privacy is an important matter, there is a built-in system that makes it dead-easy to set retention periods for different type of informations. You could have, for example a policy that says `email expires after 2 months` or `remember user's mood for 1 day`. Whenever the user's attribute is changed, the expiration policy is updated.
Since privacy is an important matter, there is a built-in system that makes it dead-easy to set retention periods for different type of information. You could have, for example a policy that says `email expires after 2 months` or `remember user's mood for 1 day`. Whenever the user's attribute is changed, the expiration policy is updated.

Here's how it could be configured:

Expand Down
14 changes: 7 additions & 7 deletions docs/guide/docs/main/nlu.md
Expand Up @@ -58,7 +58,7 @@ Here's an example of the structure of an incoming event processed by Botpress Na
"flags": {},
"nlu": { // <<<<------
"language": "en", // language identified
"intent": { // most likely intent, assuming confidence is within config treshold
"intent": { // most likely intent, assuming confidence is within config threshold
"name": "hello",
"confidence": 1
},
Expand Down Expand Up @@ -205,19 +205,19 @@ An example of placeholder entity would be : Please tell **Sarah** that **she's l

### Custom Entities

As of today we provide 2 types of custom entites: [pattern](#pattern-extraction) and [list](#list-extraction) entitites. To define a custom entity, head to the **Entity section** of the Understanding Module in your botpress studio side bar. From there you'll be able to define your custom entities that will be available for any input message treated by your chatbot. Go ahead and click on **create new entity**
As of today we provide 2 types of custom entities: [pattern](#pattern-extraction) and [list](#list-extraction) entities. To define a custom entity, head to the **Entity section** of the Understanding Module in your botpress studio side bar. From there you'll be able to define your custom entities that will be available for any input message treated by your chatbot. Go ahead and click on **create new entity**

<img src="/docs/assets/nlu-create-entity.png">

### Sensitive Informations
### Sensitive Information

Communication between users and bots are stored in the database, which means that sometimes personal informations (eg: credit card) may be persisted as well. To avoid that problem, it is possible to tell Botpress that certain entities are not to be persisted. When creating or editing an Entity, there is a small checkbox located in the upper right corner labeled `sensitive`.
Communication between users and bots are stored in the database, which means that sometimes personal information (eg: credit card) may be persisted as well. To avoid that problem, it is possible to tell Botpress that certain entities are not to be persisted. When creating or editing an Entity, there is a small checkbox located in the upper right corner labeled `sensitive`.

When checked, the information will still be displayed in the chat window, but the sensitive information will be replaced by `*****` before being stored. The original value is still available from `event.nlu.entities`

#### Pattern extraction

Once you've created a pattern entity, Botpress Native NLU will perform a regex extraction on each incomming message and add it to `event.nlu.entities`.
Once you've created a pattern entity, Botpress Native NLU will perform a regex extraction on each incoming message and add it to `event.nlu.entities`.

##### Example :

Expand Down Expand Up @@ -251,7 +251,7 @@ Extraction will go like:

#### List extraction

List extraction will behave in a similar way. The major addition is that for your entity definition, you'll be able to add different **occurences** of your entity with corresponding synonyms.
List extraction will behave in a similar way. The major addition is that for your entity definition, you'll be able to add different **occurrences** of your entity with corresponding synonyms.

Let's take **Airport Codes** as an example:

Expand Down Expand Up @@ -345,7 +345,7 @@ Slot filling is the process of gathering information required by an intent. This

## Language Server

The language server provides additional informations about words, which allows your bot to understand words with a similar meaning even if you didn't specifically taught it about it. By default, your Botpress server will query one of our language server for that purpose. You can also choose to host your own server if you would like to keep everything on your premise. Head over to the [Hosting](../advanced/hosting#running-your-own-language-server) page for more details.
The language server provides additional information about words, which allows your bot to understand words with a similar meaning even if you didn't specifically taught it about it. By default, your Botpress server will query one of our language server for that purpose. You can also choose to host your own server if you would like to keep everything on your premise. Head over to the [Hosting](../advanced/hosting#running-your-own-language-server) page for more details.

## External NLU Providers

Expand Down
2 changes: 1 addition & 1 deletion docs/guide/docs/releases/migrate.md
Expand Up @@ -75,7 +75,7 @@ my-module/views/lite/index.jsx
This change implied modifications on how modules are packaged. Please clear the `node_modules` folder of every module, then run `yarn build`
For more informations see: [Module Views](../advanced/custom-module#views)
For more information see: [Module Views](../advanced/custom-module#views)
## Migration from 11.3 to 11.4
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/docs/tutorials/database.md
Expand Up @@ -31,4 +31,4 @@ While using Postgres, you can configure the Connection Pools by using the `DATAB

Please make sure you are using Postgres 9.5 or higher.

If you don't want to type those variables each time you start Botpress, we also supports `.env` files. Check out our [configuration section](../advanced/configuration) for more informations about that
If you don't want to type those variables each time you start Botpress, we also supports `.env` files. Check out our [configuration section](../advanced/configuration) for more information about that

0 comments on commit 8b185a3

Please sign in to comment.