From 4ab1aa8d016ca0706daa52622065562b271bc263 Mon Sep 17 00:00:00 2001 From: TheJoKlLa Date: Sat, 11 Dec 2021 17:15:21 +0100 Subject: [PATCH] Added: Installation Overview Page --- source/conf.py | 10 ++++---- source/index.rst | 13 +++-------- source/installation/client_build.md | 1 + source/installation/client_store.md | 1 + source/installation/installation.rst | 34 ++++++++++++++++++++++++++++ source/installation/server_build.md | 1 + source/installation/server_docker.md | 1 + 7 files changed, 46 insertions(+), 15 deletions(-) create mode 100644 source/installation/client_build.md create mode 100644 source/installation/client_store.md create mode 100644 source/installation/installation.rst create mode 100644 source/installation/server_build.md create mode 100644 source/installation/server_docker.md diff --git a/source/conf.py b/source/conf.py index 7354987..e514ad6 100644 --- a/source/conf.py +++ b/source/conf.py @@ -18,9 +18,9 @@ import sphinx_rtd_theme # -- Project information ----------------------------------------------------- -project = 'Fab-Access' -copyright = '2020, Fab-Infra Team' -author = 'Fab-Infra Team' +project = 'FabAccess' +copyright = '2020, FabInfra Team' +author = 'FabInfra Team' # -- General configuration --------------------------------------------------- @@ -30,7 +30,7 @@ author = 'Fab-Infra Team' # ones. extensions = [ "sphinx_rtd_theme", - "recommonmark", + "recommonmark" ] # Add any paths that contain templates here, relative to this directory. @@ -42,7 +42,7 @@ master_doc = 'index' # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = 'de' +language = 'en' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. diff --git a/source/index.rst b/source/index.rst index c3ecf73..7aac9e8 100644 --- a/source/index.rst +++ b/source/index.rst @@ -3,18 +3,11 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to fab-access's documentation! +Welcome to FabAccess documentation! ====================================== .. toctree:: - :maxdepth: 2 + :maxdepth: 1 :caption: Contents: - - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` + installation/installation.rst diff --git a/source/installation/client_build.md b/source/installation/client_build.md new file mode 100644 index 0000000..d2f76ad --- /dev/null +++ b/source/installation/client_build.md @@ -0,0 +1 @@ +# Build Client from Source \ No newline at end of file diff --git a/source/installation/client_store.md b/source/installation/client_store.md new file mode 100644 index 0000000..4fb9d3b --- /dev/null +++ b/source/installation/client_store.md @@ -0,0 +1 @@ +# Get Client from Store diff --git a/source/installation/installation.rst b/source/installation/installation.rst new file mode 100644 index 0000000..6801060 --- /dev/null +++ b/source/installation/installation.rst @@ -0,0 +1,34 @@ +Install FabAccess +================= + +FabAccess has an Server an Client structure. + +So the Server and the Client must be installed seperatly. + +Install Server +-------------- +The Server can be installed over two recommended ways. + +The easiest way is to use Docker with Docker-Compose. + +To add youre own Plugins and Software you should use the Build way. + +.. toctree:: + server_build.md + server_docker.md + +Install Client +-------------- +The Client communicates with the server over an API. +So you can use any Client that support the current API Version of the Server. + +We provide an Native Client for the following Platforms: + * Android + * iOS + * UWP + +For MacOS and Linux(GTK) we will provide a Client later in our Development. + +.. toctree:: + client_store.md + client_build.md diff --git a/source/installation/server_build.md b/source/installation/server_build.md new file mode 100644 index 0000000..6b35e13 --- /dev/null +++ b/source/installation/server_build.md @@ -0,0 +1 @@ +# Build Server from Source \ No newline at end of file diff --git a/source/installation/server_docker.md b/source/installation/server_docker.md new file mode 100644 index 0000000..a113107 --- /dev/null +++ b/source/installation/server_docker.md @@ -0,0 +1 @@ +# Run Server with Docker \ No newline at end of file