Commit graph

5 commits

Author SHA1 Message Date
Daniel Scally
182bdadd0f Documentation: Add documentation-contents.rst
Add a new .rst file referencing the documentation contents. This file
is then included in each documentation page so that we can enhance
the Documentation pages on the libcamera website using it. As we do
not want the appearance of the libcamera in-tree Documentation to
change just yet, disable the new class using the sphinx theme's CSS.

To facilitate easier distinguishing between "normal" and
documentation pages on the website we want to add a "documentation"
class to the content of all such pages. Since this new file will be
included on each documentation page it is convenient to add the new
directive here - do so. As the website uses different CSS to
libcamera, move the contents on docs.rst a little so that the
directive at the end of the contents block applies correctly.

Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Signed-off-by: Daniel Scally <dan.scally@ideasonboard.com>
Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
2024-08-21 01:35:24 +03:00
Laurent Pinchart
e25003e78b Documentation: contributing: Integrate the code of conduct
Now that libcamera has an official code of conduct, mention it in the
'contributing' document with a clear indication that all community
members are expected to follow the code of conduct.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
2023-11-25 19:01:07 +02:00
Laurent Pinchart
cfb7a260e9 Documentation: code-of-conduct: Add contact information
Replace the boilerplate "[INSERT EMAIL ADDRESS]" contact information
with conduct@libcamera.org, and indicate that the people behind that
e-mail address can also be contacted directly if needed. The direct
contact information aims at offering more confidence to reporters than
an anonymous mail alias in case they wish to report an issue with one of
the core project members.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
2023-11-25 18:56:32 +02:00
Laurent Pinchart
f285ce9c54 Documentation: code-of-conduct: Add license information
The Contributor Covenant is covered by the CC-BY-4.0 license. Indicate
this in the file.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
2023-11-25 18:56:20 +02:00
Laurent Pinchart
62956b34eb Documentation: code-of-conduct: Convert to reStructuredText
All documentation in libcamera is in reStructuredText format. Convert
the code of conduct from Markdown. No change in the contents is
intended.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
2023-11-25 18:55:57 +02:00
Renamed from Documentation/code_of_conduct.md (Browse further)