docs: add Info on the config page (#46)

* Add Info on the config page

* docs: clean up warnings

---------

Co-authored-by: Andy Méry <amery@scaleway.com>

Author: lucasscw

docs/source/configuring.rst

@@ -4,35 +4,69 @@ Configuring
 Namespace
 ---------
 
-The first step is to create a Serverless instance, which maps to a function namespace.
+The first step is to create a Serverless instance, which maps to a function namespace. All your functions will be deployed to this namespace.
 When deploying, the `scw-serverless` CLI will look for a Serverless instance in the global scope.
 
 .. code-block:: python
 
    import os
    from scw_serverless import Serverless
 
-   app = Serverless("my-namespace", secret={
-      "SCW_SECRET_KEY": os.environ["SCW_SECRET_KEY"]
+   app = Serverless(
+      "my-namespace",
+      env={
+         "NON_CONFIDENTIAL_PARAMETERS": "My Param"
+      },
+      secret={
+         "SCW_SECRET_KEY": os.environ["SCW_SECRET_KEY"],
+         "MY_SECRET_KEY": os.environ["MY_SECRET_KEY"]
+      },
    })
 
 .. autoclass:: scw_serverless.app.Serverless
-   :members: func, schedule, get
+   :members: func
 
 Functions
 ---------
 
-To configure your serverless functions, you can provide keyword arguments to the decorators.
+To configure your serverless functions, you can provide keyword arguments to the decorators. The Function name that will appear in Scaleway console will be the name of your function's handler.
 
 .. autoclass:: scw_serverless.config.function.FunctionKwargs
 
+.. code-block:: python
+
+   app = Serverless("example")
+   app.func(
+      privacy="public",
+      env={"key": "value"},
+      secret={"key": "value"},
+      min_scale= 0,
+      max_scale= 5,
+      memory_limit= 256,
+      timeout= 300,
+      description= "Lores Ipsum",
+      http_option= "enabled", # https only
+   )
+   def handler(event, context):
+      # Do Things
+      return {"body": "Hello World"}
+
 Triggers
 --------
 
-By default, Scaleway Functions are given an http endpoint that can be called to execute your function.
-In addition, you can set up additionnal triggers that will run your function on specific occasions.
+By default, Scaleway Functions are given an HTTP endpoint that can be called to execute your function.
+In addition, you can set up additional triggers that will run your function on specific occasions.
 
 Cron triggers
 ^^^^^^^^^^^^^
 
-.. autoclass:: scw_serverless.triggers.cron.CronTrigger
+To create a function that will run periodically, you can use the `schedule` decorator.
+If do not want your function to be publicly available, set the privacy to `private`.
+
+.. code-block:: python
+
+   app.schedule("0 8 * * *", privacy="private")
+   def handler(event, context):
+      ...
+
+.. autofunction:: scw_serverless.app.Serverless.schedule

docs/source/examples.rst

@@ -7,7 +7,7 @@ To showcase the framework and how it can used to deploy serverless applications,
     Simple function to get you started.
 
 :doc:`../examples/cron`
-    Function that gets triggered periodically.
+    A function that gets triggered periodically.
 
 :doc:`../examples/multiple_modules`
     An application with multiple handlers organized in different modules.
@@ -16,7 +16,7 @@ To showcase the framework and how it can used to deploy serverless applications,
     A GitHub action workflow to deploy your application with `scw_serverless`.
 
 :doc:`../examples/pr_notifier`
-    A Slack bot which alerts on incoming pull requests.
+    A Slack bot that alerts on incoming pull requests.
     It showcases many features of the framework.
 
 .. toctree::

docs/source/gateway.rst

@@ -0,0 +1,9 @@
+API Gateway
+===========
+
+.. warning:: Not yet implemented.
+
+Routed functions
+^^^^^^^^^^^^^^^^
+
+.. autodocs:: scw_serverless.app.Serverless.func

docs/source/index.rst

@@ -14,6 +14,9 @@ No need for configuration files, the framework makes it possible to configure yo
 :doc:`deploying`
     Instructions to deploy your project with the CLI tool.
 
+:doc:`gateway`
+    Instructions to create an API gateway to manage HTTP routing to functions.
+
 :doc:`examples`
     Examples to get you started.
 
@@ -41,7 +44,7 @@ This includes the environment variables.
 Usage
 ^^^^^
 
-Annotate your Python functions with the func decorator:
+Annotate your Python functions with the `func` decorator:
 
 .. code-block:: python
 
@@ -70,4 +73,5 @@ To learn more about the different configuration options, check out :doc:`configu
 
    configuring
    deploying
+   gateway
    examples

scw_serverless/config/function.py

@@ -43,6 +43,7 @@ class FunctionKwargs(TypedDict, total=False):
     :param http_option: Either "enabled" or "redirected".
                         If "redirected" (default), allow http traffic to your function.
                         Blocked otherwise.
+
     .. seealso::
 
         Scaleway Developers Documentation