aleksis/AlekSIS-Core

Fork

You've already forked AlekSIS-Core

Code Issues 197 Pull requests 63 Projects Releases 14 Packages 1 Wiki Activity Actions

Documentation needed for first release #374

New issue

Closed

opened 2020-01-15 23:18:32 +01:00 by nik · 31 comments

nik commented

2020-01-15 23:18:32 +01:00

Owner

Copy link

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

* [ ] Admin / Installation * [ ] Installation methods (global, venv, Docker) * [ ] uWSGI * [ ] PostgreSQL * [x] Celery * [x] Redis * [ ] memcached * [x] 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 * [X] djano-prometheus * [ ] django-extensions and ipython (Document in admin manual which tools are available and how to use them) * [ ] Development * [x] Definition and merging of app settings * [x] Extensible Models * [x] Materialize templates etc. * [x] 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

nik commented

2020-01-16 22:11:50 +01:00

Author

Owner

Copy link

@hansegucker @yuha @ZugBahnHof Please also add everything you think should be documented to the above list

hansegucker commented

2020-01-19 11:29:27 +01:00

Owner

Copy link

changed the description

hansegucker commented

2020-01-19 11:29:53 +01:00

Owner

Copy link

changed the description

hansegucker commented

2020-02-29 11:58:36 +01:00

Owner

Copy link

changed the description

hansegucker commented

2020-04-02 12:09:47 +02:00

Owner

Copy link

changed the description

tteichler commented

2020-07-12 20:57:07 +02:00

Owner

Copy link

marked the checklist item Let model extensions define new fields (AlekSIS-Core!1774) as completed

marked the checklist item **Let model extensions define new fields (AlekSIS-Core!1774)** as completed

tteichler commented

2020-07-12 22:02:07 +02:00

Owner

Copy link

created merge request AlekSIS-Core!1978 to address this issue

tteichler commented

2020-07-12 22:02:09 +02:00

Owner

Copy link

mentioned in merge request AlekSIS-Core!1978

tteichler commented

2020-07-16 13:22:07 +02:00

Owner

Copy link

marked the checklist item Materialize templates etc. as completed

marked the checklist item **Materialize templates etc.** as completed

tteichler commented

2020-07-16 13:22:09 +02:00

Owner

Copy link

marked the checklist item Extensible Models as completed

marked the checklist item **Extensible Models** as completed

tteichler commented

2020-07-16 13:22:10 +02:00

Owner

Copy link

marked the checklist item Merging of app settings as completed

marked the checklist item **Merging of app settings** as completed

tteichler commented

2020-07-16 13:22:11 +02:00

Owner

Copy link

marked the checklist item Celery and Redis as completed

marked the checklist item **Celery and Redis** as completed

tteichler commented

2020-07-16 13:35:52 +02:00

Owner

Copy link

assigned to @debdolph

tteichler commented

2020-07-16 16:32:34 +02:00

Owner

Copy link

changed the description

tteichler commented

2020-07-16 17:17:01 +02:00

Owner

Copy link

marked the checklist item Modules (util, tables, tasks, views,…) as completed

marked the checklist item **Modules (util, tables, tasks, views,…)** as completed

tteichler commented

2020-07-16 19:46:06 +02:00

Owner

Copy link

mentioned in commit AlekSIS-App-Chronos@17d30afa037b7bf520ff573f2e07076266462858

tteichler commented

2020-07-16 19:46:32 +02:00

Owner

Copy link

mentioned in merge request AlekSIS-App-Chronos!1716

tteichler commented

2020-07-16 19:46:50 +02:00

Owner

Copy link

marked the checklist item Configuration options as completed

marked the checklist item **Configuration options** as completed

tteichler commented

2020-07-16 20:32:06 +02:00

Owner

Copy link

mentioned in commit AlekSIS-App-LDAP@aead0c8911e7d8b036e9b3d70a2893d45c2eaed4

tteichler commented

2020-07-16 20:32:24 +02:00

Owner

Copy link

mentioned in merge request AlekSIS-App-LDAP!1665

tteichler commented

2020-07-16 23:10:29 +02:00

Owner

