Docs for the director-envoy 1.2 update (openfl#154)

* initial doc structure change * add utilities folder * test image import * fixes * added architecture section * restructure docs * moving package structure to index * ignore fix * Restructure openfl section * openfl docs restructuring * introduced director-based workflow * fix * another fix * Federation setup flow * list fix * added text * added director start commands * added envoy commands * fox commands * Small typo fixes * Changed titels * Added interactive API sections * attempt to structure the new workflow * attempts openfl#2 * restructuring * attempt openfl#4 * director based workflow merged * merging openfl#2 * fill director workflow * director starting procedure * envoy starting procedure described * docs gitignore change * Fixing the python API section * a few typo fixes * fixing python api docs * interactive api section changes * finished editing director workflow * Finished text description * rebased on develop * resolving comments in pr * plugins test * small rewrite * filled plugins section * typo fixes for plugins * added a link to a shard descriptor interface * fix italic * more fix italic * moved and fixed data splitters also restructured PKI and the old workflow * fixes * moved the old workflow to sources * static diagram + fixes * alexey's changes * added a static diagram * static diagram section
LeiChenIntel · Aug 31, 2021 · 7f94704 · 7f94704
1 parent eee7b34
commit 7f94704
Show file tree

Hide file tree

Showing 27 changed files with 1,318 additions and 267 deletions.
diff --git a/docs/.gitignore b/docs/.gitignore
@@ -1,4 +1,5 @@
-openfl*
-models*
+# openfl*
+# models*
+# data*
 /_build
 **/.ipynb_checkpoints
diff --git a/docs/advanced_topics.rst b/docs/advanced_topics.rst
@@ -15,4 +15,3 @@ Advanced Topics
    overriding_agg_fn
    bash_autocomplete_activation
    log_metric_callback
-   data_splitting
diff --git a/docs/bash_autocomplete_activation.rst b/docs/bash_autocomplete_activation.rst
@@ -14,18 +14,23 @@ If not use the instruction :ref:`install_initial_steps`.
 
 Create ~/.fx-autocomplete.sh script
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
    This step need to be done only one time when you don't have `~/.fx-autocomplete.sh` or `~/.fx-autocomplete.sh` have corrupted content.
+
    .. code-block:: console
 
       $ _FX_COMPLETE=bash_source fx > ~/.fx-autocomplete.sh
 
    Check that command was executed correctly.
+
    .. code-block:: console
 
       $ cat ~/.fx-autocomplete.sh
 
    Console output should look like example below (Click==8.0.1), but could be different depend on `Click https://click.palletsprojects.com/en/8.0.x/`_ version:
+
    .. code-block:: console
+
       _fx_completion() {
           local IFS=$'\n'
           local response
@@ -57,15 +62,20 @@ Create ~/.fx-autocomplete.sh script
 
 Activate autocomplete feature
 ~~~~~~~~~~~~~~~~~~~~~
+
    This step should be done every time when you open a new terminal window.
 
    .. code-block:: console
+
       $ source ~/.fx-autocomplete.sh
 
 Auto activation autocomplete
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
    To save your time you can add autocomplete activation step to `~/.bashrc`.
+
    .. code-block:: bash
       . ~/.fx-autocomplete.sh
+
    Save `~/.bashrc`.
    Open new terminal to use updated `~/.bashrc`.
diff --git a/docs/manual.rst b/docs/manual.rst
@@ -6,10 +6,11 @@ Manual
 ******
 
 .. toctree::
-   :maxdepth: 4
+   :maxdepth: 2
 
    overview
    install
    running_the_federation
    plan_settings
+   source/utilities/utilities
    advanced_topics
diff --git a/docs/openfl.rst b/docs/openfl.rst
@@ -0,0 +1,13 @@
+.. # Copyright (C) 2020-2021 Intel Corporation
+.. # SPDX-License-Identifier: Apache-2.0
+
+******
+OpenFL structure
+******
+
+.. toctree::
+   :maxdepth: 4
+
+   source/openfl/components
+   .. source/openfl/communication
+   source/openfl/plugins
diff --git a/docs/running_the_federation.interactive_api.rst b/docs/running_the_federation.interactive_api.rst
diff --git a/docs/running_the_federation.rst b/docs/running_the_federation.rst
@@ -16,11 +16,7 @@ First make sure you've installed the software :ref:`using these instructions <in
 The high-level workflow is shown in the figure above. Note that once OpenFL is installed on all nodes of the federation and every member of the federation has a valid PKI certificate, all that is needed to run an instance of a federated workload is to distribute the workspace to all federation members and then run the command to start the node (e.g. :code:`fx aggregator start`/:code:`fx collaborator start`). In other words, most of the work is setting up an initial environment on all of the federation nodes that can be used across new instantiations of federations.
 
 .. toctree::
-   :maxdepth: 4
+   :maxdepth: 2
 
-   running_the_federation.notebook
-   running_the_federation.baremetal
-   running_the_federation.docker
-   running_the_federation.certificates
-   running_the_federation.start_nodes.rst
-   running_the_federation.interactive_api
+   source/workflow/running_the_federation.agg_based
+   source/workflow/director_based_workflow
diff --git a/docs/source/openfl/communication.rst b/docs/source/openfl/communication.rst
@@ -0,0 +1,12 @@
+.. # Copyright (C) 2020-2021 Intel Corporation
+.. # SPDX-License-Identifier: Apache-2.0
+
+******
+|productName| inter-component communication
+******
+
+.. toctree::
+   :maxdepth: 2
+
+   `...`_
+   `...`_