42bce45292
- mention need for personal fork repo early on - it's fine to just file a Merge Request without an issue - add section about updating Merge Requests and review workflow - use canonical names for 'freedesktop' and 'GitLab' Fixes #24 |
||
---|---|---|
examples | ||
images | ||
markdown | ||
plugins-introspection | ||
theme | ||
.gitignore | ||
.gitlab-ci.yml | ||
.gitmodules | ||
LICENSE.BSD | ||
LICENSE.CC-BY-SA-4.0 | ||
LICENSE.LGPL-2.1 | ||
LICENSE.MIT | ||
LICENSE.OPL | ||
meson.build | ||
README.md | ||
sitemap.txt | ||
TODO.md |
Introduction
This is a collection of design documents, formerly maintained in various different locations and formats, now grouped together and converted to commonmark.
Contributing
Style
We will follow the commonmark specification.
We should try to follow this style guide, but are still evaluating solutions for stable automatic formatting.
80 columns line width is thus not yet enforced, but strongly suggested.
Build a web portal from the sources
Install dependencies
-
Follow hotdoc's installation guide, preferably in a virtualenv.
-
We experimentally use the hotdoc C extension to include functions by name, follow the steps outlined here
-
Build the portal:
make
- And browse it:
gio open built_doc/html/index.html
Licensing
The content of this module comes from a number of different sources and is licensed in different ways:
Tutorial source code
All tutorial code is licensed under any of the following licenses (your choice):
- 2-clause BSD license ("simplified BSD license") (
LICENSE.BSD
) - MIT license (
LICENSE.MIT
) - LGPL v2.1 (
LICENSE.LGPL-2.1
)
This means developers have maximum flexibility and can pick the right license for any derivative work.
Application Developer Manual and Plugin Writer's Guide
These are licensed under the Open Publication License v1.0
(LICENSE.OPL
), for historical reasons.
Documentation
Mostly licensed under the Creative Commons CC-BY-SA-4.0 license, but some parts of the documentation may still be licensed differently (e.g. LGPLv2.1) for historical reasons.