Copy link

mentioned in commit AlekSIS-App-Untis@57ce8ac445fd6b8de3bf45e3e4180b6c448d4f18

tteichler commented

2020-07-16 23:10:51 +02:00

Owner

Copy link

mentioned in merge request AlekSIS-App-Untis!1673

nik commented

2020-11-14 21:54:09 +01:00

Author

Owner

Copy link

moved from AlekSIS-Core#158

nik commented

2021-02-14 21:09:39 +01:00

Author

Owner

Copy link

changed the description

nik commented

2021-02-14 21:10:32 +01:00

Author

Owner

Copy link

moved from AlekSIS#7

tteichler commented

2021-05-15 16:00:54 +02:00

Owner

Copy link

changed the description

tteichler commented

2021-05-15 16:16:07 +02:00

Owner

Copy link

changed the description

tteichler commented

2021-05-15 16:55:29 +02:00

Owner

Copy link

unassigned @debdolph

nik commented

2021-05-21 22:34:58 +02:00

Author

Owner

Copy link

mentioned in merge request !1978

nik commented

2021-06-20 23:12:25 +02:00

Author

Owner

Copy link

changed the description

yuha commented

2021-06-21 13:00:02 +02:00

Member

Copy link

changed the description

No Branch/Tag specified

master

3960-extend-slideiterator

1625-migrate-to-vuetify-4

remove-vite-legacy-plugin

weblate-frontend

weblate

renovate/selenium-4.x

1644-dahsboard-widget-creation-broken

renovate/node-26.x

renovate/django-health-check-4.x

renovate/django-countries-9.x

1643-calendar-dashboardwidgets-throw-500er-error

renovate/django-dbbackup-5.x

1064-backchannel-logout

sis2-with-sl

fix/adapt-some-urls

1533-notifications-reminders-for-events-todos

1294-expose-free-busy-state-in-ui-for-personal-events

1303-correctly-implement-recurring-todos-with-amends-recurrence-id

1345-introduce-annotate-methods-for-more-person-related-rules

1603-search-index-is-deleted-on-cache-flush

1068-oidc-rp-initiated-registration

1065-oidc-device-code-grant-flow

1599-vite-build-fails-with-too-many-apps

fix/sort-models

1066-oidc-dynamic-client-registration

tmp-ticdesk-dev

ticdesk-search-map

cherry-pick-2b8d2e01

643-one-time-login-links

1461-birthday-calendar-oom

tmp-ticdesk-related-names-for-paweljong

1459-manifest-json-not-found

integrate-disable-into-usecrud

update-container-image-base-to-trixie

check/update-pyproject-toml

check/update-builddeps-package-json

check/update-prettier-ignore

1445-todo-list-broken

1364-track-date-of-beginning-and-end-of-group-membership

1259-generalise-places

use-object-form-reactivity

1435-cruddaylist-does-not-detect-changes-in-existing-intervals

tmp-ticdesk

stable/4.0.0

1366-frontend-for-creating-and-modifying-generic-personrelationships

master-without-vue-3

1376-expand-row-feature-of-v-data-table-doesn-t-work-when-items-include-date-time-objects

release/4.1.0.dev2

1372-fix-import-of-crudlist

1353-adapt-chipselectfield

check/update-eslint-rc-js

check/update-tox-ini

improve-selenium-startup

1268-add-specific-availability-planning-frontend

1343-fix-person-related-permissions

newer-and-rebased-migrate-crud-to-vue-3-and-generalize

1314-fix-handling-of-end-datetime-in-calendar-events-query

migrate-to-uv

tmp-ticdesk-4-0

fix-inline-crud-list-is-create

tmp-split-calendar-event-dialog

release/4.1.0

1260-refactor-account-registration-form-and-generalize-parts-of-it

add-datacheck-fix-in-changelog

1232-group-calendars

1251-registryobjects-are-their-own-parent-registries

1209-introduce-django-rest-framework-serializers

1162-strange-behaviour-with-personal-events

revert-7fe8b8b1

check/delete-eslint-rc-js

check/update-gitignore

stable-3.2

stable-3.1

update/eslint

