Commit graph

37 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
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
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 1403a81d75 Improve 'Contributing Code' guide (#326)
* 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
2023-08-22 13:17:52 +00:00
Panagiotis "Ivory" Vasilopoulos 51c394cd3b 'Projects' has been renamed to 'Contributing' 2023-08-03 20:05:12 +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
Lucas Hinderberger 08d985108d Replacing project list with link to Codeberg/Projects repo (#292)
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>
2023-02-24 19:39:18 +00:00
Jan Klippel e52d13f76b
replace mentions of Gitea with Forgejo
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
2023-02-19 12:03:12 +01:00
fnetx b4fd4812aa
Style guide is for docs only 2022-10-06 00:49:42 +02:00
magicfelix 9787d990ea
Fix typo 2022-08-11 16:30:05 +02:00
Loïc Dachary 7b5313609b improve the wording in the contribute page (#253)
* `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: https://codeberg.org/Codeberg/Documentation/pulls/253
Co-authored-by: Loïc Dachary <dachary@noreply.codeberg.org>
Co-committed-by: Loïc Dachary <dachary@noreply.codeberg.org>
2022-08-05 22:20:27 +02:00
vanous 9bb3136a20 Improving Codeberg: add section about reporting bugs 2022-07-23 13:58:05 +02:00
Mark E. Fuller 967b0cd7bd fix broken link to FAQ (#246)
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: https://codeberg.org/Codeberg/Documentation/pulls/246
Co-authored-by: Mark E. Fuller <fuller@noreply.codeberg.org>
Co-committed-by: Mark E. Fuller <fuller@noreply.codeberg.org>
2022-07-09 12:51:10 +02:00
Jan Klippel 8b5ab8067e Actually show Markdown syntax
Actually display the Markdown syntax to use when writing a note or a warning
2022-05-22 11:30:03 +02:00
Jan Klippel 9aeb95c4e7 Add bullet point on names
Fixes: #232
2022-05-21 22:23:59 +02:00
ka2in a829d17b10 Style Guide (#223)
Co-authored-by: Faycal Alami-Hassani <ka2in@protonmail.com>
Co-authored-by: ka2in <ka2in@protonmail.com>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/223
Co-authored-by: ka2in <ka2in@noreply.codeberg.org>
Co-committed-by: ka2in <ka2in@noreply.codeberg.org>
2022-05-17 19:03:19 +02:00
Jan Klippel 5bdac45ee5 Create a new section 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.
2022-04-14 12:34:58 +02:00
René Schaar fd44b5335f Add project overview table to the contributing code site (#203)
Fixes: #201
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/203
Co-authored-by: René Schaar <rene@schaar.priv.at>
Co-committed-by: René Schaar <rene@schaar.priv.at>
2022-02-26 10:46:22 +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
n 170914185d Add anchor links to headings (#159)
This PR adds anchor links to any markdown headings. It also replaces any hacky workarounds used previously.

Closes #83.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/159
Co-authored-by: n <n@noreply.codeberg.org>
Co-committed-by: n <n@noreply.codeberg.org>
2021-08-09 11:59:36 +02:00
n 65ddf24687 Fix 'naming conventions' title 2021-07-27 02:24:16 +09:00
n ae684fbad4 Migrate to Codeberg Design Kit (#132) (#149)
TODO:
- [x] Hide navbar items on small screens
- [x] Fix `<blockquote>` rendering
- [x] Fix `<code>` rendering
- [ ] LibreJS Compatibility

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/149
Co-authored-by: n <n@noreply.codeberg.org>
Co-committed-by: n <n@noreply.codeberg.org>
2021-07-26 12:07:23 +02:00
fnetx fa7a04afa7
Make all Git and Codeberg mentions uppercase 2021-05-29 15:09:43 +02:00
n 6c4088fe69 Update process for approving PRs (#80) 2021-05-29 15:42:46 +09:00
n 50eca16f77 More corrections 2021-05-13 19:09:28 +02:00
n 9a36e8d6a8 Some more spelling and grammar corrections. 2021-05-13 19:09:28 +02:00
Lenz Grimmer 98ecb8dfba Updated the Code contribution documentation
Applied some small textual improvements and fixed typo.

Signed-off-by: Lenz Grimmer <lenzgr@noreply.codeberg.org>
2021-05-13 13:49:19 +02:00
fnetx 3441374445
Some instructions for improving the platform 2021-04-29 21:51:19 +02:00
Lucas Hinderberger a20230f555 Merge branch 'resolve-merge-conflict' 2020-10-16 17:36:13 +02:00
Lucas Hinderberger 86827a0a3f Fixed error spotted by @n 2020-10-16 17:15:05 +02:00
Lucas Hinderberger 6b4ec4bcda Additional information about screenshots and example repos 2020-10-11 13:51:19 +02:00
Lucas Hinderberger 6fad43db80 Removing unnecessary linebreak 2020-10-09 14:31:56 +02:00
Lucas Hinderberger c44e80d5ec Modifications based on @ivan-paleoi's comments 2020-10-09 14:12:44 +02:00
Lucas Hinderberger 611184c48e Introduced typo while fixing typo - yikes! :) 2020-10-05 22:12:33 +02:00
Lucas Hinderberger eb219bde0a Corrected errors found in review by n 2020-10-05 22:11:33 +02:00
Lucas Hinderberger 7668e109a7 Contributor FAQ 2020-10-05 00:42:23 +02:00