add a documentation folder and some documentation

parent 35372e38
docs/_build
.env
__pycache__
*.pyc
......
Take a look at [the documentation folder](docs/index.rst) for information on this project.
# Minimal makefile for Sphinx documentation
#
# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = .
BUILDDIR = _build
# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
.PHONY: help Makefile
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
# -- Path setup --------------------------------------------------------------
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))
# -- Project information -----------------------------------------------------
project = 'user-panel'
copyright = '2020, OpenAppStack'
author = 'OpenAppStack'
# The full version, including alpha/beta/rc tags
with open('../VERSION') as version_file:
release = version_file.read()
# -- General configuration ---------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'recommonmark'
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'sphinx_rtd_theme'
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# Readthedocs.io needs us to tell it what the index file is. This defaults to
# 'contents'
master_doc = 'index'
.. user-panel documentation master file, created by
sphinx-quickstart on Thu Jan 9 17:06:13 2020.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Description
-----------
The user panel allows you to add and edit users in a GraphQL database. It can
also show you an overview of applications that are available to the users.
Admin users can create and edit other users. Normal users can log in to change
their password and email address, and see to which applications they have
access.
Installation
------------
At the moment installation should be done following the `single-sign-on
installation instructions`__ which include installation of this user panel.
.. _sso-docs: https://docs.openappstack.net/projects/single-sign-on/en/latest/installation_instructions.html
__ sso-docs_
In the future, this application will be installable with its own helm chart.
Usage
-----
When you first go to the application URL, you will see a "Login" button. This
button opens redirects to you the login screen. On the login screen, you can
find another button that will redirect you to your single sign-on's login
process. Log in by entering your credentials there.
After logging in there are three tabs on top of the screen.
The first is the "Home" screen. You'll automatically be on it too: you'll see
all the applications that are also configured in the single sign-on.
The second tab, "OIDC", shows debug information about your user.
The last tab, "Users" is where you can create and edit users.
Creating a new user
+++++++++++++++++++
1. Navigate to the "Users" tab.
2. Click "Add user"
3. Enter a username and click "Submit". **Note that your user is not saved
yet!**
4. Enter a password and a valid email address and click "Save"
5. You have now created a user. For the user to be able to log into
applications, you still need to click "Add app" and type the name of the
application the user is allowed to use. Take a look at your admin user to
see the list of possible applications. After typing the name of the
application, click "Save".
.. toctree::
:maxdepth: 2
:caption: Contents:
@ECHO OFF
pushd %~dp0
REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=.
set BUILDDIR=_build
if "%1" == "" goto help
%SPHINXBUILD% >NUL 2>NUL
if errorlevel 9009 (
echo.
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
echo.installed, then set the SPHINXBUILD environment variable to point
echo.to the full path of the 'sphinx-build' executable. Alternatively you
echo.may add the Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.http://sphinx-doc.org/
exit /b 1
)
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
goto end
:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
:end
popd
sphinx>=2.3.1
sphinx_rtd_theme>=0.4.3
recommonmark>=0.6.0
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment