Commit graph

370 commits

Author SHA1 Message Date
Mark Pitblado
193b4cf639 Define acronyms on first use, add reference to codeberg-ci/examples, and remove reference to knut org (#435)
- All acronyms should be defined in first use. This adds this for Continuous Integration (CI) and Role Based Access Control (RBAC).
- Changes language around acceptance to soften tone, and shift from guaranteed to conditional acceptance.
- Specifies that login to woodpecker-ci is via codeberg account, and that repositories are automatically available to link.
- Adds reference to codeberg-ci/examples repository.
- Removes reference to knut organization.

Co-authored-by: Patrick Schratz <pat-s@noreply.codeberg.org>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/435
Reviewed-by: Patrick Schratz <pat-s@noreply.codeberg.org>
Co-authored-by: Mark Pitblado <mark@pitblado.me>
Co-committed-by: Mark Pitblado <mark@pitblado.me>
2024-06-12 20:02:39 +00:00
pat-s
74e8925bec add spellchecker (#439)
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>
2024-06-12 10:20:37 +00:00
niko4u
1b84cd41a4 Minor rewording (#428)
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/428
Reviewed-by: Patrick Schratz <pat-s@noreply.codeberg.org>
Co-authored-by: niko4u <niko4u@noreply.codeberg.org>
Co-committed-by: niko4u <niko4u@noreply.codeberg.org>
2024-06-12 08:57:35 +00:00
pat-s
3cab99a27f
fix liberapay lint issues and broken link 2024-06-12 10:25:04 +02:00
c6c7b418e7 Fix typo
Build was failing. This was overlooked, because CI was only added after the PR was last updated.
2024-06-11 11:51:51 +00:00
Igor
0d872ea674 Integrating LiberaPay with Codeberg (#406)
This should resolve issue #327 opened by @n0toose

I have written a little bit of example, how do I see it

Co-authored-by: I <igor@its.rel.pl>
Co-authored-by: Panagiotis "Ivory" Vasilopoulos <git@n0toose.net>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/406
Co-authored-by: Igor <309631@noreply.codeberg.org>
Co-committed-by: Igor <309631@noreply.codeberg.org>
2024-06-11 11:47:25 +00:00
crapStone
da1b77aa6a Add woodpecker ci & many linters (and their required fixes) (#377)
closes #238

Co-authored-by: pat-s <patrick.schratz@gmail.com>
Co-authored-by: Patrick Schratz <pat-s@noreply.codeberg.org>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/377
Co-authored-by: crapStone <crapstone01@gmail.com>
Co-committed-by: crapStone <crapstone01@gmail.com>
2024-06-11 07:51:22 +00:00
Sammy Hori
8bd521c7f6 Codeberg Pages: Add warning for setting up records on some registrars (#431)
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>
2024-06-09 14:23:36 +00:00
79d2ac2682 Getting Started: Add detail to use of git push --mirror (#422)
Based on discussion in the Forgejo repository (#2834)

See: https://codeberg.org/forgejo/forgejo/pulls/2834

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/422
Co-authored-by: adbagio <h759bkyo4@mozmail.com>
Co-committed-by: adbagio <h759bkyo4@mozmail.com>
2024-06-07 11:05:44 +00:00
ca0475ad93 Updates styleguide wording and terminology (#429)
Based on https://codeberg.org/forgejo/forgejo/issues/3844

Equivalent PR in the Forgejo documentation: https://codeberg.org/forgejo/docs/pulls/681

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/429
Reviewed-by: Panagiotis "Ivory" Vasilopoulos <git@n0toose.net>
Co-authored-by: adagio <h759bkyo4@mozmail.com>
Co-committed-by: adagio <h759bkyo4@mozmail.com>
2024-06-05 08:09:38 +00:00
Abdur-Rahman Mansoor
8e0118c9c5
refactor: use american spelling convention and fix grammar 2024-05-24 20:51:47 -04:00
Skye
51da37c7d4 Pedantic capitalization changes to brand names (#425)
Some instances of Github and Gitlab have been changed to GitHub and GitLab
respectively.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/425
Reviewed-by: Panagiotis "Ivory" Vasilopoulos <git@n0toose.net>
Co-authored-by: Skye <skyeforeverblue@outlook.com>
Co-committed-by: Skye <skyeforeverblue@outlook.com>
2024-05-19 21:24:00 +00:00
Sergey Volkov
d475852dc2 Add SSH commit signing content (#420)
Add the SSH commit signing section to the SSH key management page. Git has had this feature for a while now and SSH keys are easier to manage since they can be used for both authentication and signing, so I think it makes sense to document this.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/420
Reviewed-by: Panagiotis "Ivory" Vasilopoulos <git@n0toose.net>
Co-authored-by: Sergey Volkov <ser121512@yandex.ru>
Co-committed-by: Sergey Volkov <ser121512@yandex.ru>
2024-05-16 13:55:48 +00:00
0ko
60d471874b Improve contact/support information 2024-04-10 22:43:53 +05:00
Andrew Kvalheim
0b3c45ce4b Detect slash key by value, not physical position (#415)
The solution is trivial; read the [property](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent#instance_properties) for actual meaning instead of physical position.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/415
Reviewed-by: Gusted <gusted@noreply.codeberg.org>
Co-authored-by: Andrew Kvalheim <andrew@kvalhe.im>
Co-committed-by: Andrew Kvalheim <andrew@kvalhe.im>
2024-04-03 12:12:54 +00:00
Igor
91bc7ec69f added notes about obtaining webp (#408)
Resolves #407

Co-authored-by: I <igor@its.rel.pl>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/408
Reviewed-by: Otto <otto@codeberg.org>
Co-authored-by: Igor <309631@noreply.codeberg.org>
Co-committed-by: Igor <309631@noreply.codeberg.org>
2024-04-03 11:51:57 +00:00
Gusted
adf276bea6
pages: Correct statement about CAA record
- Resolves https://codeberg.org/Codeberg/Documentation/issues/413
2024-03-23 22:15:22 +01:00
Panagiotis "Ivory" Vasilopoulos
b9a17086c9 Style Guide: Markdown Code Blocks (#403)
Fixes #401.

Refs: https://codeberg.org/Codeberg/Documentation/issues/401
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/403
Reviewed-by: Leo Heitmann Ruiz <eo@noreply.codeberg.org>
2024-03-12 18:38:42 +00:00
465aaaa107 CI (Actions): Clarify compatibility & link to the latest docs (#405)
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/405
Reviewed-by: Panagiotis "Ivory" Vasilopoulos <git@n0toose.net>
Co-authored-by: Earl Warren <contact@earl-warren.org>
Co-committed-by: Earl Warren <contact@earl-warren.org>
2024-03-12 17:58:13 +00:00
Andre601
7a9017e760 Fix broken link for Git LFS Migrate Man page (#404)
The URL for the man page of Git LFS migrate was broken. This is fixed in this PR.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/404
Co-authored-by: Andre601 <github@andre601.ch>
Co-committed-by: Andre601 <github@andre601.ch>
2024-03-11 12:19:54 +00:00
Panagiotis "Ivory" Vasilopoulos
2ce0c26e3d Pages: Repositories currently have to be public (#395)
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/395
Reviewed-by: Gusted <gusted@noreply.codeberg.org>
2024-03-10 16:13:45 +00:00
And4po
d852c5ac0d Getting Started: Fix small typo (#402)
It fixes a small typo on the "First repository" document.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/402
Reviewed-by: Panagiotis "Ivory" Vasilopoulos <git@n0toose.net>
Co-authored-by: And4po <anderromeroaldana@proton.me>
Co-committed-by: And4po <anderromeroaldana@proton.me>
2024-03-06 12:27:05 +00:00
Leo Heitmann Ruiz
364a316007 Remove unnecessary mention of Git Bash (#400)
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/400
Reviewed-by: Panagiotis "Ivory" Vasilopoulos <git@n0toose.net>
Co-authored-by: Leo Heitmann Ruiz <eo@noreply.codeberg.org>
Co-committed-by: Leo Heitmann Ruiz <eo@noreply.codeberg.org>
2024-03-06 10:19:01 +00:00
kouett
85d333f48b Fix typo in sphinx quickstart cmd (#397)
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>
2024-02-22 12:48:37 +00:00
Otto Richter
d5f6f22999 Refresh Contact, Getting Started, Contributing Pages (#394)
Update contact page

Prefer references to Forgejo, more relevant to users

Updates to Getting Started Pages / FAQ
- a lot of content was outdated and generally rewritten or rephrased
- implement procedure for size limits as determined by annual assembly
  2023, see Codeberg-e.V./Discussion#92
- people are sometimes confused wheter you need to be a paying member in
  Codeberg e.V. in order to use the platform

Update improving Codeberg guides
- reduce redundancy in code contribution guide and reference the
  Contributing Issue Tracker instead
- separate (and ideally more appealing) donation page (deserves even
  more love IMHO)
- shorten and strip outdated information

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/394
Reviewed-by: Panagiotis "Ivory" Vasilopoulos <git@n0toose.net>
Co-authored-by: Otto Richter <git@otto.splvs.net>
Co-committed-by: Otto Richter <git@otto.splvs.net>
2024-02-17 22:04:10 +00:00
thatonecoder
2b85a21e70 Licensing: Licence -> License (#392)
This should make it comply a bit more with the style guide.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/392
Reviewed-by: Panagiotis "Ivory" Vasilopoulos <git@n0toose.net>
Co-authored-by: thatonecoder <thatonecoder@noreply.codeberg.org>
Co-committed-by: thatonecoder <thatonecoder@noreply.codeberg.org>
2024-02-12 13:14:41 +00:00
Mark Pitblado
8a32b7cec9 Pages: General typo and grammatical fixes (#391)
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>
2024-02-09 08:18:50 +00:00
ToaKraka
6c2ced0ab3 Remove references to a specific version of CommonMark (#390)
The current text refers to CommonMark 0.30, but the latest version of CommonMark is 0.31.2, and the latest version of GoldMark is compatible with that version of CommonMark.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/390
Reviewed-by: Gusted <gusted@noreply.codeberg.org>
Co-authored-by: ToaKraka <toakraka@noreply.codeberg.org>
Co-committed-by: ToaKraka <toakraka@noreply.codeberg.org>
2024-02-06 22:15:06 +00:00
kita
d13287b3a8
fix configuring git link 2024-02-03 13:10:00 +08:00
Panagiotis "Ivory" Vasilopoulos
1de25174bc Codeberg CI: Fix small URL typo
Caused by myself on 4a11765382.
2024-02-01 03:44:41 +01:00
quecomet
4a11765382 Codeberg CI: Improve usage and request instructions (#381)
Closes https://codeberg.org/Codeberg-CI/feedback/issues/153

Co-authored-by: Panagiotis "Ivory" Vasilopoulos <git@n0toose.net>
Co-authored-by: pat-s <patrick.schratz@gmail.com>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/381
Co-authored-by: quecomet <quecomet@proton.me>
Co-committed-by: quecomet <quecomet@proton.me>
2024-01-31 21:39:10 +00:00
jmarsal
bf5fe32d6a
refactor: move the command needed to a 'note' ('info') admonition box 2024-01-24 19:29:36 +01:00
jmarsal
b7f25f1431
feat: add shell command to add your GPG key to .bashrc, otherwise the signing process will not work 2024-01-23 19:32:22 +01:00
Ralf Stubner
79d5804969 Remove warning about _redirect file on Codeberg Pages (#382)
According to https://codeberg.org/Codeberg/pages-server/issues/234 the `_redirect` file feature has been activated on Codeberg Pages.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/382
Reviewed-by: Gusted <gusted@noreply.codeberg.org>
Co-authored-by: Ralf Stubner <rstub@noreply.codeberg.org>
Co-committed-by: Ralf Stubner <rstub@noreply.codeberg.org>
2024-01-01 22:36:39 +00:00
A Frederick Christensen
6c05b15edb Minor correction of a missed word (#380)
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/380
Reviewed-by: Panagiotis "Ivory" Vasilopoulos <git@n0toose.net>
Co-authored-by: A Frederick Christensen <fauxmight@noreply.codeberg.org>
Co-committed-by: A Frederick Christensen <fauxmight@noreply.codeberg.org>
2023-12-26 13:02:29 +00:00
Mohamed Wageh
ca4290e697 Automatically generate Table of Contents for each page (#376)
Closes #24.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/376
Co-authored-by: Mohamed Wageh <oatbiscuits@proton.me>
Co-committed-by: Mohamed Wageh <oatbiscuits@proton.me>
2023-12-11 17:32:09 +00:00
oatbiscuits
f0408b2c6a Add documentation for Forgejo CI Actions runner (#369)
This should solve #318.

Helped-by: Linus Groh <mail@linusgroh.de>
Reviewed-by: Panagiotis "Ivory" Vasilopoulos <git@n0toose.net>
Reviewed-by: Linus Groh <mail@linusgroh.de>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/369
Co-authored-by: oatbiscuits <oatbiscuits@noreply.codeberg.org>
Co-committed-by: oatbiscuits <oatbiscuits@noreply.codeberg.org>
2023-12-07 16:58:07 +00:00
Panagiotis "Ivory" Vasilopoulos
f499322a61 Pages: More background information (#374)
- Link to repository
- More organized "See also" section
- Link to FEATURES.md of Pages repository

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/374
2023-11-30 22:04:10 +00:00
oatbiscuits
55a504e33a Add search functionality (#370)
This should solve #23.

This is a fully static search implementation powered by [Pagefind](https://pagefind.app/).

In terms of UI, I found and implemented a section in the sidebar for searching the documentation. It was hidden presumably waiting for implementation. It mentioned using the slash (/) key for searching, so I implemented the hotkey as well.

I made the indexing command required by Pagefind run after Eleventy finishes building using the `.after` hook.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/370
Co-authored-by: oatbiscuits <oatbiscuits@noreply.codeberg.org>
Co-committed-by: oatbiscuits <oatbiscuits@noreply.codeberg.org>
2023-11-30 21:33:22 +00:00
Gusted
57b888bd6c Fix incorrect link (#373)
- Use non-md link.
- Resolves https://codeberg.org/Codeberg/Documentation/issues/372

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/373
Co-authored-by: Gusted <gusted@noreply.codeberg.org>
Co-committed-by: Gusted <gusted@noreply.codeberg.org>
2023-11-29 22:43:48 +00:00
Alex
966404aa5c Using Security keys on Codeberg (#367)
This PR adds docs on WebAuthn usage on Codeberg. It attempts to cover:
- using WebAuthn as a 2FA option on web logins
- using FIDO2 over SSH using the OpenSSH client

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/367
Co-authored-by: Alex <alex@blueselene.com>
Co-committed-by: Alex <alex@blueselene.com>
2023-11-28 20:57:37 +00:00
Panagiotis "Ivory" Vasilopoulos
8386857b1c Use admonition boxes more consistently
- 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.
2023-11-27 07:16:04 +01:00
Panagiotis "Ivory" Vasilopoulos
9a19c900e3 Style Guide: Add image-specific rules 2023-11-27 05:37:38 +01:00
a6a0a1c9ba Update weblinks from CI page 2023-11-26 18:33:40 +00:00
e4ea4343ab Update contact information 2023-11-13 15:44:08 +00:00
Andre601
df95d70243 Add entry about Cloudflare in content/codeberg-pages/troubleshooting.md (#351)
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>
2023-11-10 11:24:40 +00:00
narF
e9748990e2 For local commits, mention "Configuring Git" in Email Settings guide (#355)
Co-authored-by: Panagiotis "Ivory" Vasilopoulos <git@n0toose.net>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/355
Co-authored-by: narF <narf@noreply.codeberg.org>
Co-committed-by: narF <narf@noreply.codeberg.org>
2023-10-14 14:17:16 +00:00
crystal
7bb8fa5ca5 Add note to not expect responses to abuse reports (#357)
Also clarifies language about custom domains and codeberg.page

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/357
Co-authored-by: crystal <crystal@noreply.codeberg.org>
Co-committed-by: crystal <crystal@noreply.codeberg.org>
2023-09-22 15:44:12 +00:00
Andre601
b234b71bb7 Create new admonition boxes (#337)
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>
2023-09-18 15:17:17 +00:00
Panagiotis "Ivory" Vasilopoulos
536884cd59 Simpify and update instructions for reports
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
2023-09-18 10:02:53 +02:00