Skip to content

Commit 9535ec0

Browse files
authored
Mention Codeberg after complaining on GitHub
1 parent 138e0d0 commit 9535ec0

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

docs/documentation.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,9 @@ The goal for this setup of the documentation was to make it simple to update to
6565

6666
The web pages are generated with MkDocs, because it uses Python which most colleagues already know. The alternatives used by related projects like GitBook (for MAVLink Dev Guide) are not free anymore, and VuePress (for PX4) requires NodeJS. Initially the more popular Sphinx was chosen, but didn't play nicely with Markdown files. This was deemed more important, since we already use it for a README.md file in every repository, is much more popular than reStructured Text, and has simpler syntax.
6767

68-
Hosting the page through GitHub Pages and building through GitHub Actions mean there are no dedicated servers needed to be maintained by users. A fully open-source solution independent of a specific for-profit company would be preferred, but at least this can serve as introduction to contributing to other software outside of the University.
68+
Hosting the page through GitHub Pages and building through GitHub Actions mean there are no dedicated servers needed to be maintained by users.
69+
A fully open-source solution independent of a specific for-profit company would be preferred, but at least this can serve as introduction to contributing to other software outside of the University.
70+
For new open-source projects, the authors recommend [Codeberg](https://codeberg.org/) operated by a German non-profit.
6971

7072
An early goal for documentation of the dialect was to provide a user experience very close to using the standard messages. The files for MAVLink definitions are re-generated every time the page is published, but can also be updated in the repository. This was chosen to keep the repository simple (no submodules), and always up to date with the newest definitions in the fork. The generated content isn't ignored by git, so the results are the same when working with the repository offline.
7173

0 commit comments

Comments
 (0)