Skip to content
Snippets Groups Projects
Commit e43c9c1c authored by Nik | Klampfradler's avatar Nik | Klampfradler
Browse files

Merge branch 'prepare-release-2.6' into 'master'

Do release 2.6

See merge request !904
parents ee881aa8 0a485791
No related branches found
No related tags found
1 merge request!904Do release 2.6
Pipeline #49887 canceled
......@@ -9,6 +9,9 @@ and this project adheres to `Semantic Versioning`_.
Unreleased
----------
`2.6`_ - 2022-01-10
-------------------
Added
~~~~~
......@@ -642,3 +645,4 @@ Fixed
.. _2.3.1: https://edugit.org/AlekSIS/Official/AlekSIS/-/tags/2.3.1
.. _2.4: https://edugit.org/AlekSIS/Official/AlekSIS/-/tags/2.4
.. _2.5: https://edugit.org/AlekSIS/Official/AlekSIS/-/tags/2.5
.. _2.6: https://edugit.org/AlekSIS/Official/AlekSIS/-/tags/2.6
Appendices of AlekSIS-Core
==========================
.. toctree::
:glob:
*
../../LICENCE.rst
\ No newline at end of file
......@@ -29,9 +29,9 @@ copyright = "2019-2022 The AlekSIS team"
author = "The AlekSIS Team"
# The short X.Y version
version = "2.5"
version = "2.6"
# The full version, including alpha/beta/rc tags
release = "2.5.1.dev0"
release = "2.6.1.dev0"
# -- General configuration ---------------------------------------------------
......@@ -84,13 +84,25 @@ pygments_style = None
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = "sphinx_materialdesign_theme"
html_theme = "sphinx_material"
html_favicon = "../aleksis/core/static/img/aleksis-icon.png"
html_logo = "../aleksis/core/static/img/aleksis-banner.svg"
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#
# html_theme_options = {}
html_theme_options = {
"repo_url": f"https://edugit.org/AlekSIS/official/{project}",
"repo_name": "EduGit",
"repo_type": "gitlab",
"theme_color": "#0d5eaf",
"color_primary": "#0d5eaf",
"color_accent": "#0d5eaf",
"globaltoc_depth": 2,
"globaltoc_collapse": False,
}
# 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,
......@@ -105,7 +117,9 @@ html_static_path = ["_static"]
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
# 'searchbox.html']``.
#
# html_sidebars = {}
html_sidebars = {
"**": ["logo-text.html", "globaltoc.html", "localtoc.html", "searchbox.html"]
}
# -- Options for HTMLHelp output ---------------------------------------------
......
......@@ -10,12 +10,10 @@ Welcome to AlekSIS-Core's documentation!
:maxdepth: 2
:caption: Contents:
preamble/00_index
user/00_index
admin/00_index
dev/00_index
ref/00_index
appendix/00_index
Indices and tables
......
Introduction to AlekSIS and the AlekSIS core
============================================
.. toctree::
:glob:
*
Introduction to AlekSIS
=======================
Welcome
-------
Welcome to AlekSIS, the Free School Information System! This handbook is
a comprehensive guide on how to install, administer, and use AlekSIS and
all included official apps. Its target audience are system
administrators seeking to install and maintain an AlekSIS installation,
people supporting the use of AlekSIS in daily processes in educational
organisations, and end users who work with the software on a daily
basis.
On School Information Systems
-----------------------------
School Information Systems, or for short, SIS, are software suites that
help educational organisations with managing personal information about
all members (e.g. students, teachers, parents and guardians) as well as
organisational data like plans, pedagogic track records, and much more.
Generally, the goal of using School Information Systems is to help
members of the school or other educational organisation to organise
their work in learning and teaching, and to simplify digital processes,
especially those that involve analytical evaluation, statistics, or
information that is updated very frequently and should be made available
to its recipients in a timely manner.
Ideally, School Information Systems also promote transparency between
teachers and students and improve sustainability by minimising the need
for paperwork.
AlekSIS, the Free School Information System
-------------------------------------------
School Information Systems have been on the rise ever since schools
began digitising their management processes. Traditionally, the vendors
of school management tools (like for timetabling, personal data
management of teachers and students, etc.) also deliver wen applications
that are tailored towards making the respective data available to those
who need it.
As most of these solutions are proprietary products, they tend to be
limited to be used together with other software of their vendors, and do
not integrate nicely with other software and with processes and data
sets not in the focus of the developers.
AlekSIS, in contrast, is a generic School Information System that aims
at being universally usable for all processes and data sets in any
educational organisation, and at interacting closely with other software
components employed in management and lessons. You can find information
on the possibilities for interacting with other software in the chapter
[@sec:Integrations].
The development and product team has set the following goals for
AlekSIS, in their dedication to support learning and teaching in the
digital world:
- Create a high-quality software product, adhering to high standards
regarding data protection, data safety, security, and stability
- Comply with as many national and regional data protection and school
laws as possible (cf. [@sec:Legal])
- Provide an extensible framework, allowing schools or their supporting
IT companies to create their own apps (cf. [@sec:Development])
- Help coding clubs and classes to understand the development as deeply
as necessary to use AlekSIS for learning and creating their own apps
- Keep AlekSIS free, open, and transparent (cf. [@sec:FOSS])
[tool.poetry]
name = "AlekSIS-Core"
version = "2.5.1.dev0"
version = "2.6.1.dev0"
packages = [
{ include = "aleksis" }
]
......@@ -133,7 +133,7 @@ s3 = ["boto3", "django-storages"]
sentry = ["sentry-sdk"]
[tool.poetry.dev-dependencies]
aleksis-builddeps = "^5"
aleksis-builddeps = "^6"
uwsgi = "^2.0"
[tool.poetry.scripts]
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment