mirror of
1
Fork 0
Beyond coding. We forge.
Go to file
Loïc Dachary 2fb13da8ed
[DOCS] CONTRIBUTING
Refs: https://codeberg.org/forgejo/forgejo/issues/8
Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/153
Refs: https://codeberg.org/forgejo/forgejo/issues/123
Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/299
(cherry picked from commit 08dcef0c8c)

[DOCS] CONTRIBUTING/RELEASE: https://forgejo.org/docs/admin

Because the version is not displayed on the landing page of Forgejo,
there cannot be a link to a versionned documentation. There must exist
a link that points to the latest version on the website for the
forgejo instance to display.

Better but more complicated approaches could be to:

* Embed the documentation in Forgejo
* Allow the admin to not display the help
* Allow the admin to display a versionned help or not

(cherry picked from commit 83cc389239)
(cherry picked from commit 5df52b8a4f)
(cherry picked from commit 9a66b3d70b)

[DOCS] CONTRIBUTING/RELEASE: reminder to update FORGEJO_VERSION

(cherry picked from commit 2a4d0bd164)
(cherry picked from commit d68576ba67)

[DOCS] CONTRIBUTING: updates

* Remove obsolete description of the well being & moderation team and
  replace them with a link to the moderation email.

* Remove description of the governance process and replace with a link
  to the governance readme that did not exist at the time.

* Add links to the Forgejo documentation

(cherry picked from commit df749da272)
(cherry picked from commit 4da39128c5)
(cherry picked from commit f442ca6f40)
(cherry picked from commit 031928c447)
(cherry picked from commit 1e6ba47216)
(cherry picked from commit 8916a1f8c6)
(cherry picked from commit 663e28c412)
(cherry picked from commit d56b130baa)

[DOCS] CONTRIBUTING (squash)

