Fix markdown trailing whitespace & exlude .svg from trailing-whitespace checks (#148)

* .pre-commit-config.yaml: properly handle markdown and exclude svg from trailing-whitespace

* {CONTRIBUTING,docs/appservice}.md: remove trailing whitespace
This commit is contained in:
Aminda Suomalainen
2023-10-21 14:18:52 +03:00
committed by GitHub
parent 5738d764d4
commit 56e03e9ccb
3 changed files with 6 additions and 5 deletions

View File

@@ -8,7 +8,8 @@ repos:
rev: v4.5.0
hooks:
- id: trailing-whitespace
exclude_types: [markdown]
args: ["--markdown-linebreak-ext", "md"]
exclude_types: [svg]
- id: end-of-file-fixer
- id: check-yaml
- id: check-added-large-files

View File

@@ -224,7 +224,7 @@ However, any work which is used in any way to conduct business must
report all software being used by the buisness with this license,
all turnover made by the buisness, all profit made by the buisness
and an estimation of both profit and turnover made by the buisness in
relation to the collection of software reported.
relation to the collection of software reported.
It is not clear to me how often these figures should be reported
and when, or even where they should be reported to (ideally they could

View File

@@ -10,7 +10,7 @@ This guide assumes you will be using Docker and that you are able to provide a p
1. Create a new Matrix room that will act as a policy list for who can use the appservice.
FIXME: Currently required to be aliased.
FIXME: Should really be created and managed by the admin room, but waiting for command refactor before doing that.
FIXME: Should really be created and managed by the admin room, but waiting for command refactor before doing that.
2. Decide on a spare local TCP port number to use that will listen for messages from the matrix homeserver. Take care to configure firewalls appropriately. We will call this port `$MATRIX_PORT` in the remaining instructions.
@@ -18,11 +18,11 @@ This guide assumes you will be using Docker and that you are able to provide a p
4. Generate the appservice registration file. This will be used by both the appservice and your homeserver.
Here, you must specify the direct link the Matrix Homeserver can use to access the appservice, including the Matrix port it will send messages through (if this bridge runs on the same machine you can use `localhost` as the `$HOST` name):
`docker run --rm -v /your/path/to/draupnir-data:/data gnuxie/draupnir appservice -r -u "http://$HOST:$MATRIX_PORT" -f /data/config/draupnir-registration.yaml`
5. Step 4 created an application service bot. This will be a bot iwth the mxid specified in `draupnir-registration.yaml` under `sender_localpart`. You now need to invite it in the access control room that you have created in Step 1.
6. Start the application service `docker run -v /your/path/to/draupnir-data/:/data/ gnuxie/draupnir appservice -c /data/config/config.appservice.yaml -f /data/config/draupnir-registration.yaml -p $MATRIX_PORT`
7. Copy the `draupnir-registration.yaml` to your matrix homeserver and refer to it in `homeserver.yaml` like so: