Codeberg/Documentation

Fork 161

Riddle45 added 159 commits 2023年06月25日 04:18:48 +02:00

This PR improves the SSH key article, removes the part where email is used as a label (newcomers might think this is mandatory and leak their email) and changes the public key type to a more secure ed25519.
Reviewed-on: #161
Co-authored-by: n <n@noreply.codeberg.org>
Co-committed-by: n <n@noreply.codeberg.org>

Moving "releases in Codeberg" as discussed in #151
Reviewed-on: #163
Co-authored-by: Gerhard Beck <gerhard.beck@elkb.de>
Co-committed-by: Gerhard Beck <gerhard.beck@elkb.de>

copied "Mission" section from https://blog.codeberg.org/codebergorg-launched.html 

This makes the URLs redirect to the default branch of the repo

Co-authored-by: fnetX <git@fralix.ovh>
Reviewed-on: #166
Co-authored-by: Otto Richter <fnetx@noreply.codeberg.org>
Co-committed-by: Otto Richter <fnetx@noreply.codeberg.org>

Co-authored-by: Michiel Appelman <michiel@appelman.se>
Reviewed-on: #169
Co-authored-by: mike <michielappelman@noreply.codeberg.org>
Co-committed-by: mike <michielappelman@noreply.codeberg.org>

Reviewed-on: #172 

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.

Reviewed-on: #173 

* Adding link to netcup GmbH
* Adding link to liberapay donation page

Makes it easier to find the ssh fingerprints from the title alone.
Co-authored-by: Reynir Björnsson <reynir@reynir.dk>
Reviewed-on: #179
Co-authored-by: reynir <reynir@noreply.codeberg.org>
Co-committed-by: reynir <reynir@noreply.codeberg.org>

Reviewed-on: #180 

This is a question that is raised repeatedly in the community tracker or matrix.
Co-authored-by: René W <rwa@clttr.info>
Reviewed-on: #187
Co-authored-by: René W. <rwa@clttr.info>
Co-committed-by: René W. <rwa@clttr.info>

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: #189
Co-authored-by: Otto Richter <fnetx@noreply.codeberg.org>
Co-committed-by: Otto Richter <fnetx@noreply.codeberg.org>

Reduces line width in main text area to increase readability
fixes #183
Reviewed-on: #184
Co-authored-by: lukaskluge <lukaskluge@noreply.codeberg.org>
Co-committed-by: lukaskluge <lukaskluge@noreply.codeberg.org>

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: #198
Co-authored-by: ka2in <ka2in@noreply.codeberg.org>
Co-committed-by: ka2in <ka2in@noreply.codeberg.org>

Fixes: #201
Reviewed-on: #203
Co-authored-by: René Schaar <rene@schaar.priv.at>
Co-committed-by: René Schaar <rene@schaar.priv.at>

- 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 

- 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: #206
Co-authored-by: Gusted <gusted@noreply.codeberg.org>
Co-committed-by: Gusted <gusted@noreply.codeberg.org>

Text is according to the discussion on the issue #174.
Co-authored-by: Thomas Kramer <code@tkramer.ch>
Reviewed-on: #181
Co-authored-by: tok <tok@noreply.codeberg.org>
Co-committed-by: tok <tok@noreply.codeberg.org>

Co-authored-by: Arnout Engelen <arnout@bzzt.net>
Reviewed-on: #207
Co-authored-by: Arnout Engelen <raboof@noreply.codeberg.org>
Co-committed-by: Arnout Engelen <raboof@noreply.codeberg.org>

Only did some minor changes (most of them are formatting) and resolving all conversations from #181
Reviewed-on: #208
Co-authored-by: René Schaar <rene@schaar.priv.at>
Co-committed-by: René Schaar <rene@schaar.priv.at>

Link to the bylaws from the documentation.
Improves on #191 

as proposed by infinitelight in #185
I put the proposed changes into a PR to continue handling #185
Co-authored-by: Jan Klippel <c0d3b3rg@kl1pp3l.de>
Reviewed-on: #211
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: #214
Co-authored-by: jklippel <jklippel@noreply.codeberg.org>
Co-committed-by: jklippel <jklippel@noreply.codeberg.org>

- 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: #213
Co-authored-by: jklippel <jklippel@noreply.codeberg.org>
Co-committed-by: jklippel <jklippel@noreply.codeberg.org>

Add documentation of .gitignore to reduce clutter in Codeberg.
Fixes #117 

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

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.

Edit and review of the article about email settings
Co-authored-by: Faycal Alami-Hassani <ka2in@protonmail.com>
Reviewed-on: #215
Co-authored-by: ka2in <ka2in@noreply.codeberg.org>
Co-committed-by: ka2in <ka2in@noreply.codeberg.org>

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: #221
Co-authored-by: jklippel <jklippel@noreply.codeberg.org>
Co-committed-by: jklippel <jklippel@noreply.codeberg.org>

Add a note that tags need to be pushed to the remote target.
Please let me know, if you have any suggestions to improve the wording and this paragraph.
Reviewed-on: #228
Co-authored-by: mutluyuz <mutluyuz@noreply.codeberg.org>
Co-committed-by: mutluyuz <mutluyuz@noreply.codeberg.org>

Combining [Clone & Commit via HTTP] & [Clone & Commit via SSH] to [Clone & Commit via CLI] because it goes to the same URL.
Signed-off-by: Fauzi Ramadaniza <faustzero1@noreply.codeberg.org>

Co-authored-by: Faycal Alami-Hassani <ka2in@protonmail.com>
Co-authored-by: ka2in <ka2in@protonmail.com>
Reviewed-on: #223
Co-authored-by: ka2in <ka2in@noreply.codeberg.org>
Co-committed-by: ka2in <ka2in@noreply.codeberg.org>

Fixes: #232 

Actually display the Markdown syntax to use when writing a note or a warning

Initial version of an article on conflict resolution
Fixes: #14 

There is a minor factual error in "What is Codeberg?". The third paragraph states that Codeberg is not a corporation. Well actually ..., Codeberg as a "eingetragener Verein" (German for "registered association" or "incorporated association") very much *is* a corporation. And so, that part of the sentence has either to be removed or at least has to be qualified in some way. This commit does the latter.

Initial version of an article on LFS
Fixes: #133 

Format notes and caveats according to style guide

Related to Codeberg/pages-server#102 

Current link implementation (on https://docs.codeberg.org/improving-codeberg/#donate-to-codeberg) leads to https://docs.codeberg.org/improving-codeberg/content/improving-documentation/docs-contributor-faq.md, not the correct https://docs.codeberg.org/improving-documentation/docs-contributor-faq/
Co-authored-by: Mark E. Fuller <fuller@fedoraproject.org>
Reviewed-on: #246
Co-authored-by: Mark E. Fuller <fuller@noreply.codeberg.org>
Co-committed-by: Mark E. Fuller <fuller@noreply.codeberg.org>

This PR switches the Font Awesome icons to use SVG instead of a font, and updates it to v6.
~~Depends on Codeberg-Infrastructure/codeberg-fonts#13 getting deployed.~~ Now deployed.
Reviewed-on: #243
Co-authored-by: n <n@noreply.codeberg.org>
Co-committed-by: n <n@noreply.codeberg.org>

With inclusion of changes after feedback from Gusted

close Codeberg-CI/feedback#44
Co-authored-by: 6543 <6543@obermui.de>
Reviewed-on: #237
Co-authored-by: 6543 <6543@noreply.codeberg.org>
Co-committed-by: 6543 <6543@noreply.codeberg.org>

Reviewed-on: #249 

Co-authored-by: Loïc Dachary <loic@dachary.org>
Reviewed-on: #254
Co-authored-by: Loïc Dachary <dachary@noreply.codeberg.org>
Co-committed-by: Loïc Dachary <dachary@noreply.codeberg.org>

* `build-deploy-gitea` is not legacy in the sense that it still is in
 use
* replace "it" with `build-deploy-gitea` for clarity.
Signed-off-by: Loïc Dachary <loic@dachary.org>
Co-authored-by: Loïc Dachary <loic@dachary.org>
Reviewed-on: #253
Co-authored-by: Loïc Dachary <dachary@noreply.codeberg.org>
Co-committed-by: Loïc Dachary <dachary@noreply.codeberg.org>

Reviewed-on: #256 

add line to explain that a git push is necessary
Fixes #242
Co-authored-by: Jan Klippel <c0d3b3rg@kl1pp3l.de>
Reviewed-on: #257
Co-authored-by: jklippel <jklippel@noreply.codeberg.org>
Co-committed-by: jklippel <jklippel@noreply.codeberg.org>

Changes:
 * Fallback images links are all lowercase now.
 * Fix html redirect (meta tag http-equiv redirect) from ```/git/clone-commit-via-http ```to ```/git/clone-commit-via-web```.
 * Added protocol to an email link.
 * Fix some pages links.
To detect broken links I used wget:
```
wget --spider --recursive --level=0 --debug -e robots=off --base=http://localhost:8080 http://localhost:8080 2>&1 | grep ^Found\ [0-9]*\ broken\ link
```
However, wget detects html redirects (meta tag http-equiv refresh) as false positive.
If broken links have found, then the referer header will be searched for find out where they are:
```
wget --spider --recursive --level=0 --save-headers --debug -e robots=off --base=http://localhost:8080 http://localhost:8080 2>&1 | less
```
Co-authored-by: fsologureng <sologuren@estudiohum.cl>
Reviewed-on: #267
Co-authored-by: Felipe Leopoldo Sologuren Gutiérrez <fsologureng@noreply.codeberg.org>
Co-committed-by: Felipe Leopoldo Sologuren Gutiérrez <fsologureng@noreply.codeberg.org>

Updated Mastodon URL, because the account has moved to https://social.anoxinon.de/ 

This reverts commit a4e17f1ad1.

Signed-off-by: CameronNemo <cameronnemo@noreply.codeberg.org>

closes #275 

closes #275 

Replace the mentions of Gitea in the Codeberg projects list
with Forgejo as Codeberg is now based on the Forgejo soft fork of Gitea.
Fixes: #286 

This adds a Documentation for connecting Codeberg to [Read the Docs](https://readthedocs.org/). English is not my native Language, so there may be a few things that could be written better.
Co-authored-by: René Wagner <rwa@clttr.info>
Reviewed-on: #289
Co-authored-by: JakobDev <jakobdev@gmx.de>
Co-committed-by: JakobDev <jakobdev@gmx.de>

This replaces the project table in the "Improving Codeberg" section with a link to the new Codeberg/Projects repository.
Reviewed-on: #292
Co-authored-by: Lucas Hinderberger <mail@lucas-hinderberger.de>
Co-committed-by: Lucas Hinderberger <mail@lucas-hinderberger.de>

Co-authored-by: RobWalt <robwalter96@gmail.com>
Reviewed-on: #285
Co-authored-by: RobWalt <robwalt@noreply.codeberg.org>
Co-committed-by: RobWalt <robwalt@noreply.codeberg.org>

This provides more detail when using ALIAS+TXT DNS records.
More context: https://matrix.to/#/!wkyjxWeAOBpKMvHbno:matrix.org/$Z0mdXrDKTNptIBpENaeZKd9WuuMWhCrawgIWsNjJjXo?via=freeyourgadget.org&via=matrix.org&via=tchncs.de
Reviewed-on: #293
Co-authored-by: Isaac Beverly <imbev@noreply.codeberg.org>
Co-committed-by: Isaac Beverly <imbev@noreply.codeberg.org>

This PR was created in a hurry -- it was created after a person in the Codeberg Matrix room asked for an explicit clarification.
Co-authored-by: Panagiotis "Ivory" Vasilopoulos <git@n0toose.net>
Reviewed-on: #297
Co-authored-by: n0toose <git@n0toose.net>
Co-committed-by: n0toose <git@n0toose.net>

We noticed that there is an application with the name `cod` already in available as a package in many distros and decided to rename the binary to `berg`. This PR just updates the section about `codeberg-cli` to use the new binary name.
Co-authored-by: RobWalt <robwalter96@gmail.com>
Reviewed-on: #299
Co-authored-by: RobWalt <robwalt@noreply.codeberg.org>
Co-committed-by: RobWalt <robwalt@noreply.codeberg.org>

Documentation for redirects on Codeberg Pages:
Codeberg/pages-server#148
Co-authored-by: video-prize-ranch <cb.8a3w5@simplelogin.co>
Co-authored-by: 6543 <6543@obermui.de>
Reviewed-on: #294
Co-authored-by: video-prize-ranch <video-prize-ranch@noreply.codeberg.org>
Co-committed-by: video-prize-ranch <video-prize-ranch@noreply.codeberg.org>

This feature was added in this Gitea PR: https://github.com/go-gitea/gitea/issues/16111
Co-authored-by: Martin Stone <martin@d7415.co.uk>
Reviewed-on: #306
Co-authored-by: d7415 <martin@d7415.co.uk>
Co-committed-by: d7415 <martin@d7415.co.uk>

I just went through these steps and noticed that the message is wrong, so here's the update. Note that the message normally shows the username and key name, which I've replaced with "____".
Reviewed-on: #307
Co-authored-by: NeatNit <neatnit@noreply.codeberg.org>
Co-committed-by: NeatNit <neatnit@noreply.codeberg.org>

Fixes Codeberg/Community#1001 (comment)
Co-authored-by: Panagiotis "Ivory" Vasilopoulos <git@n0toose.net>
Reviewed-on: #305
Co-authored-by: Panagiotis "Ivory" Vasilopoulos <n0toose@noreply.codeberg.org>
Co-committed-by: Panagiotis "Ivory" Vasilopoulos <n0toose@noreply.codeberg.org>

fnetX added 1 commit 2023年07月02日 20:14:37 +02:00

fnetX added 1 commit 2023年07月04日 23:02:23 +02:00

This is a simple documentation for Codeberg Translate. I think it can be improved in some points (especially the wording), but it should be a good start.
Closes: #273
Reviewed-on: #300
Co-authored-by: JakobDev <jakobdev@gmx.de>
Co-committed-by: JakobDev <jakobdev@gmx.de>

fnetX closed this pull request 2023年07月05日 11:14:54 +02:00

Sign in to join this conversation.

Clear labels

Codeberg Pages

Issues affecting Codeberg Pages

Documentation Usability

Issues related to using and reading docs.codeberg.org

Forgejo

Good First Issue! 👋

Kind: Bug

Kind: Documentation

Kind: Enhancement

Kind: Feature

Kind: Question

Kind: Security

Licensing

Part: Generator

This is related to the generation of the documentation, not to the content itself

Priority: High

The priority is high

Priority: Low

The priority is low

Priority: Medium

The priority is medium

Reviewed: Confirmed

Something has been confirmed

Reviewed: Duplicate

Something exists already

Reviewed: Invalid

Something was marked as invalid

Reviewed: Wontfix

Something won't be fixed

Status: Blocked

Status: Help wanted

Contributions are welcome!

Status: In progress

Work is in progress

Status: Needs feedback

Feedback is needed

Status: Ready for Review

Work is completed

Status: Review

Review is in progress / Reviewers wanted

Status: Stale

Milestone

No milestone

Subscribe

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".