1158-add-sorting-functionality-to-get_single_events

1055-introduce-sub-school-terms

1082-colorfield-sometimes-returns-8-digit-alpha-color-hex-code

test-build

emit-extracted-items-from-save-event

886-prevent-graphql-query-mutation-name-collisions

release/3.2.1

1038-make-dialogobjectform-send-a-diff-on-edit-instead-of-the-whole-object

release/3.1.6

fix/counter-chip

1021-allow-matching-of-social-accounts-to-local-accounts-by-email

991-set-title-attribute-for-all-unclear-frontend-spots

update-docs-without-release-distribution

850-do-not-restart-vite-serve-on-every-uwsgi-reload

991-use-tooltips-for-all-unclear-frontend-spots

983-add-groups-by-person-query

826-otp-token-emails-don-t-contain-anything-besides-the-token

781-error-if-creating-a-new-school-term-without-a-start-and-end-date

966-allow-setting-of-custom-queryset-when-creating-calendar-feeds

tmp-for-add-simple-course-book-list

release/3.2.0

868-introduce-uuid-field-for-extensiblemodel

958-introduce-parent-model-resource

954-evaluate-strawberry-and-strawberry-django

948-error-handling-with-personal-event-creation-is-not-usable

fix-custom-events-fss

923-introduce-vue-styleguidist

899-move-person-type-fields-into-constant

892-remove-model-extension-api

manage-holidays

831-data-management-for-the-model-room

fix/oauth-toolkit-migration

release-3.0

stable-2.12

819-fix-some-minor-issues-in-graphql-queries

fix-container-image

stable-2.11

stable-2.10

stable-2.13

806-expose-string-representation-of-models-via-graphql-api

800-move-generic-components-from-aleksis-app-plank-to-core

debug-foo

oidc-docs

migrate-to-vue3

789-remove-syncable-fields

remove/ical-feed

194-enable-async-framework-channels

726-dynamically-build-vue-forms

766-selfclosing-components-in-vue_base-html-break-the-page

492-follow-up-view_persons_rule-not-usable-due-to-use-of-queryset_rules_filter

751-include-fields-of-non-extensible-model-in-syncable-fields

kort-core

feature/vuejs

717-docker-improve-image-size-by-fixing-cleanup-layer

build-improvements

697-3-0-meta-issue-for-graphql-back-end-and-vue-js-frontend

185-create-notifications-for-announcement

stable-2.7

update/translation-files-13

update/translation-files-12

599-add-oauth-oidc-tests

i10n-ru-ua

tmp/cbes

do-release-2.9

docs/notifications

180-add-template-management

fix-import

653-remove-cachalot

635-test-e-mail-button

397-dedicated-public-dashboard

396-external-link-widet-auto-discovery

511-allow-custom-redirect-uri-schemes

update/translation-files-8

585-barcode-widget-for-person-fields

dot-1.6.2

281-corporate-design-for-html-mails

592-oauth2-broken-in-2-4

574-rewrite-password-change-templates

reduce-docker-steps

571-age-calculation-broken

559-oauth-add-feature-to-limit-apps-to-groups

feature/push-notifications

feature/i18n-maintenance

fix/oauth-skip-auth-detail

523-integrate-sentry-for-performance-and-error-tracing

prepare-release-2.1.dev0

release/2.0

387-jwt-provider-consumer-support

update/translation-files

496-service-worker-safari-does-not-support-broadcastchannel-api

group-members-permissions

prepare-release-2.0b2

fix/trans-conflicts

bp-2.0-use-importlib-instead-of-pkg-resources

update/translation-files-2.0b0-1

test-migration-test

376-prevent-deep-linking-to-media-files

feature/build-icons-automatically

421-update-to-django-3-2

set-sast-config-1

feature/test-selenium-capabilities

arg-apps

feature/review-app

test-docker-app-version

feature/allow-app-source

fix-ci-config

feature/curlylint

feature/gin-index-on-ext-data

backup-over-ssh

feature/keep_local_password_ldap

340-correctly-implement-the-ckeditor

143-mark-menu-entries-as-active-with-sub-sub-menu-entries

feature/django-notifs

