Added: Installation Overview Page

This commit is contained in:
TheJoKlLa 2021-12-11 17:15:21 +01:00
parent 925bb82867
commit 4ab1aa8d01
7 changed files with 46 additions and 15 deletions

View File

@ -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.

View File

@ -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

View File

@ -0,0 +1 @@
# Build Client from Source

View File

@ -0,0 +1 @@
# Get Client from Store

View File

@ -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

View File

@ -0,0 +1 @@
# Build Server from Source

View File

@ -0,0 +1 @@
# Run Server with Docker