Add initial version of a Markdown documentation to explain Markdown to new contributors. Also provides a styleguide to guide to a consistent use of the Markdown markup within Codeberg.
Fixes#59
Co-authored-by: Jan Klippel <c0d3b3rg@kl1pp3l.de>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/221
Co-authored-by: jklippel <jklippel@noreply.codeberg.org>
Co-committed-by: jklippel <jklippel@noreply.codeberg.org>
Extract important articles from the now lengthy FAQ.
This helps to find the documented basics.
Move the Docs-Contributor-FAQ to the new documentation section.
Use a container to preview the documentation for those of us who cannot or do not want to install npm/nodejs on their machines.
- Add a Dockefile to create a docker image containing nodejs and the software needed to serve the documentation
- Extend README.md with the option to use the Dockerfile to preview the documentation
- Document how to change the eMail settings
- Document which situations automatically lead to being subscribed and
receiving mails
Improves on #153
Co-authored-by: Jan Klippel <c0d3b3rg@kl1pp3l.de>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/213
Co-authored-by: jklippel <jklippel@noreply.codeberg.org>
Co-committed-by: jklippel <jklippel@noreply.codeberg.org>
- Initial section introducing CI
- Section on woodpecker on codeberg with a link to the request-access repository which already has good documentation on the current status of the Codeberg-CI
Related to #168
Co-authored-by: Jan Klippel <c0d3b3rg@kl1pp3l.de>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/214
Co-authored-by: jklippel <jklippel@noreply.codeberg.org>
Co-committed-by: jklippel <jklippel@noreply.codeberg.org>
Only did some minor changes (most of them are formatting) and resolving all conversations from #181
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/208
Co-authored-by: René Schaar <rene@schaar.priv.at>
Co-committed-by: René Schaar <rene@schaar.priv.at>
Text is according to the discussion on the issue #174.
Co-authored-by: Thomas Kramer <code@tkramer.ch>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/181
Co-authored-by: tok <tok@noreply.codeberg.org>
Co-committed-by: tok <tok@noreply.codeberg.org>
- Update the wording of gpg-key.md(ssh-key.md's wording is already nicely done). To be more fluent and have a better explanation.
- Add a section to verify the GPG & SSH key.
- Add step for git to sign new commits by-default.
- Resolves#177
Co-authored-by: Gusted <williamzijl7@hotmail.com>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/206
Co-authored-by: Gusted <gusted@noreply.codeberg.org>
Co-committed-by: Gusted <gusted@noreply.codeberg.org>
- Rework the permission article, by splitting it into 2 new category's.
The current information would be within the Collaborators section, as
that hasn't changed. The new section is mostly concerned for the new
permissions system that is used for teams. It covers all the permissions
and values that can be selected.
- Resolves#204
How to implement [Docs-as-Code](https://docs-as-co.de/) with the help of Sphinx and Codeberg Pages.
Co-authored-by: Faycal Alami-Hassani <ka2in@protonmail.com>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/198
Co-authored-by: ka2in <ka2in@noreply.codeberg.org>
Co-committed-by: ka2in <ka2in@noreply.codeberg.org>
Reduces line width in main text area to increase readability
fixes#183
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/184
Co-authored-by: lukaskluge <lukaskluge@noreply.codeberg.org>
Co-committed-by: lukaskluge <lukaskluge@noreply.codeberg.org>
a bunch of (typo) fixes, additions, rewordings
Update references
- remove mentions of the master branch, as it's removed for many repos
and might change in the future for others (fixes some dead links)
- remove mentions of moved repos with our official examples
- some on-the-fly additions or rewordings
Close#186 foobar->examples
Co-authored-by: fnetx <git@fralix.ovh>
Co-authored-by: fnetX <git@fralix.ovh>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/189
Co-authored-by: Otto Richter <fnetx@noreply.codeberg.org>
Co-committed-by: Otto Richter <fnetx@noreply.codeberg.org>
This is a question that is raised repeatedly in the community tracker or matrix.
Co-authored-by: René W <rwa@clttr.info>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/187
Co-authored-by: René W. <rwa@clttr.info>
Co-committed-by: René W. <rwa@clttr.info>
Makes it easier to find the ssh fingerprints from the title alone.
Co-authored-by: Reynir Björnsson <reynir@reynir.dk>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/179
Co-authored-by: reynir <reynir@noreply.codeberg.org>
Co-committed-by: reynir <reynir@noreply.codeberg.org>
Looking of course for feedback on this, as I am not an expert on this at
all. This does capture some of the questions I had when starting to look
into licensing.
