Skip to content

Documentation needed for first release

  • Admin / Installation
    • Installation methods (global, venv, Docker)
    • uWSGI
    • PostgreSQL
    • Celery
    • Redis
    • memcached
    • Configuration via Dynaconf
    • Preferences system
    • Impersonation
    • django-dbbackup
    • Document in admin manual how to configure own icons
    • django-health-check and psutil
      • Document in admin manual what this is and how to use
    • djano-prometheus
    • django-extensions and ipython (Document in admin manual which tools are available and how to use them)
  • Development
    • Definition and merging of app settings
    • Extensible Models
    • Materialize templates etc.
    • Modules (util, tables, tasks, views,…)
    • Python and Django tools/dependencies available from core
    • The namespaces aleksis.apps and AlekSIS-App
    • Publishing apps
    • Development guidelines for apps
    • Document how apps can add assets that are configurable
    • Document how apps can add menu items and what they should take care of
    • Document how apps should use forms, views models, and tables, and all of them together
    • Document in developer reference that apps can rely on PostgreSQL-only features
    • Select2
    • django-two-factor-auth
    • Document how to add own JS dependencies for apps in dev reference (yarnpkg)
    • Document in dev reference what apps should do to get a ocnsistent material design, and how to use partials from core, etc.
    • Document in dev reference how to control caching, add things to the serviceworker, etc/
    • Document in dev reference how to add own prefernces, and when to use preferences
    • Document in dev reference that it can be used and when to do so (definition of such attributes in Form class vs. template) (widget_tweaks)
    • django-filter
    • django-templated-email, html2text
    • django-ckeditor
      • Explain why this can be a security risk, and how to prevent this
    • django-jsreverse
    • Document in dev reference how to use and when to use asynchronous tasks
    • Document in dev reference when to use model extensions (and when to use a separate model instead), and hwo this works, and its limitations
    • django-colorfield
    • django-guardian, django-rules
      • Best practices
      • Security implications
      • Legal requirements
    • django-cache-memoize
    • django-haystack, celery-haystack-ng
    • spdx-licence-list and licence-expression
    • django-reversion
      • Explain when to create a revision
    • Document in dev reference how to add own health checks, and when to do so
    • django-cachalot (Document in dev reference that it is used, and what this means for queries)
    • django-prometheus (how to add metrics)
    • django-model-utils (Document in dev reference that it is used, and what this means for queries)
    • django-phonenumber-field
    • Document in dev reference how to let the user wait for a task result, when to do so, and when not
    • bs4 (BeautifulSoup)
    • add_class_to_el
  • User manual
    • The concept of school terms
    • The concept of users and persons
    • The concept of groups (and things surrounding them, e.g. group roles, etc.
    • Terminology
    • Document in user manual how to get a native feeling with the PWA (e.e. adding to homescreen on mobile phones)
    • Document in user manual how to change personal preferences
    • 2FA
  • Official apps
    • Chronos
      • What is Chronos
      • Feature list
      • Basic concepts
      • Settings and preferences
      • How to import data (short references to importers)
      • Different timetable views
    • Alsijil
      • What is AlekSIS-App-Alsijil
      • Feature list
      • Basic concepts
      • Settings and preferences
      • Relation to Chronos
      • Concepts of lesson documentations
      • Concepts of personal notes
      • Defining extra marks, etc.
      • Lesso ndocumentation view
      • Views for teachers
      • Views for students
      • Print-our / archive
    • Hjelp
      • What is AlekSIS-App-Hjelp
      • Feature list
      • Basic concepts
      • Settings and preferences
      • Managing FAQs
  • Importers
    • CSV
    • What is AlekSIS-App-CSVImport
    • Feature list
    • Basic concepts
    • Settings and preferences
    • Using default templates
      • Pedasos
    • Defining own templates
    • LDAP
      • What is AlekSIS-App-LDAP
      • Feature list
      • Basic concepts
      • Settings and preferences
      • Examples
        • IServ
        • Debian Edu
    • DashboardFeeds
      • What is AlekSIS-App-DashboardFeeds
      • Feature list
      • Basic concepts
      • Settings and preferences
    • Untis
      • What is AlekSIS-App-Untis
      • Feature list
      • Basic concepts
      • Settings and preferences
      • Supported Untis features
      • Unsupported Untis features
      • Relation between Untis and Chronos data models
Edited by Hangzhi Yu