Merge pull request RasaHQ#5210 from RasaHQ/rename_running_server_rebase

Rename Running the Server to Configuring the HTTP API

Author: akelad

changelog/5210.doc.rst

@@ -0,0 +1 @@
+Renamed "Running the Server" page to "Configuring the HTTP API"

docs/index.rst

@@ -30,7 +30,7 @@ Understand messages, hold conversations, and connect to messaging channels and A
    user-guide/messaging-and-voice-channels
    user-guide/evaluating-models
    user-guide/validate-files
-   user-guide/running-the-server
+   user-guide/configuring-http-api
    user-guide/how-to-deploy
    user-guide/cloud-storage
 

docs/user-guide/command-line-interface.rst

@@ -23,7 +23,7 @@ Command                    Effect
 ``rasa train``             Trains a model using your NLU data and stories, saves trained model in ``./models``.
 ``rasa interactive``       Starts an interactive learning session to create new training data by chatting.
 ``rasa shell``             Loads your trained model and lets you talk to your assistant on the command line.
-``rasa run``               Starts a Rasa server with your trained model. See the :ref:`running-the-server` docs for details.
+``rasa run``               Starts a Rasa server with your trained model. See the :ref:`configuring-http-api` docs for details.
 ``rasa run actions``       Starts an action server using the Rasa SDK.
 ``rasa visualize``         Visualizes stories.
 ``rasa test``              Tests a trained Rasa model using your test NLU data and stories.
@@ -161,7 +161,7 @@ The following arguments can be used to configure your Rasa server:
 
 .. program-output:: rasa run --help
 
-For more information on the additional parameters, see :ref:`running-the-server`.
+For more information on the additional parameters, see :ref:`configuring-http-api`.
 See the Rasa :ref:`http-api` docs for detailed documentation of all the endpoints.
 
 .. _run-action-server:

docs/user-guide/running-the-server.rst renamed to docs/user-guide/configuring-http-api.rst

@@ -1,18 +1,24 @@
 :desc: Find out how to use Rasa's HTTP API to integrate Rasa
        with your backend components.
 
-.. _running-the-server:
+.. _configuring-http-api:
 
-Running the Server
-==================
+Configuring the HTTP API
+========================
 
 .. edit-link::
 
 .. contents::
    :local:
 
-Running the HTTP server
------------------------
+Using Rasa's HTTP API
+---------------------
+
+.. note:: 
+
+    The instructions below are relevant for configuring how a model is run
+    within a Docker container or for testing the HTTP API locally. If you
+    want to deploy your assistant to users, see :ref:`deploying-your-rasa-assistant`.
 
 You can run a simple HTTP server that handles requests using your
 trained Rasa model with:

rasa/cli/initial_project/endpoints.yml

@@ -1,7 +1,7 @@
 # This file contains the different endpoints your bot can use.
 
 # Server where the models are pulled from.
-# https://rasa.com/docs/rasa/user-guide/running-the-server/#fetching-models-from-a-server/
+# https://rasa.com/docs/rasa/user-guide/configuring-http-api/#fetching-models-from-a-server/
 
 #models:
 #  url: http://my-server.com/models/default_core@latest

rasa/cli/run.py

@@ -123,6 +123,6 @@ def run(args: argparse.Namespace):
         "3. Train a model before running the server using `rasa train` and "
         "use '--model' to provide the model path.\n"
         "For more information check {}.".format(
-            DOCS_BASE_URL + "/user-guide/running-the-server/"
+            DOCS_BASE_URL + "/user-guide/configuring-http-api/"
         )
     )

rasa/server.py

@@ -102,7 +102,7 @@ def decorated(*args, **kwargs):
                     "Conflict",
                     "No agent loaded. To continue processing, a "
                     "model of a trained agent needs to be loaded.",
-                    help_url=_docs("/user-guide/running-the-server/"),
+                    help_url=_docs("/user-guide/configuring-http-api/"),
                 )
 
             return f(*args, **kwargs)
@@ -168,7 +168,7 @@ async def decorated(request: Request, *args: Any, **kwargs: Any) -> Any:
                     "NotAuthorized",
                     "User has insufficient permissions.",
                     help_url=_docs(
-                        "/user-guide/running-the-server/#security-considerations"
+                        "/user-guide/configuring-http-api/#security-considerations"
                     ),
                 )
             elif token is None and app.config.get("USE_JWT") is None:
@@ -182,7 +182,7 @@ async def decorated(request: Request, *args: Any, **kwargs: Any) -> Any:
                 "NotAuthenticated",
                 "User is not authenticated.",
                 help_url=_docs(
-                    "/user-guide/running-the-server/#security-considerations"
+                    "/user-guide/configuring-http-api/#security-considerations"
                 ),
             )