aleksis/AlekSIS-App-Matrix
Watch
10
0
Fork
You've already forked AlekSIS-App-Matrix
 0
Code Issues 19 Pull requests 6 Projects Releases Packages 1 Activity Actions

[Docs] Add setup instructions #62

Merged
hansegucker merged 5 commits from docs-config into master 2022-06-25 14:36:34 +02:00
Conversation 20 Commits 5 Files changed 7 +116
magicfelix commented 2022-06-21 15:37:46 +02:00
Member
Copy link

Closes #17

Closes #17
magicfelix commented 2022-06-21 15:37:47 +02:00
Author
Member
Copy link

assigned to @magicfelix

assigned to @magicfelix
magicfelix commented 2022-06-21 15:48:14 +02:00
Author
Member
Copy link

changed the description

changed the description
magicfelix commented 2022-06-21 15:51:08 +02:00
Author
Member
Copy link

added 20m of time spent

added 20m of time spent
nik commented 2022-06-21 19:38:54 +02:00
Owner
Copy link

marked this merge request as draft

marked this merge request as **draft**
nik commented 2022-06-21 19:40:06 +02:00
Owner
Copy link

The documentation is very incomplete.

Most importantly, most users will not have acces to an open registration endpoint. They might only get a user account that can login into Element, so we need t ocover at least the case of extracting an access token from there.

Furthermore, documentation about configuration, syncing rooms, and the sync behaviour is missing entirely.

The documentation is very incomplete. Most importantly, most users will not have acces to an open registration endpoint. They might only get a user account that can login into Element, so we need t ocover at least the case of extracting an access token from there. Furthermore, documentation about configuration, syncing rooms, and the sync behaviour is missing entirely.
magicfelix commented 2022-06-21 22:46:05 +02:00
Author
Member
Copy link

added 1 commit

  • d0706cef - [Docs] Add config instructions

Compare with previous version

added 1 commit <ul><li>d0706cef - [Docs] Add config instructions</li></ul> [Compare with previous version](/AlekSIS/official/AlekSIS-App-Matrix/-/merge_requests/11/diffs?diff_id=22252&start_sha=8b38a42bc3f0c1a7a354ec76cbba2e36fd477bfa)
magicfelix commented 2022-06-21 22:46:35 +02:00
Author
Member
Copy link

added 40m of time spent

added 40m of time spent
nik commented 2022-06-21 22:56:31 +02:00
Owner
Copy link

assigned to @nik and unassigned @magicfelix

assigned to @nik and unassigned @magicfelix
magicfelix commented 2022-06-22 12:38:44 +02:00
Author
Member
Copy link

added 1 commit

  • 44db172c - [Docs] Add config instructions

Compare with previous version

added 1 commit <ul><li>44db172c - [Docs] Add config instructions</li></ul> [Compare with previous version](/AlekSIS/official/AlekSIS-App-Matrix/-/merge_requests/11/diffs?diff_id=22268&start_sha=d0706cefec807b76092d623cfa3806000d1947fb)
magicfelix commented 2022-06-22 12:39:02 +02:00
Author
Member
Copy link

added 10m of time spent

added 10m of time spent
magicfelix commented 2022-06-22 21:33:05 +02:00
Author
Member
Copy link

added 1 commit

Compare with previous version

added 1 commit <ul><li>9debde47 - [Docs] Add sync docs</li></ul> [Compare with previous version](/AlekSIS/official/AlekSIS-App-Matrix/-/merge_requests/11/diffs?diff_id=22295&start_sha=44db172cdeda303c0f399c69b065d505a4201f24)
magicfelix commented 2022-06-22 21:33:20 +02:00
Author
Member
Copy link

added 20m of time spent

added 20m of time spent
magicfelix commented 2022-06-22 21:35:37 +02:00
Author
Member
Copy link

marked this merge request as ready

marked this merge request as **ready**
nik commented 2022-06-24 16:09:08 +02:00
Owner
Copy link
Log in to the Matrix account intended to use for AlekSIS synchronization and
open the settings via ``Profile picture → All Settings``.
Go to the tab ``Help & About`` and expand ``Access Token`` in the ``Advanced`` section.
The access token will be displayed and can be copied.

After that, do not log out of Element, because that would invalidate the access token.
You might want to use a private tab in your browser or clear session data afterwards.
```suggestion:-3+0 Log in to the Matrix account intended to use for AlekSIS synchronization and open the settings via ``Profile picture → All Settings``. Go to the tab ``Help & About`` and expand ``Access Token`` in the ``Advanced`` section. The access token will be displayed and can be copied. After that, do not log out of Element, because that would invalidate the access token. You might want to use a private tab in your browser or clear session data afterwards. ```
nik commented 2022-06-24 16:10:13 +02:00
Owner
Copy link