(cherry picked from commit 0dc4b6e5c9)
(cherry picked from commit 52f2163807)
(cherry picked from commit 47d0ae3e10)
(cherry picked from commit 7757a5c34c)
(cherry picked from commit 5b4d25bd03)
(cherry picked from commit 78798cc25e)
(cherry picked from commit 3001fb8c7b)
(cherry picked from commit da27bf1bc5)
2023-07-10 18:31:55 +02:00
.devcontainer add python/poetry to devcontainer (#25407) 2023-06-21 16:44:58 +08:00
.forgejo [CI] Forgejo Actions based release process 2023-07-10 18:01:10 +02:00
.github/workflows delete Gitea specific files that need rewriting for Forgejo 2023-07-10 18:31:49 +02:00
assets Update emoji set to Unicode 15 (#25595) 2023-06-29 16:29:48 +00:00
build Replace `interface{}` with `any` (#25686) 2023-07-04 18:36:08 +00:00
cmd [CLI] implement forgejo-cli actions register 2023-07-10 18:01:01 +02:00
contrib Make "install page" respect environment config (#25648) 2023-07-09 22:43:37 +00:00
custom/conf [CI] DEFAULT_ACTIONS_URL = https://codeberg.org 2023-07-10 18:00:44 +02:00
docker Fix WORK_DIR for docker (root) image (#25738) 2023-07-10 08:26:07 +00:00
docs [CI] Revert "Restrict `[actions].DEFAULT_ACTIONS_URL` to only `github` or `self` (#25581)" 2023-07-10 18:00:38 +02:00
models [CLI] implement forgejo-cli actions register 2023-07-10 18:01:01 +02:00
modules [CI] Search .forgejo/workflows first 2023-07-10 18:01:01 +02:00
options Make "install page" respect environment config (#25648) 2023-07-09 22:43:37 +00:00
public/img Update octicons and use `octicon-file-directory-symlink` (#25453) 2023-06-22 22:05:52 +00:00
releases [CI] Woodpecker based releases process 2023-07-10 18:01:01 +02:00
routers [CLI] implement forgejo-cli actions register 2023-07-10 18:01:01 +02:00
services For API attachments, use API URL (#25639) 2023-07-10 09:31:19 +00:00
snap Upgrade snap to node 20 (#24990) 2023-05-29 22:41:56 +02:00
templates Make "install page" respect environment config (#25648) 2023-07-09 22:43:37 +00:00
tests [CI] tests/pgsql.ini.tmpl: do not use minio 2023-07-10 18:01:01 +02:00
web_src Make "install page" respect environment config (#25648) 2023-07-09 22:43:37 +00:00
.air.toml Reduce verbosity of dev commands (#24917) 2023-05-24 20:11:04 +00:00
.changelog.yml Changelog for v1.15.0-rc1 (#16422) 2021-07-15 11:47:57 -04:00
.dockerignore Remove the service worker (#25010) 2023-05-31 02:07:04 +00:00
.drone.yml build nightly docker images (#25317) 2023-06-18 01:04:23 -04:00
.editorconfig Add markdownlint (#20512) 2022-07-28 09:22:47 +08:00
.eslintrc.yaml Update JS dependencies, misc tweaks (#25768) 2023-07-08 12:26:35 +02:00
.gitattributes Remove more unused Fomantic variants (#25292) 2023-06-17 08:15:33 +00:00
.gitignore [CI] Woodpecker based releases process 2023-07-10 18:01:01 +02:00
.gitpod.yml Use qwtel.sqlite-viewer instead of alexcvzz.vscode-sqlite (#25386) 2023-06-20 19:06:42 +00:00
.golangci.yml Update tool dependencies, lock govulncheck and actionlint (#25655) 2023-07-09 11:58:06 +00:00
.ignore Remove the service worker (#25010) 2023-05-31 02:07:04 +00:00
.markdownlint.yaml Add markdownlint (#20512) 2022-07-28 09:22:47 +08:00
.npmrc Upgrade to npm lockfile v3 and explicitely set it (#23561) 2023-03-18 19:38:10 +01:00
.spectral.yaml Add spectral linter for Swagger (#20321) 2022-07-11 18:07:16 -05:00
.stylelintrc.yaml Update JS dependencies and misc tweaks (#25540) 2023-06-27 21:44:17 +02:00
BSDmakefile update BSDmakefile to latest version from upstream (#24063) 2023-04-11 23:42:22 -04:00
CHANGELOG.md Changelog for v1.19.4 (#25667) (#25709) 2023-07-05 20:25:13 +02:00
CODE_OF_CONDUCT.md Add Gitea Community Code of Conduct (#23188) 2023-03-09 10:49:34 +08:00
CONTRIBUTING.md [DOCS] CONTRIBUTING 2023-07-10 18:31:55 +02:00
DCO Remove address from DCO (#22595) 2023-01-24 18:52:38 +00:00
Dockerfile [CI] Forgejo Actions based release process 2023-07-10 18:01:10 +02:00
Dockerfile.rootless [CI] Forgejo Actions based release process 2023-07-10 18:01:10 +02:00
LICENSE Fix typo 2016-11-08 08:42:05 +01:00
MAINTAINERS Apply to became a maintainer. (#25745) 2023-07-07 13:49:34 +02:00
Makefile [CI] Forgejo Actions based release process 2023-07-10 18:01:10 +02:00
build.go User/Org Feed render description as per web (#23887) 2023-04-04 04:39:47 +01:00
go.mod Fix wrong warn messages in migration steps (#25475) 2023-06-24 08:20:08 +00:00
go.sum Fix wrong warn messages in migration steps (#25475) 2023-06-24 08:20:08 +00:00
main.go [CLI] implement forgejo-cli 2023-07-10 18:01:00 +02:00
package-lock.json Always pass 6-digit hex color to monaco (#25780) 2023-07-09 12:17:22 +02:00
package.json Always pass 6-digit hex color to monaco (#25780) 2023-07-09 12:17:22 +02:00
playwright.config.js Update JS dependencies and eslint config (#21388) 2022-10-10 20:02:20 +08:00
poetry.lock Add `make poetry-update`, upgrade `djlint` (#25399) 2023-06-26 21:14:00 +00:00
poetry.toml Clean up pyproject.toml and package.json, fix poetry options (#25327) 2023-06-18 18:13:08 +00:00
pyproject.toml Enable H014 and H023 djlint rules (#25786) 2023-07-09 20:33:25 +00:00
vitest.config.js Update JS dependencies, misc tweaks (#25768) 2023-07-08 12:26:35 +02:00
webpack.config.js Minify CSS with Lightning CSS (#25754) 2023-07-07 18:28:48 +00:00

docs/README.md

Gitea: Docs

Join the chat at https://img.shields.io/discord/322538954119184384.svg

Hosting

These pages are hosted using netlifycms and get automatically updated on every push to the master branch.

Install

These pages use the Hugo static site generator. If you are planning to contribute you'll want to download and install Hugo on your local machine.

The installation of Hugo is out of the scope of this document, so please take the official install instructions to get Hugo up and running.

Development

To generate the website and serve it on localhost:1313 just execute this command and stop it with Ctrl+C:

make server

When you are done with your changes just create a pull request, after merging the pull request the website will be updated automatically.

Contributing

Fork -> Patch -> Push -> Pull Request

Authors

License

This project is under the Apache-2.0 License. See the LICENSE file for the full license text.

Copyright (c) 2016 The Gitea Authors <https://gitea.io>