2021-update-copyright

catch-error

update/poetry

selenium

269-photo-cropping-broken-2

269-photo-cropping-broken

fix-docker-build

has-person

update-poetry-lockfile

pages-staging

mix/conn-dne

236-support-saml-and-oauth2-logins-as-consumer

feature/custom-auth-backends-dev

dev

fix-isort

214-add-notification-dashboard-widget-anything-to-notify-of-upcoming-birthdays

157-include-django-letsagree

215-add-geolocation-of-persons

267-lint-add-spell-check

291-rename-template-references

270-ci-replace-kaniko-with-buildah

217-add-support-for-defining-group-types

feature/docker-extras

153-use-complex-name-field-with-i18n-support

debug-docker-build

feature/material-admin

pages-jonglieren

179-group-contact

169-support-nextcloud-talk-for-notifications

develop-dashboard-feeds

134-merge-dashboard-ajax

5.3.0

5.2.0

5.1.0

5.0.3

5.0.2

5.0.1

5.0.0

5.0.0b3

5.0.0b2

5.0.0b1

5.0.0b0

4.1.0.dev2

4.0.4

4.1.0.dev1

4.1.0.dev0

4.0.3

4.0.2

4.0.1

4.0.0

4.0.0.dev16

3.2.2

3.1.7

4.0.0.dev15

4.0.0.dev14

4.0.0.dev13

4.0.0.dev12

4.0.0.dev11

3.1.6

3.2.1

4.0.0.dev10

4.0.0.dev9

4.0.0.dev8

4.0.0.dev7

4.0.0.dev6

4.0.0.dev5

4.0.0.dev4

4.0.0.dev3

4.0.0.dev2

4.0.0.dev1

3.2.0

3.1.5

3.1.4

3.1.3

3.1.2

3.1.1

3.1

3.0

2.12.4

3.0b3

3.0b2

2.10.3

2.11.2

2.12.3

3.0b1

3.0b0

3.0.dev3

2.12.2

3.0.dev2

2.12.1

2.12

2.11.1

2.11

2.10.2

3.0.dev1

2.10.2.dev0

3.0.dev0

2.10.1

2.10

2.7.6

2.7.5

2.9

2.8.2.dev2

2.8.2.dev1

2.8.2.dev0

2.8.1

2.8.1.dev0

2.8

2.7.4

2.7.3

2.7.2

2.7.1

2.7

2.6

2.5

2.4

2.3.2

2.3.1

2.3

2.2.1

2.2

2.1.1

2.1

2.1.dev0

2.0

2.0rc7

2.0rc6

2.0rc5

2.0rc4

2.0rc3

2.0rc2

2.0rc1

2.0b2

2.0b1

2.0b0

2.0a4

2.0a3

2.0a2

2.0a1

1.0a3.1

1.0a3

1.0a2

1.0a1

1.0a0

0.1

Labels

Clear labels

update-builddeps-package-json

update-merge-request-template

check

update-prettier-ignore

check

update-pyproject-toml

Backend (view code, models, logic, etc.)

part

docs

Issue or addition to the documentation

part

frontend

Frontend (templates, etc.)

part

i18n

Translation or internationalisation issue

part

non-technical

Non-technical (policy, maintenance, etc.) issue or discussion

part

packaging

Issue concerning the packaging of AlekSIS and components

Requested by a customer or affiliated user

Issue or merge request from other projects using AlekSIS or parts of it

Issue is blocked by another issue

workflow

confirmed

The bug is reproducible and will be fixed

Needs to be discussed before implementation

workflow

new-app

Requires new AlekSIS app, which has to be created

workflow

wontfix

The bug is not reproducible or the feature was decided against

No labels

update-builddeps-package-json

update-merge-request-template

check

update-prettier-ignore

check

update-pyproject-toml

Milestone

Clear milestone

No items

No milestone

Projects

Clear projects

No items

No project

Assignees

Clear assignees

No assignees

4 participants

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

aleksis/AlekSIS-Core#374

Reference in a new issue

Repository

aleksis/AlekSIS-Core

Title

Body

No description provided.

Delete branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?

Rows
Columns