Commit graph

96 commits

Author SHA1 Message Date
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
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
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
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
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
kita
d13287b3a8
fix configuring git link 2024-02-03 13:10:00 +08: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
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
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
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
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
7c15ec5243 Improve FAQ section (#347)
- 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
2023-09-11 20:49:18 +00:00
Panagiotis "Ivory" Vasilopoulos
092ae8e74c Mention Codeberg-e.V./requests in FAQ (#336)
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
2023-08-03 19:59:56 +00:00
f0sh
77bfb6cc15 Change all Gitea references to Forgejo, fix #315 (#322)
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>
2023-07-18 00:43:47 +00:00
f0sh
1984032bdd Add improvements to the Documentation according to open issues (#314)
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>
2023-07-08 16:27:44 +00:00
Panagiotis "Ivory" Vasilopoulos
8fe5dd27d6 Improve clarity of wiki documentation (#305)
Fixes https://codeberg.org/Codeberg/Community/issues/1001#issuecomment-890160

Co-authored-by: Panagiotis "Ivory" Vasilopoulos <git@n0toose.net>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/305
Co-authored-by: Panagiotis "Ivory" Vasilopoulos <n0toose@noreply.codeberg.org>
Co-committed-by: Panagiotis "Ivory" Vasilopoulos <n0toose@noreply.codeberg.org>
2023-06-23 01:06:16 +00:00
d7415
e91d2ea42e A list of subscriptions is now available (#306)
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: https://codeberg.org/Codeberg/Documentation/pulls/306
Co-authored-by: d7415 <martin@d7415.co.uk>
Co-committed-by: d7415 <martin@d7415.co.uk>
2023-05-24 14:25:23 +00:00
ebdccd0c67 Update 'content/getting-started/faq.md' 2023-03-26 13:48:23 +00:00
38f5587a17 s/Gitea/Forgejo 2023-03-05 14:27:37 +00:00
Loïc Dachary
bb020e98e8 explain why the tag may look strange at times 2023-03-04 09:26:43 +00:00
Loïc Dachary
109622e1ea s/1.12/1.18/ 2023-03-04 09:26:43 +00:00
Loïc Dachary
67236e8b2d s/gitea/forgejo/ 2023-03-04 09:26:43 +00:00
narF
ceec82002b add missing number in first-repository.md 2022-11-29 17:18:29 +00:00
fnetx
b0b19675f2
Alternatives to Codeberg 2022-11-02 13:34:11 +01:00
Felipe Leopoldo Sologuren Gutiérrez
98c40b8a07 Fixing broken links (#267)
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: https://codeberg.org/Codeberg/Documentation/pulls/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>
2022-10-03 21:35:01 +02:00
Pi-Cla
727dd73f77 Make "AGPL-3.0-or-later" hyperlink go to corresponding licence page instead of list of all licences 2022-08-20 02:34:35 +02:00
Loïc Dachary
cff34e1a03 fix broken link to the default branch (#254)
Co-authored-by: Loïc Dachary <loic@dachary.org>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/254
Co-authored-by: Loïc Dachary <dachary@noreply.codeberg.org>
Co-committed-by: Loïc Dachary <dachary@noreply.codeberg.org>
2022-08-03 12:24:47 +02:00
Jeremy
47cac91c20 Fix getting-started/faq.md 2022-07-26 21:46:39 +02:00
Jeremy
74cf963ee5 Fix getting-started/licensing.md 2022-07-26 21:46:39 +02:00
Jeremy
fd4f7d0567 Fix getting-started/email-settings.md 2022-07-26 21:46:39 +02:00
Jeremy
d6e691468e Fix getting-started/wiki.md 2022-07-26 21:46:39 +02:00
Jeremy
641b525087 Fix getting-started/issue-tracking-basics.md 2022-07-26 21:46:39 +02:00
Jeremy
adb83d680d Fix getting-started/first-repository.md 2022-07-26 21:46:39 +02:00
Jeremy
b13f0c6c81 Fix getting-started/install-git.md 2022-07-26 21:46:39 +02:00
Jeremy
830a8b8680 Fix getting-started/first-steps.md 2022-07-26 21:46:39 +02:00
Jeremy
ba0725129c Fix getting-started/what-is-codeberg.md 2022-07-26 21:46:39 +02:00
puppe
9ed1af425c Fix minor factual error: Codeberg *is* a corporation
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.
2022-06-15 10:25:52 +02:00
Fauzi Ramadaniza
5d3450e98d Reordering certain Text and Correcting its URL
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>
2022-05-15 16:14:35 +02:00
n
3b3309a90e Minor fixes 2022-04-17 14:28:59 +09:00
ka2in
aef207d02a Improve email settings article (#215)
Edit and review of the article about email settings

Co-authored-by: Faycal Alami-Hassani <ka2in@protonmail.com>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/215
Co-authored-by: ka2in <ka2in@noreply.codeberg.org>
Co-committed-by: ka2in <ka2in@noreply.codeberg.org>
2022-04-17 06:03:43 +02:00
jklippel
fa47455b9e document eMail notifications from codeberg (#213)
- 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>
2022-04-09 13:01:28 +02:00
jklippel
429c0ee52e Improvements on the FAQ (#211)
as proposed by infinitelight in https://codeberg.org/Codeberg/Documentation/issues/185

I put the proposed changes into a PR to continue handling #185

Co-authored-by: Jan Klippel <c0d3b3rg@kl1pp3l.de>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/211
Co-authored-by: jklippel <jklippel@noreply.codeberg.org>
Co-committed-by: jklippel <jklippel@noreply.codeberg.org>
2022-04-09 00:00:33 +02:00
Jan Klippel
84927fd532 add link to bylaws
Link to the bylaws from the documentation.

Improves on #191
2022-04-08 23:52:47 +02:00
René Schaar
eec4dd6085 Resolve conversations from #181 (#208)
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>
2022-03-13 20:05:39 +01:00
Arnout Engelen
db9f81fb39 Update FAQ to quote new Terms of Service (#207)
Co-authored-by: Arnout Engelen <arnout@bzzt.net>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/207
Co-authored-by: Arnout Engelen <raboof@noreply.codeberg.org>
Co-committed-by: Arnout Engelen <raboof@noreply.codeberg.org>
2022-03-13 11:46:08 +01:00
tok
5e8f81b174 #174: more extensive article on licensing. (#181)
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>
2022-03-07 16:22:01 +01:00
Otto Richter
0e30fb4fe8 Fix internal link 2022-02-13 21:02:00 +01:00
Otto Richter
2bda61e74d Diverse changes (#189)
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>
2022-01-21 11:36:38 +01:00
René Wagner
c06926aa0a
rephrase first sentence 2021-11-25 18:35:38 +01:00