resolved all threads

resolved all threads
nik commented 2022-06-24 16:10:14 +02:00
Owner
Copy link

added 1 commit

  • 1ba2d17e - Add note about not logging out of Element

Compare with previous version

added 1 commit <ul><li>1ba2d17e - Add note about not logging out of Element</li></ul> [Compare with previous version](/AlekSIS/official/AlekSIS-App-Matrix/-/merge_requests/11/diffs?diff_id=22483&start_sha=9debde47e1097e2b6e8b721463e82fd04cc9e1d9)
nik commented 2022-06-25 12:38:26 +02:00
Owner
Copy link

Please add the following:

  • Description about what Matrix and Element are (in a 01_intro file or something)
  • List the features of rooms and spaces, and what this is logically usefule for (mapping the real structure of the school to Matrix cvhats; automatically update privileges in rooms e.g. for substitutions)
  • Add a screenshot of this synchronisation (can be obtained from @hansegucker's video sequence at FOSDEM)
  • Add a list with hints on where Matrix is to be found, e.g. school districts that provide Matrix/Element for their schools, LOGINBEO LMS)
Please add the following: * Description about what Matrix and Element are (in a 01_intro file or something) * List the features of rooms and spaces, and what this is logically usefule for (mapping the real structure of the school to Matrix cvhats; automatically update privileges in rooms e.g. for substitutions) * Add a screenshot of this synchronisation (can be obtained from @hansegucker's video sequence at FOSDEM) * Add a list with hints on where Matrix is to be found, e.g. school districts that provide Matrix/Element for their schools, LOGINBEO LMS)
magicfelix commented 2022-06-25 13:21:06 +02:00
Author
Member
Copy link

added 2 commits

  • ee2fbce3 - [Docs] Add sync screenshot
  • 773ba890 - [Docs] Explain Matrix and sync concepts

Compare with previous version

added 2 commits <ul><li>ee2fbce3 - [Docs] Add sync screenshot</li><li>773ba890 - [Docs] Explain Matrix and sync concepts</li></ul> [Compare with previous version](/AlekSIS/official/AlekSIS-App-Matrix/-/merge_requests/11/diffs?diff_id=22636&start_sha=1ba2d17e0e6c436350447cc17043376054b2a695)
nik commented 2022-06-25 14:36:34 +02:00
Owner
Copy link

mentioned in commit 42f94aa221

mentioned in commit 42f94aa221df24fba787e2276ef9860fbbea2d17
nik merged commit 42f94aa221 into master 2022-06-25 14:36:34 +02:00
magicfelix commented 2022-06-25 22:46:12 +02:00
Author
Member
Copy link

added 20m of time spent

added 20m of time spent
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels   
Security

   
TeX
Needs LaTeX template

  
auto-update
  
board
done

  
board
ready

  
board
todo

  
check
delete-eslint-rc-js

  
check
update-builddeps-package-json

  
check
update-eslint-rc-js

  
check
update-gitignore

  
check
update-merge-request-template

  
check
update-prettier-ignore

  
check
update-pyproject-toml

  
check
update-renovate-json

  
check
update-tox-ini

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

  
part
ci

  
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

  
prio
1
 Priority High

  
prio
2
 Priority Medium

  
prio
3
 Priority Low

  
release-mr-5.x
  
size
large

  
size
medium

  
size
small

  
source
customer
 Requested by a customer or affiliated user

  
source
customer::fsmw

  
source
customer::fss

  
source
customer::teckids

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

  
type
breaking

  
type
bug
 Bug

  
type
feature
 New feature

  
type
refactoring

  
workflow
blocked
 Issue is blocked by another issue

  
workflow
confirmed
 The bug is reproducible and will be fixed

  
workflow
current-todo

  
workflow
discussing
 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

  
source::aleksolotl
No labels
Security
TeX
auto-update
board
done
board
ready
board
todo
check
delete-eslint-rc-js
check
update-builddeps-package-json
check
update-eslint-rc-js
check
update-gitignore
check
update-merge-request-template
check
update-prettier-ignore
check
update-pyproject-toml
check
update-renovate-json
check
update-tox-ini
part
backend
part
ci
part
docs
part
frontend
part
i18n
part
non-technical
part
packaging
prio
1
prio
2
prio
3
release-mr-5.x
size
large
size
medium
size
small
source
customer
source
customer::fsmw
source
customer::fss
source
customer::teckids
source
downstream
type
breaking
type
bug
type
feature
type
refactoring
workflow
blocked
workflow
confirmed
workflow
current-todo
workflow
discussing
workflow
new-app
workflow
wontfix
source::aleksolotl
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
nik
2 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-App-Matrix!62
No description provided.