Docs/SK-1084 | Improve SEO (#716)

scaleoutsystems · Oct 2, 2024 · 6cc93ff · 6cc93ff
1 parent 95be563
commit 6cc93ff
Show file tree

Hide file tree

Showing 29 changed files with 92 additions and 27 deletions.
diff --git a/docs/aggregators.rst b/docs/aggregators.rst
@@ -116,4 +116,6 @@ This extension can then simply be called as such:
 
 .. meta::
    :description lang=en:
-      Aggregators are responsible for combining client model updates into a combiner-level global model. During a training session, the combiners will instantiate an Aggregator and use it to process the incoming model updates from clients.
+      Aggregators are responsible for combining client model updates into a combiner-level global model. During a training session, the combiners will instantiate an Aggregator and use it to process the incoming model updates from clients.
+   :robots: index, follow
+   :keywords: Federated Learning, Aggregators, Federated Learning Framework, Federated Learning Platform, FEDn, Scaleout Systems
diff --git a/docs/apiclient.rst b/docs/apiclient.rst
@@ -137,4 +137,6 @@ For more information on how to use the APIClient, see the :py:mod:`fedn.network.
 
 .. meta::
    :description lang=en:
-      FEDn comes with an APIClient - a Python3 library that can be used to interact with FEDn programmatically. In this tutorial we show how to use the APIClient to initialize the server-side with the compute package and seed models, run and control training sessions and to retrieve models and metrics.
+      FEDn comes with an APIClient - a Python3 library that can be used to interact with FEDn programmatically. In this tutorial we show how to use the APIClient to initialize the server-side with the compute package and seed models, run and control training sessions and to retrieve models and metrics.
+   :keywords: Federated Learning, APIClient, Federated Learning Framework, Federated Learning Platform, FEDn, Scaleout Systems
+   :robots: index, follow
diff --git a/docs/architecture.rst b/docs/architecture.rst
@@ -54,4 +54,6 @@ many different possible outcomes can be achieved. Good starting configurations a
 
 .. meta::
    :description lang=en:
-      Architecture overview - Constructing a federated model with FEDn amounts to a) specifying the details of the client-side training code and data integrations, and b) deploying the federated network.
+      Architecture overview - Constructing a federated model with FEDn amounts to a) specifying the details of the client-side training code and data integrations, and b) deploying the federated network.
+   :keywords: Federated Learning, Architecture, Federated Learning Framework, Federated Learning Platform, FEDn, Scaleout Systems
+   :robots: index, follow
diff --git a/docs/auth.rst b/docs/auth.rst
@@ -103,4 +103,10 @@ For the client, you need to set the following environment variables:
 
 
 
-You can use `--token` flags in the FEDn CLI to set the access token.
+You can use `--token` flags in the FEDn CLI to set the access token.
+
+.. meta::
+   :description lang=en:
+      Authentication and Authorization (RBAC) - FEDn supports Role-Based Access Control (RBAC) for controlling access to the FEDn API and gRPC endpoints. The RBAC system is based on JSON Web Tokens (JWT) and is implemented using the `jwt` package.
+   :keywords: Federated Learning, Authentication and Authorization, Federated Learning Framework, Federated Learning Platform, FEDn, Scaleout Systems
+   :robots: index, follow
diff --git a/docs/developer.rst b/docs/developer.rst
@@ -267,4 +267,6 @@ You can use `--token` flags in the FEDn CLI to set the access token.
 
 .. meta::
    :description lang=en:
-      During development on FEDn, and when working on own extentions including aggregators and helpers, it is useful to have a local development setup of the core FEDn server-side services (controller, combiner etc). We provide Dockerfiles and docker-compose template for an all-in-one local sandbox
+      During development on FEDn, and when working on own extentions including aggregators and helpers, it is useful to have a local development setup of the core FEDn server-side services (controller, combiner etc). We provide Dockerfiles and docker-compose template for an all-in-one local sandbox
+   :keywords: Federated Learning, Developer guide, Federated Learning Framework, Federated Learning Platform, FEDn, Scaleout Systems
+   :robots: index, follow
diff --git a/docs/faq.rst b/docs/faq.rst
@@ -89,4 +89,6 @@ with the Scaleout team.
 
 .. meta::
    :description lang=en:
-      How do you approach the question of output privacy? We take security in (federated) machine learning seriously. Federated learning is a foundational technology that improves input privacy in machine learning by allowing datasets to stay local and private, and not copied to a server.
+      How do you approach the question of output privacy? We take security in (federated) machine learning seriously. Federated learning is a foundational technology that improves input privacy in machine learning by allowing datasets to stay local and private, and not copied to a server.
+   :keywords: Federated Learning, FAQ, Federated Learning Framework, Federated Learning Platform, FEDn, Scaleout Systems
+   :robots: index, follow
diff --git a/docs/fedn.network.api.rst b/docs/fedn.network.api.rst
@@ -40,3 +40,6 @@ fedn.network.api.tests module
    :members:
    :undoc-members:
    :show-inheritance:
+
+.. meta::
+   :robots: index, follow
diff --git a/docs/fedn.network.clients.rst b/docs/fedn.network.clients.rst
@@ -48,3 +48,6 @@ fedn.network.clients.test\_client module
    :members:
    :undoc-members:
    :show-inheritance:
+
+.. meta::
+   :robots: index, follow
diff --git a/docs/fedn.network.combiner.aggregators.rst b/docs/fedn.network.combiner.aggregators.rst
@@ -40,3 +40,6 @@ fedn.network.combiner.aggregators.fedopt module
    :members:
    :undoc-members:
    :show-inheritance:
+
+.. meta::
+   :robots: index, follow
diff --git a/docs/fedn.network.combiner.rst b/docs/fedn.network.combiner.rst
@@ -64,3 +64,6 @@ fedn.network.combiner.roundhandler module
    :members:
    :undoc-members:
    :show-inheritance:
+
+.. meta::
+   :robots: index, follow
diff --git a/docs/fedn.network.controller.rst b/docs/fedn.network.controller.rst
@@ -24,3 +24,6 @@ fedn.network.controller.controlbase module
    :members:
    :undoc-members:
    :show-inheritance:
+
+.. meta::
+   :robots: index, follow
diff --git a/docs/fedn.network.dashboard.rst b/docs/fedn.network.dashboard.rst
diff --git a/docs/fedn.network.loadbalancer.rst b/docs/fedn.network.loadbalancer.rst
@@ -32,3 +32,6 @@ fedn.network.loadbalancer.loadbalancerbase module
    :members:
    :undoc-members:
    :show-inheritance:
+
+.. meta::
+   :robots: index, follow
diff --git a/docs/fedn.network.rst b/docs/fedn.network.rst
@@ -37,3 +37,6 @@ fedn.network.state module
    :members:
    :undoc-members:
    :show-inheritance:
+
+.. meta::
+   :robots: index, follow
diff --git a/docs/fedn.network.statestore.rst b/docs/fedn.network.statestore.rst
@@ -24,3 +24,6 @@ fedn.network.statestore.statestorebase module
    :members:
    :undoc-members:
    :show-inheritance:
+
+.. meta::
+   :robots: index, follow
diff --git a/docs/fedn.network.storage.models.rst b/docs/fedn.network.storage.models.rst
@@ -32,3 +32,6 @@ fedn.network.storage.models.tempmodelstorage module
    :members:
    :undoc-members:
    :show-inheritance:
+
+.. meta::
+   :robots: index, follow
diff --git a/docs/fedn.network.storage.rst b/docs/fedn.network.storage.rst
@@ -15,3 +15,6 @@ Subpackages
    fedn.network.storage.models
    fedn.network.storage.s3
    fedn.network.storage.statestore
+
+.. meta::
+   :robots: index, follow
diff --git a/docs/fedn.network.storage.s3.rst b/docs/fedn.network.storage.s3.rst
@@ -32,3 +32,6 @@ fedn.network.storage.s3.repository module
    :members:
    :undoc-members:
    :show-inheritance:
+
+.. meta::
+   :robots: index, follow
diff --git a/docs/fedn.network.storage.statestore.rst b/docs/fedn.network.storage.statestore.rst
@@ -24,3 +24,6 @@ fedn.network.storage.statestore.statestorebase module
    :members:
    :undoc-members:
    :show-inheritance:
+
+.. meta::
+   :robots: index, follow
diff --git a/docs/fedn.rst b/docs/fedn.rst
@@ -14,3 +14,6 @@ Subpackages
 
    fedn.network
    fedn.utils
+
+.. meta::
+   :robots: index, follow
diff --git a/docs/fedn.utils.helpers.plugins.rst b/docs/fedn.utils.helpers.plugins.rst
@@ -16,3 +16,6 @@ fedn.utils.helpers.plugins.numpyhelper module
    :members:
    :undoc-members:
    :show-inheritance:
+
+.. meta::
+   :robots: index, follow
diff --git a/docs/fedn.utils.helpers.rst b/docs/fedn.utils.helpers.rst
@@ -32,3 +32,6 @@ fedn.utils.helpers.helpers module
    :members:
    :undoc-members:
    :show-inheritance:
+
+.. meta::
+   :robots: index, follow
diff --git a/docs/fedn.utils.plugins.rst b/docs/fedn.utils.plugins.rst
@@ -40,3 +40,6 @@ fedn.utils.plugins.pytorchhelper module
    :members:
    :undoc-members:
    :show-inheritance:
+
+.. meta::
+   :robots: index, follow
diff --git a/docs/fedn.utils.rst b/docs/fedn.utils.rst
@@ -40,3 +40,6 @@ fedn.utils.process module
    :members:
    :undoc-members:
    :show-inheritance:
+
+.. meta::
+   :robots: index, follow
diff --git a/docs/helpers.rst b/docs/helpers.rst
@@ -30,4 +30,6 @@ for further details.
 
 .. meta::
    :description lang=en:
-      Model marshalling - In federated learning, model updates need to be serialized and deserialized in order to be transferred between clients and server/combiner. There is also a need to write and load models to/from disk, for example to transiently store updates during training rounds.
+      Model marshalling - In federated learning, model updates need to be serialized and deserialized in order to be transferred between clients and server/combiner. There is also a need to write and load models to/from disk, for example to transiently store updates during training rounds.
+   :keywords: Federated Learning, Model marshalling, Federated Learning Framework, Federated Learning Platform, FEDn, Scaleout Systems
+   :robots: index, follow
diff --git a/docs/index.rst b/docs/index.rst
@@ -29,3 +29,9 @@ Indices and tables
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
+
+.. meta::
+    :description lang=en:
+        FEDn is a federated learning platform that is secure, scalable and easy-to-use. FEDn supports the full journey from early testing/exploration, through pilot projects, to real-world deployments and integration.
+    :keywords: Federated Learning, Machine Learning, Federated Learning Framework, Federated Learning Platform, FEDn, Scaleout Systems
+    :robots: index, follow
diff --git a/docs/introduction.rst b/docs/introduction.rst
@@ -78,4 +78,4 @@ For professionals / Enteprise, we offer `Dedicated support <https://www.scaleout
     :og:description: Federated Learning is a novel approach to address challenges related to data privacy, security, and decentralized data distribution.
     :og:image: https://fedn.scaleoutsystems.com/static/images/scaleout_black.png
     :og:url: https://fedn.scaleoutsystems.com/docs/introduction.html
-    :og:type: article
+    :og:type: website
diff --git a/docs/modules.rst b/docs/modules.rst
@@ -5,3 +5,9 @@ API reference
    :maxdepth: 4
 
    fedn
+
+.. meta::
+   :description lang=en:
+      API reference for FEDn, a federated learning platform that is secure, scalable and easy-to-use. FEDn supports the full journey from early testing/exploration, through pilot projects, to real-world deployments and integration.
+   :keywords: Federated Learning, API reference, Federated Learning Framework, Federated Learning Platform, FEDn, Scaleout Systems
+   :robots: index, follow
diff --git a/docs/projects.rst b/docs/projects.rst
@@ -439,4 +439,6 @@ and its integration with popular machine learning frameworks like PyTorch and Te
 
 .. meta::
     :description lang=en:
-        A FEDn project is a convention for packaging/wrapping machine learning code to be used for federated learning with FEDn. At the core, a project is a directory of files, containing your machine learning code, FEDn entry points, and a specification of the runtime environment for the client.
+        A FEDn project is a convention for packaging/wrapping machine learning code to be used for federated learning with FEDn. At the core, a project is a directory of files, containing your machine learning code, FEDn entry points, and a specification of the runtime environment for the client.
+    :keywords: Federated Learning, Machine Learning, Federated Learning Framework, Federated Learning Platform, FEDn, Scaleout Systems
+    :robots: index, follow