From 6583feb87d93eee008c2a2eb0d7100ce52f34668 Mon Sep 17 00:00:00 2001 From: Thomas Sileo Date: Tue, 15 Nov 2022 22:17:55 +0100 Subject: [PATCH] Tweak the documentation about contributions --- README.md | 2 +- docs/developer_guide.md | 21 +++++++++++++++++++++ docs/user_guide.md | 7 ++++--- 3 files changed, 26 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 3a6ef5f..af9f6ec 100644 --- a/README.md +++ b/README.md @@ -58,7 +58,7 @@ All the development takes place on [sourcehut](https://sr.ht/~tsileo/microblog.p - [Issue tracker](https://todo.sr.ht/~tsileo/microblog.pub) - [Mailing list](https://sr.ht/~tsileo/microblog.pub/lists) -Contributions are welcomed, check out the [documentation](https://docs.microblog.pub) for more details. +Contributions are welcomed, check out the [documentation](https://docs.microblog.pub/developer_guide.html#documentation) for more details. ## License diff --git a/docs/developer_guide.md b/docs/developer_guide.md index 14af14d..ef777ba 100644 --- a/docs/developer_guide.md +++ b/docs/developer_guide.md @@ -58,3 +58,24 @@ And check out the result by starting a static server using Python standard libra cd docs/dist python -m http.server 8001 ``` + +## Contributing + +Contributions/patches are welcome, but please start a discussion in a [ticket](https://todo.sr.ht/~tsileo/microblog.pub) or a [thread in the mailing list](https://lists.sr.ht/~tsileo/microblog.pub-devel) before working on anything consequent. + +### Patches + +Please ensure your code passes the code quality checks: + +```bash +inv autoformat +inv lint +``` + +And that the tests suite is passing: + +```bash +inv tests +``` + +Please also consider adding new test cases if needed. diff --git a/docs/user_guide.md b/docs/user_guide.md index 51ad9c1..96d9836 100644 --- a/docs/user_guide.md +++ b/docs/user_guide.md @@ -465,6 +465,7 @@ make self-destruct If the server is not (re)starting, you can: - - [Ensure that the configuration is valid](/user_guide.html#configuration-checking) - - [Verify if you haven't any syntax error in the custom theme by recompiling the CSS](/user_guide.html#recompiling-css-files) - - Look at the log files + - [Ensure that the configuration is valid](/user_guide.html#configuration-checking). + - [Verify if you haven't any syntax error in the custom theme by recompiling the CSS](/user_guide.html#recompiling-css-files). + - Look at the log files (in `data/uvicorn.log`, `data/incoming.log` and `data/outgoing.log`). + - If the CSS is not working, ensure your reverse proxy is serving the static file correctly.