fix#148
Adds a spell checker via `cspell` and fixes some spelling issues in the docs.
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/439
Co-authored-by: pat-s <patrick.schratz@gmail.com>
Co-committed-by: pat-s <patrick.schratz@gmail.com>
Many users setting up Codeberg Pages that use the records have limited experience with DNS.
Therefore, adding this warning to make it clear what they may need to be entering into
their records will likely save them time and effort in troubleshooting why their page may
not be loading correctly.
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/431
Co-authored-by: Sammy Hori <sammyhori@noreply.codeberg.org>
Co-committed-by: Sammy Hori <sammyhori@noreply.codeberg.org>
I believe the "pip" in front is extraneous. This is a small change.
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/397
Co-authored-by: kouett <lou@ynh.kouett.net.eu.org>
Co-committed-by: kouett <lou@ynh.kouett.net.eu.org>
Main changes include switching language from ISP to domain registrar, and standardization around the phrase "Codeberg Pages".
Signed-off-by: Mark Pitblado <mark@pitblado.me>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/391
Reviewed-by: crapStone <codeberg@crapstone.dev>
Co-authored-by: Mark Pitblado <mark-pitblado@noreply.codeberg.org>
Co-committed-by: Mark Pitblado <mark-pitblado@noreply.codeberg.org>
- Formatting fixes, relevant text adjustments
- Some more complicated cases (e.g. attribution), as well as outdated
information that should be removed in a later commit were
deliberately left unchanged.
- Some minor mistakes (speling, trailing whitespaces, punctuation)
in the admonition boxes were also fixed.
Added an entry to the troubleshooting page for Codeberg pages that addresses the situation with Cloudflare, where you should turn DNS entries pointing to Codeberg pages to **DNS only** for it to work reliably.
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/351
Co-authored-by: Andre601 <andre601@noreply.codeberg.org>
Co-committed-by: Andre601 <andre601@noreply.codeberg.org>
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>
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>
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>
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>
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>
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>
