Merge pull request RasaHQ#11591 from RasaHQ/pipeline-docs

[WIP] Plus docs

.gitignore

@@ -88,4 +88,4 @@ rasa/keys
 /results/
 # Local Netlify folder
 .netlify
-*.code-workspace
+rasa.code-workspace

CHANGELOG.mdx

@@ -739,7 +739,7 @@ Yanked.
 ### Improved Documentation
 - [#9780](https://github.com/rasahq/rasa/issues/9780): Removing the experimental feature warning for `conditional response variations` from the Rasa docs.
   The behaviour of the feature remains unchanged.
-- [#9782](https://github.com/rasahq/rasa/issues/9782): Updates [quick install documentation](installation.mdx#quick-installation) with optional venv step, better pip install instructions, & M1 warning
+- [#9782](https://github.com/rasahq/rasa/issues/9782): Updates [quick install documentation](./installation/installing-rasa-open-source.mdx) with optional venv step, better pip install instructions, & M1 warning
 
 
 ## [2.8.7] - 2021-09-20

changelog/11571.doc.md

@@ -0,0 +1 @@
+Rasa SDK documentation lives now in Rasa Open Source documentation under the _Rasa SDK_ category.

docs/docs/action-server/actions.mdx

@@ -4,9 +4,9 @@ sidebar_label: Actions
 title: Actions
 ---
 
-When a Rasa Open Source assistant calls a custom action, it sends a request to the action server. 
-Rasa Open Source only knows about whatever events and responses come back in the request response;
-it's up to the action server to call the correct code based on the action name that Rasa Open Source provides.
+When a Rasa assistant calls a custom action, it sends a request to the action server. 
+Rasa only knows about whatever events and responses come back in the request response;
+it's up to the action server to call the correct code based on the action name that Rasa provides.
 
 To better understand what happens when Rasa calls a custom action, consider 
 the following example:
@@ -192,7 +192,7 @@ of the conversation.
 
 ### `version`
 
-This is the version of the Rasa Open Source server. A custom action
+This is the version of the Rasa server. A custom action
 is also unlikely to refer to this, although you might use it in a 
 verification step if your action server
 is only compatible with certain Rasa versions.
@@ -230,7 +230,7 @@ events, the order won't matter, but with other event types it can.
 ### `responses`
 
 A response can be of any of the response types described in the
-[ documentation on rich responses](../responses.mdx#rich-responses).
+[documentation on rich responses](../responses.mdx#rich-responses).
 See the response sample of the [API spec](/pages/action-server-api) for the expected formats. 
 
 In the example case, you want to send the user a message with the weather forecast. 

docs/docs/action-server/deploy-action-server.mdx

@@ -16,7 +16,7 @@ repository if you discover bugs or have suggestions for improvements.
 
 :::
 
-In the sections below you can learn how to deploy Rasa Action Server by using helm, and how to connect an Action Server deployment to a Rasa Open Source deployment.
+In the sections below you can learn how to deploy Rasa Action Server by using helm, and how to connect an Action Server deployment to a Rasa deployment.
 
 ## Installation Requirements
 
@@ -211,14 +211,14 @@ on:
 jobs:
   build_and_deploy:
     runs-on: ubuntu-latest
-    name: Build Action Server image and upgrade Rasa Enterprise deployment
+    name: Build Action Server image and upgrade Rasa X/Enterprise deployment
     steps:
     - name: Checkout repository
       uses: actions/checkout@v2
 
     - id: action_server
-      name: Build an action server with a custom actions
-      uses: RasaHQ/action-server-gha@master
+      name: Build an action server with custom actions
+      uses: RasaHQ/action-server-gha@main
       # Full list of parameters: https://github.com/RasaHQ/action-server-gha/tree/master#input-arguments
       with:
         docker_image_name: 'account_username/repository_name'
@@ -235,7 +235,7 @@ jobs:
 
 4. Now, you can use your new brand docker image.
 
-5. You can also extend your workflow, so that you do not have to manually update your Rasa Enterprise deployment. The example below shows how to extend your workflow with an additional step that updates a Rasa Enterprise Helm Chart deployment.
+5. You can also extend your workflow, so that you do not have to manually update your Rasa X/Enterprise deployment. The example below shows how to extend your workflow with an additional step that updates a Rasa X/Enterprise Helm Chart deployment.
 
 ```yaml
 on:
@@ -246,7 +246,7 @@ on:
 jobs:
   build_and_deploy:
     runs-on: ubuntu-latest
-    name: Build Action Server image and upgrade Rasa Enterprise deployment
+    name: Build Action Server image and upgrade Rasa X/Enterprise deployment
     steps:
     [..]
 
@@ -352,12 +352,12 @@ helm upgrade --namespace <namespace> --reuse-values \
   -f values.yaml <release name> rasa/rasa-action-server
 ```
 
-## 2. Connect Rasa Action Server to a Rasa Open Source deployment
+## 2. Connect Rasa Action Server to a Rasa deployment
 
 If you have deployed your assistant using the Rasa Helm chart, and you have deployed your Rasa Action Server as well.
 Now it's time to connect them together. You can do this easily by following the steps:
 
-a. Create a `rasa-values.yaml` file which will include configuration for the Rasa Open Source deployment.
+a. Create a `rasa-values.yaml` file which will include configuration for the Rasa deployment.
 
   ```yaml
   # rasa-values.yaml
@@ -369,10 +369,10 @@ a. Create a `rasa-values.yaml` file which will include configuration for the Ras
       url: "http://rasa-action-server/webhook"
   ```
 
-  The configuration above tells Rasa Open Source which Rasa Action Server to use. In the example the `http://rasa-action-server/webhook` URL is used,
-  the URL indicates that Rasa Action Server is deployed with release name `rasa-action-server`, and is located in the same namespace as Rasa Open Source server deployment.
+  The configuration above tells Rasa which Rasa Action Server to use. In the example the `http://rasa-action-server/webhook` URL is used,
+  the URL indicates that Rasa Action Server is deployed with release name `rasa-action-server`, and is located in the same namespace as Rasa server deployment.
 
-b. Upgrade the Rasa Open Source deployment
+b. Upgrade the Rasa deployment
 
   ```text
   helm upgrade -n <namespace> --reuse-values -f rasa-values.yaml \

docs/docs/action-server/events.mdx

@@ -46,7 +46,7 @@ to set any slot not auto-filled by an entity.
 * `value`: Value to set the slot to. The datatype must match the [type](../domain.mdx#slot-types)
    of the slot
 
-**Rasa Open Source Class**: `rasa.core.events.SlotSet`
+**Rasa Class**: `rasa.core.events.SlotSet`
 
 
 ### `reset_slots`
@@ -63,7 +63,7 @@ Resets all slots on the tracker to `null`.
 }
 ```
 
-**Rasa Open Source Class**: `rasa.core.events.AllSlotsReset`
+**Rasa Class**: `rasa.core.events.AllSlotsReset`
 
 
 ### `reminder`
@@ -93,7 +93,7 @@ Schedules an intent to be triggered at a certain time in the future.
 * `name`: ID of the reminder. If there are multiple reminders with the same id only the last will be run.
 * `kill_on_user_msg`: Whether a user message before the trigger time will abort the reminder
 
-**Rasa Open Source Class**: `rasa.core.events.ReminderScheduled`
+**Rasa Class**: `rasa.core.events.ReminderScheduled`
 
 
 ### `cancel_reminder`
@@ -127,7 +127,7 @@ All reminders which match the supplied parameters will be cancelled.
 * `name`: ID of the reminder.
 
 
-**Rasa Open Source Class**: `rasa.core.events.ReminderCancelled`
+**Rasa Class**: `rasa.core.events.ReminderCancelled`
 
 ### `pause`
 
@@ -143,7 +143,7 @@ Stops the bot from responding to user messages. The conversation will remain pau
 }
 ```
 
-**Rasa Open Source Class**: `rasa.core.events.ConversationPaused`
+**Rasa Class**: `rasa.core.events.ConversationPaused`
 
 ### `resume`
 
@@ -160,7 +160,7 @@ Resume a previously paused conversation. Once this event is added to the tracker
 ```
 
 
-**Rasa Open Source Class**: `rasa.core.events.ConversationResumed`
+**Rasa Class**: `rasa.core.events.ConversationResumed`
 
 ### `followup`
 
@@ -182,7 +182,7 @@ Force a follow up action, bypassing action prediction.
 * `name`: The name of the follow up action that will be executed.
 
 
-**Rasa Open Source Class**: `rasa.core.events.FollowupAction`
+**Rasa Class**: `rasa.core.events.FollowupAction`
 
 ### `rewind`
 
@@ -198,7 +198,7 @@ Reverts all side effects of the last user message and removes the last `user` ev
 }
 ```
 
-**Rasa Open Source Class**: `rasa.core.events.UserUtteranceReverted`
+**Rasa Class**: `rasa.core.events.UserUtteranceReverted`
 
 
 ### `undo`
@@ -215,7 +215,7 @@ Undoes all side effects of the last bot action and removes the last bot action f
 }
 ```
 
-**Rasa Open Source Class**: `rasa.core.events.ActionReverted`
+**Rasa Class**: `rasa.core.events.ActionReverted`
 
 
 
@@ -237,7 +237,7 @@ Resets the tracker. After a `restart` event, there will be no conversation histo
 ```
 
 
-**Rasa Open Source Class**: `rasa.core.events.Restarted`
+**Rasa Class**: `rasa.core.events.Restarted`
 
 
 ### `session_started`
@@ -259,7 +259,7 @@ Restarting a conversation with [`restart`](#restart) event **does not** automati
 }
 ```
 
-**Rasa Open Source Class**: `rasa.core.events.SessionStarted`
+**Rasa Class**: `rasa.core.events.SessionStarted`
 
 
 ### `user`
@@ -295,7 +295,7 @@ This event is not usually returned by a custom action.
 * `parse_data`: Parsed data of user message. This is ordinarily filled by NLU.
 * `metadata`: Arbitrary metadata that comes with the user message
 
-**Rasa Open Source Class**: `rasa.core.events.UserUttered`
+**Rasa Class**: `rasa.core.events.UserUttered`
 
 ### `bot`
 
@@ -324,7 +324,7 @@ This event is not usually returned explicitly by a custom action; `responses` wo
 * `text`: The text the bot sends to the user
 * `data`: Any non-text elements of the bot response. The structure of `data` matches that of `responses` given in the [API spec](/pages/action-server-api).
 
-**Rasa Open Source Class**: `rasa.core.events.BotUttered`
+**Rasa Class**: `rasa.core.events.BotUttered`
 
 
 ### `action`
@@ -348,5 +348,5 @@ This event is not usually returned explicitly by a custom action.
 
 * `name`: Name of the action that was called
 
-**Rasa Open Source Class**: `rasa.core.events.ActionExecuted`
+**Rasa Class**: `rasa.core.events.ActionExecuted`
 

docs/docs/action-server/sdk-events.mdx

@@ -14,7 +14,7 @@ The side effects of events and their underlying
 payloads are identical regardless of whether you use `rasa_sdk` or another action
 server.
 For details about the side effects of an event, its underlying
- payload and the class in Rasa Open Source it is translated to
+ payload and the class in Rasa it is translated to
 see the [documentation for events for all action servers](events.mdx)
 (also linked to in each section).
 

docs/docs/arch-overview.mdx

@@ -2,12 +2,12 @@
 id: arch-overview
 sidebar_label: Overview
 title: Rasa Architecture Overview
-abstract: Rasa Open Source has a scalable architecture. Read about the key components of the Rasa Open Source architecture.
+abstract: Rasa has a scalable architecture. Read about the key components of the Rasa architecture.
 ---
 import useBaseUrl from '@docusaurus/useBaseUrl';
 
 
-The diagram below provides an overview of the Rasa Open Source architecture. The two primary
+The diagram below provides an overview of the Rasa architecture. The two primary
 components are Natural Language Understanding (NLU) and dialogue management.
 
 NLU is the part that handles intent classification, entity extraction, and response retrieval.

docs/docs/architecture.mdx

@@ -13,7 +13,7 @@ responds to a message:
 
 import archImage from './architecture-img.png';
 
-<Image img={archImage} caption="Rasa Open Source architecture" alt="A visual representation of the steps that follow."/>
+<Image img={archImage} caption="Rasa architecture" alt="A visual representation of the steps that follow."/>
 
 The steps are:
 

docs/docs/chitchat-faqs.mdx

@@ -16,8 +16,8 @@ with the answer being independent of anything the user has said previously.
 <ChatBotText>My name is Sara!</ChatBotText>
 <ChatUserText>Which languages can I build assistants in?</ChatUserText>
 <ChatBotText>You can use Rasa to build assistants in any language you want!</ChatBotText>
-<ChatUserText>What’s Rasa Enterprise?</ChatUserText>
-<ChatBotText>Rasa Enterprise is a tool to learn from real conversations and improve your assistant.</ChatBotText>
+<ChatUserText>What’s Rasa X/Enterprise?</ChatUserText>
+<ChatBotText>Rasa X/Enterprise is a tool to learn from real conversations and improve your assistant.</ChatBotText>
 </Chat>
 
 

docs/docs/command-line-interface.mdx

@@ -33,7 +33,7 @@ Rasa produces log messages at several different levels (eg. warning, info, error
 
 In addition to CLI arguments, several environment variables allow you to control log output in a more granular way. With these environment variables, you can configure log levels for messages created by external libraries such as Matplotlib, Pika, and Kafka. These variables follow [standard logging level in Python](https://docs.python.org/3/library/logging.html#logging-levels). Currently, following environment variables are supported:
 
-1. LOG_LEVEL_LIBRARIES: This is the general environment variable to configure log level for the main libraries Rasa Open Source uses. It covers Tensorflow, `asyncio`, APScheduler, SocketIO, Matplotlib, RabbitMQ, Kafka.
+1. LOG_LEVEL_LIBRARIES: This is the general environment variable to configure log level for the main libraries Rasa uses. It covers Tensorflow, `asyncio`, APScheduler, SocketIO, Matplotlib, RabbitMQ, Kafka.
 2. LOG_LEVEL_MATPLOTLIB: This is the specialized environment variable to configure log level only for Matplotlib.
 3. LOG_LEVEL_RABBITMQ: This is the specialized environment variable to configure log level only for AMQP libraries, at the moment it handles log levels from `aio_pika` and `aiormq`.
 4. LOG_LEVEL_KAFKA: This is the specialized environment variable to configure log level only for kafka.
@@ -95,7 +95,7 @@ without any additional configuration.
 
 ## rasa train
 
-The following command trains a Rasa Open Source model:
+The following command trains a Rasa model:
 
 ```bash
 rasa train
@@ -503,9 +503,9 @@ should be published:
 ```text [rasa export --help]
 ```
 
-:::tip Import conversations into Rasa Enterprise
-This command is most commonly used to import old conversations into Rasa Enterprise to annotate
-them. Read more about [importing conversations into Rasa Enterprise](https://rasa.com/docs/rasa-enterprise/installation-and-setup/deploy#1-import-existing-conversations-from-rasa-open-source).
+:::tip Import conversations into Rasa X/Enterprise
+This command is most commonly used to import old conversations into Rasa X/Enterprise to annotate
+them. Read more about [importing conversations into Rasa X/Enterprise](https://rasa.com/docs/rasa-enterprise/installation-and-setup/deploy#1-import-existing-conversations-from-rasa-open-source).
 :::
 
 ## rasa evaluate markers

docs/docs/compatibility-matrix.mdx

@@ -0,0 +1,19 @@
+---
+id: compatibility-matrix
+sidebar_label: Compatibility Matrix
+title: Compatibility Matrix
+description: |
+  Information about compatibility between Rasa Pro Services and Rasa Plus.
+---
+
+
+When choosing a version of Rasa Pro Services to [deploy](./deploy/deploy-rasa-pro-services.mdx), you can refer to the
+table below to see which one is compatible with your installation of Rasa Plus.
+
+Rasa Pro Services version is independent of Rasa Plus version, except that they share the same major version number.
+
+
+| Rasa Pro Services | Rasa Plus |
+|-------------------|-----------|
+| 3.0.x | 3.3.x |
+

docs/docs/components.mdx

@@ -56,7 +56,7 @@ word vectors in your pipeline.
   ```
 
   For more information where to get that file from, head over to
-  [installing MITIE](./installation.mdx#dependencies-for-mitie).
+  [installing MITIE](./installation/installing-rasa-open-source.mdx#dependencies-for-mitie).
 
 
   You can also pre-train your own word vectors from a language corpus using MITIE. To do so:
@@ -124,7 +124,7 @@ word vectors in your pipeline.
   ```
 
   For more information on how to download the spaCy models, head over to
-  [installing SpaCy](./installation.mdx#dependencies-for-spacy).
+  [installing SpaCy](./installation/installing-rasa-open-source.mdx#dependencies-for-spacy).
 
   In addition to SpaCy's pretrained language models, you can also use this component to
   attach spaCy models that you've trained yourself.
@@ -493,10 +493,10 @@ Note: The `feature-dimension` for sequence and sentence features does not have t
   :::
 
   :::note
-  To use `ConveRTFeaturizer`, install Rasa Open Source with `pip3 install rasa[convert]`.
+  To use `ConveRTFeaturizer`, install Rasa with `pip3 install rasa[convert]`.
 
   Note that this component cannot currently run on MacOS using M1 / M2 architecture. 
-  More information on this limitation is available [here](./installation.mdx#m1--m2-apple-silicon-limitations).
+  More information on this limitation is available [here](./installation/environment-set-up.mdx#m1--m2-apple-silicon-limitations).
   :::
 
 
@@ -2877,7 +2877,7 @@ See [starspace paper](https://arxiv.org/abs/1709.03856) for details.
 ## Custom Components
 
 :::info New in 3.0
-Rasa Open Source 3.0 unified the implementation of NLU components and policies.
+Rasa 3.0 unified the implementation of NLU components and policies.
 This requires changes to custom components written for earlier versions of Rasa Open
 Source. Please see the
 [migration guide](migration-guide.mdx#custom-policies-and-custom-components) for a