Related issue: https://codeberg.org/Codeberg/Documentation/issues/330
This is my attempt at adding admonition-like boxes to the documentation. The goal is to make important stuff stand out more (especially warnings and alike).
The system uses a custom `<admonition>` box which allows classes for further customization. I.e. `<admonition class="warning">` to display a warning box.
I first wanted to make individual boxes (`<warning>`, `<note>`, ...) but decided against it, as it would've created a lot of duplicate CSS.
The CSS is designed in such a way that the first paragraph of the box is made bold (font-weight 700) while any subsequent ones are not.
The following forms of admonitions are included:
- Info (default)
- Note
- Tip
- Warning
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/337
Co-authored-by: Andre601 <github@andre601.ch>
Co-committed-by: Andre601 <github@andre601.ch>
The language was simplified, some explanations as to which methods are
preferred for which situations were provided, and I also added an
explanation for the new "tag @moderation to report spam" feature.
I tried to make the content less ambiguous and easier to read.
This change was made because of the following issue in the Community
repository: https://codeberg.org/Codeberg/Community/issues/1293
- Create two sections, "Codeberg's Structures" and "Before I move..."
- Explain that Codeberg is not necessarily *just* a Forgejo instance
by mentioning / crediting more open-source projects in a
non-exhaustive manner.
- Improve wording and phrasing of some questions
- Update Forgejo version instructions
- Private repositories: Split into two questions that are separately
meant for collaborative projects and ordinary users respectively.
- Use words as "most likely" and "probably" in order to *not* make the
reader immediately worry about potentially breaking the rules,
especially as the ToS itself mentions that the platform reserves
the right to take strict action without a warning. If the user
choose Codeberg to begin with, it is very likely that "our" values
align.
- Explain what "fair use" is as far as the repository size is concerned
better.
- Break text into new lines depending on columns and the ideas that
each part of a sentence gets across.
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/347
* Improve references to Forgejo and Gitea
* Point reader to potentially good first issues
* Be more specific as to what kinds of patches can be submitted to the
`Codeberg/forgejo` repository
* Explain how easy Go can be for beginners better
* Include some advice as to what a prospective contributor can work on
based on personal experiences
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/326
This was added because a user was not sure where they could request an
increase to the repository limit of an organization that they intended
to use for a hackathon.
We may want to consider creating a more detailed page about this later.
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/336
Some language tweaks.
* remove capital letters from some words
* fix typos
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/338
Co-authored-by: rtn <rtn@noreply.codeberg.org>
Co-committed-by: rtn <rtn@noreply.codeberg.org>
As mentioned in https://codeberg.org/Codeberg/pages-server/issues/234
The `_redirects` file feature seems to not yet be implemented in the production version of Codeberg Pages. That combined with the fact that the docs give the impression that it is available can and will cause confusion for people.
I've added a simple note at the top of the page, informing about the status of this feature not yet being available.
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/329
Co-authored-by: Andre601 <andre601@noreply.codeberg.org>
Co-committed-by: Andre601 <andre601@noreply.codeberg.org>
* Fix typos
* Simplify language
* Increase clarity as to whether the CLI tools are official
* Make language slightly more formal
* Gaps between headers and content
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/325
Based on social media feedback regarding Forgejo's documentation
not always covering everything. Although it is probably best to use
the Forgejo documentation wherever possible, it is probably in the
interest of our users to link back to both sites.
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/323
Where possible, changed all references from Gitea to Forgejo.
Wherever documentation mentions specifically Gitea, it is preserved.
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/322
Co-authored-by: f0sh <f0sh@mailbox.org>
Co-committed-by: f0sh <f0sh@mailbox.org>
The current documentation fails to specify that the authentication token required a "Bearer" prefix. If a user follows the docs to the letter, it will fail. This patch explains that the user has to add "Bearer" to the token to be able to work.
Co-authored-by: Oscar Carballal Prego <oscar@lareira.digital>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/321
Co-authored-by: Oscar Carballal Prego <oscarcp@noreply.codeberg.org>
Co-committed-by: Oscar Carballal Prego <oscarcp@noreply.codeberg.org>
Simple guide for using Keycloak with Codeberg based on the instructions
provided by Shane Engelman in Codeberg's Matrix chat.
Co-authored-by: shane <contact@shane.gg>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/316
Tried to close some open issues in the issue tracker by submitting the following changes as my first contribution to Codeberg:
- added list on every section index page, should fix#63
- added webhooks documentation, should fix#282
- described behaviour of a limited user profile, should fix#279
- added further explanation to 2fa section, according to Codeberg/Documentation#268, should fix#268
- added codeberg badge generator to first-repository description, should fix#39
- added dns record description to custom-domains, should fix#302
- added description how to use 2fa with git, should fix#278
- added and updated repo migration service description, should fix#312
Feedback highly appreciated.
Co-authored-by: f0sh <f0sh@mailbox.org>
Co-authored-by: Panagiotis "Ivory" Vasilopoulos <git@n0toose.net>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/314
Co-authored-by: f0sh <f0sh@noreply.codeberg.org>
Co-committed-by: f0sh <f0sh@noreply.codeberg.org>
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: https://codeberg.org/Codeberg/Documentation/pulls/307
Co-authored-by: NeatNit <neatnit@noreply.codeberg.org>
Co-committed-by: NeatNit <neatnit@noreply.codeberg.org>
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: https://codeberg.org/Codeberg/Documentation/pulls/299
Co-authored-by: RobWalt <robwalt@noreply.codeberg.org>
Co-committed-by: RobWalt <robwalt@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: https://codeberg.org/Codeberg/Documentation/pulls/297
Co-authored-by: n0toose <git@n0toose.net>
Co-committed-by: n0toose <git@n0toose.net>
This replaces the project table in the "Improving Codeberg" section with a link to the new Codeberg/Projects repository.
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/292
Co-authored-by: Lucas Hinderberger <mail@lucas-hinderberger.de>
Co-committed-by: Lucas Hinderberger <mail@lucas-hinderberger.de>
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: https://codeberg.org/Codeberg/Documentation/pulls/289
Co-authored-by: JakobDev <jakobdev@gmx.de>
Co-committed-by: JakobDev <jakobdev@gmx.de>
Loïc Dachary