moanos/Notfellchen
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: various

Browse Source
This commit is contained in:
moanos [he/him] 2025-01-18 09:07:33 +01:00
parent 53e6db3655
commit 3b79809b8c
3 changed files with 10 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/API/index.rst
View File

@ -36,6 +36,11 @@ An application can then send this token in the request header for authorization.
Endpoints Endpoints
--------- ---------
All Endpoints are documented at https://notfellchen.org/api/schema/swagger-ui/ or at https://notfellchen.org/api/schema/redoc/ if you prefer redoc.
The OpenAI schema can be downloaded at https://notfellchen.org/api/schema/
Examples are documented here.
Get Adoption Notices Get Adoption Notices
++++++++++++++++++++ ++++++++++++++++++++

4
docs/dev/contributing.rst
View File

@ -5,7 +5,7 @@ Report a bug
^^^^^^^^^^^^ ^^^^^^^^^^^^
To report a bug, file an issue on `Github To report a bug, file an issue on `Github
<https://codeberg.org/moanos/notfellchen/issues>`_ <https://github.com/moan0s/notfellchen/issues>`_
Try to include the following information: Try to include the following information:
@ -29,7 +29,7 @@ To contribute simply clone the directory, make your changes and file a
pull request. pull request.
If you want to know what can be done, have a look at the current `Github If you want to know what can be done, have a look at the current `Github
<https://codeberg.org/moanos/notfellchen/issues>`_. <https://github.com/moan0s/notfellchen/issues>`_.
Get in touch! Get in touch!
^^^^^^^^^^^^^ ^^^^^^^^^^^^^

7
docs/dev/release.rst
View File

@ -5,8 +5,7 @@ What qualifies as release?
^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^
A new release should be announced when a significant number functions, bugfixes or other improvements to the software A new release should be announced when a significant number functions, bugfixes or other improvements to the software
is made. Usually this indicates a minor release. is made. Notfellchen follows `Semantic Versioning <https://semver.org/>`_.
Major releases are yet to be determined.
What should be done before a release? What should be done before a release?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -14,7 +13,7 @@ What should be done before a release?
Tested basic functions Tested basic functions
###################### ######################
Run :command:`pytest` Run :command:`nf test src`
Test upgrade on a copy of a production database Test upgrade on a copy of a production database
############################################### ###############################################
@ -38,4 +37,4 @@ Do a final commit on this change, and tag the commit as release with appropriate
git tag -a v1.0.0 -m "Releasing version v1.0.0" git tag -a v1.0.0 -m "Releasing version v1.0.0"
git push origin v1.0.0 git push origin v1.0.0
Make sure the tag is visible on Codeberg and celebrate 🥳 Make sure the tag is visible on GitHub/Codeberg and celebrate 🥳