Add more documentation on appservices and admin-room #122

Open
opened 2021-08-06 18:50:55 +00:00 by stefan240 · 3 comments
stefan240 commented 2021-08-06 18:50:55 +00:00 (Migrated from gitlab.com)

Better documentation on appservices

So I had some time to play around with conduit today. I really like the approach to appservices in conduit and got some stuff running. The setup process is pretty straight-forward. But I think the documentation might need some improvements. I know this may not be that important right now, but should be noted.

Some things on the documentation (on the admin-room and appservices) that I think might need to be included. (at least I did not find them in the doc):

  • How can I remove a registered appservice? Say in the event I misconfigured something and needed to start from scratch on an appservice. How can I remove and add an appservice again?
  • Does an appservice get overridden when I add it a second time with only the tokens changed for example?
  • Add a doc for the admin-room and what you can do in it. Maybe also add a help command to the admin-room that shows that info if not already there.

Thank you for all your hard work on this. Really liking it so far.

<!-- If you want to report a bug or an error, then please consider filling out a "Bug Report" instead! --> ### Better documentation on appservices So I had some time to play around with conduit today. I really like the approach to appservices in conduit and got some stuff running. The setup process is pretty straight-forward. But I think the documentation might need some improvements. I know this may not be that important right now, but should be noted. Some things on the documentation (on the admin-room and appservices) that I think might need to be included. (at least I did not find them in the doc): - How can I remove a registered appservice? Say in the event I misconfigured something and needed to start from scratch on an appservice. How can I remove and add an appservice again? - Does an appservice get overridden when I add it a second time with only the tokens changed for example? - Add a doc for the admin-room and what you can do in it. Maybe also add a help command to the admin-room that shows that info if not already there. Thank you for all your hard work on this. Really liking it so far.
timokoesters commented 2021-08-18 08:20:19 +00:00 (Migrated from gitlab.com)

Thanks for opening an issue!

There is no command to remove an appservice currently, but you can override one by reusing the same appservice id

The admin room code probably should be refactored so we can easily add more commands and documentation for them. Maybe we can even use one of rusts CLI libraries.

Thanks for opening an issue! There is no command to remove an appservice currently, but you can override one by reusing the same appservice id The admin room code probably should be refactored so we can easily add more commands and documentation for them. Maybe we can even use one of rusts CLI libraries.
abyxcos commented 2021-10-04 23:52:52 +00:00 (Migrated from gitlab.com)

mentioned in issue #171

mentioned in issue #171
Thatoo commented 2023-08-16 07:07:06 +00:00 (Migrated from gitlab.com)

mentioned in issue #103

mentioned in issue #103
Sign in to join this conversation.
No labels
Android
CS::needs customer feedback
CS::needs follow up
CS::needs on prem installation
CS::waiting
Chrome
Design:: Ready
Design:: in progress
Design::UX
E2EE
Edge
Firefox
GDPR
Iteration 13 IM
Linux
MacOS
Need::Discussion
Need::Steps to reproduce
Need::Upstream fix
Needs:: Planning
Needs::Dev-Team
Needs::More information
Needs::Priority
Needs::Product
Needs::Refinement
Needs::Severity
Priority::1-Critical
Priority::2-Max
Priority::3-Impending
Priority::4-High
Priority::5-Medium
Priority::6-Low
Priority::7-None
Progress::Backlog
Progress::Review
Progress::Started
Progress::Testing
Progress::Triage
Progress::Waiting
Reporter::Sentry
Safari
Target::Community
Target::Customer
Target::Internal
Target::PoC
Target::Security
Team:Customer-Success
Team:Design
Team:Infrastructure
Team:Instant-Messaging
Team:Product
Team:Workflows
Type::Bug
Type::Design
Type::Documentation
Type::Feature
Type::Improvement
Type::Support
Type::Tests
Windows
blocked
blocked-by-spec
cla-signed
conduit
contribution::advanced
contribution::easy
contribution::help needed
from::review
iOS
p::ti-tenant
performance
product::triage
proposal
refactor
release-blocker
s: dart_openapi_codegen
s::Famedly-Patient
s::Org-Directory
s::Passport-Generator
s::Requeuest
s:CRM
s:Famedly-App
s:Famedly-Web
s:Fhiroxide
s:Fhiroxide-cli
s:Fhiroxide-client
s:Fhirs
s:Hedwig
s:LISA
s:Matrix-Dart-SDK
s:Role-Manager
s:Synapse
s:User-Directory
s:WFS-Matrix
s:Workflow Engine
s:dtls
s:famedly-error
s:fcm-shared-isolate
s:matrix-api-lite
s:multiple-tab-detector
s:native-imaging
severity::1
severity::2
severity::3
severity::4
technical-debt
voip
No milestone
No project
No assignees
1 participant
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: Matthias/conduit#122
No description provided.