Beyond coding. We forge. (Code of Conduct: https://codeberg.org/forgejo/code-of-conduct)
Go to file
Loïc Dachary 4da39128c5
[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)
2023-03-26 11:43:33 +02:00
.woodpecker [CI] implementation: Woodpecker based CI 2023-03-26 10:58:14 +02:00
assets Update act (#23512) 2023-03-16 18:09:11 +08:00
build Clean some legacy files and move some build files (#23699) 2023-03-25 16:22:51 -04:00
cmd Check LFS/Packages settings in dump and doctor command (#23631) 2023-03-23 20:30:28 +08:00
contrib Clean some legacy files and move some build files (#23699) 2023-03-25 16:22:51 -04:00
CONTRIBUTING [DOCS] CONTRIBUTING 2023-03-26 11:43:33 +02:00
custom/conf Editor preview support for external renderers (#23333) 2023-03-24 14:12:23 +08:00
docker Wrap unless-check in docker manifests (#23079) 2023-02-22 16:33:31 -06:00
docs Describe Gitea's purpose more accurately (#23698) 2023-03-25 18:19:34 +02:00
models Create commit status when event is pull_request_sync (#23683) 2023-03-24 16:05:48 -04:00
modules Use data-tooltip-content for tippy tooltip (#23649) 2023-03-24 18:35:38 +08:00
options [skip ci] Updated translations via Crowdin 2023-03-26 00:16:31 +00:00
public Keep (add if not existing) xmlns attribute for generated SVG images (#23410) 2023-03-21 13:39:27 +08:00
releases [CI] implementation: Woodpecker based CI 2023-03-26 10:58:14 +02:00
routers Fix cancel button in the page of project edit not work (#23655) 2023-03-24 16:37:56 +08:00
services Create commit status when event is pull_request_sync (#23683) 2023-03-24 16:05:48 -04:00
snap Remove unnecessary whitespace in snapcraft.yaml (#22090) 2022-12-10 08:31:16 -06:00
templates Allow new file and edit file preview if it has editable extension (#23624) 2023-03-26 13:25:41 +08:00
tests [CI] [v1.20] tests/pgsql.ini.tmpl: do not use minio 2023-03-26 10:58:15 +02:00
web_src Allow new file and edit file preview if it has editable extension (#23624) 2023-03-26 13:25:41 +08:00
.air.toml Add more test directory to exclude dir of air, remove watching templates from air include dir because gitea has internal mechanism (#22246) 2022-12-27 14:00:34 +08:00
.changelog.yml Changelog for v1.15.0-rc1 (#16422) 2021-07-15 11:47:57 -04:00
.dockerignore Add .dockerignore (#21753) 2022-11-10 04:04:09 +01:00
.drone.yml Update JS dependencies, Require Node.js 16 (#23528) 2023-03-17 01:45:45 -04:00
.editorconfig Add markdownlint (#20512) 2022-07-28 09:22:47 +08:00
.eslintrc.yaml Refactor hiding-methods, remove jQuery show/hide, remove .hide class, remove inline style=display:none (#22950) 2023-02-19 12:06:14 +08:00
.gitattributes Hook go-licenses into tidy again (#21353) 2022-10-10 20:45:02 +02:00
.gitignore [CI] implementation: Woodpecker based CI 2023-03-26 10:58:14 +02:00
.gitpod.yml Add deps-docs command to makefile (#23686) 2023-03-24 14:42:31 -04:00
.golangci.yml Fix .golangci.yml (#22868) 2023-02-11 21:44:53 +00:00
.ignore Add some .ignore entries (#18296) 2022-01-16 17:26:15 +00:00
.lgtm refactor: ignore LGTM from author of pull request. (#3283) 2018-01-02 06:13:49 -06: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 Replace Less with CSS (#23481) 2023-03-14 22:20:19 -04:00
BSDmakefile Add BSDmakefile to prevent errors when make is called under FreeBSD (#4446) 2018-07-16 20:45:51 +02:00
build.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
CHANGELOG.md Add CHANGELOG for 1.19.0 (#23583) 2023-03-20 15:42:23 +08: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-03-26 11:43:33 +02:00
DCO Remove address from DCO (#22595) 2023-01-24 18:52:38 +00:00
Dockerfile [CI] implementation: forgejo container images 2023-03-26 10:58:14 +02:00
Dockerfile.rootless [CI] implementation: forgejo container images 2023-03-26 10:58:14 +02:00
go.mod Update act (#23512) 2023-03-16 18:09:11 +08:00
go.sum Update act (#23512) 2023-03-16 18:09:11 +08:00
LICENSE Fix typo 2016-11-08 08:42:05 +01:00
main.go Add Bash and Zsh completion scripts (#22646) 2023-02-21 12:32:24 -05:00
MAINTAINERS Remove @metalmatze as maintainer (#23612) 2023-03-21 06:17:58 -04:00
Makefile [CI] implementation: Woodpecker based CI 2023-03-26 10:58:14 +02:00
package-lock.json Allow new file and edit file preview if it has editable extension (#23624) 2023-03-26 13:25:41 +08:00
package.json Allow new file and edit file preview if it has editable extension (#23624) 2023-03-26 13:25:41 +08:00
playwright.config.js Update JS dependencies and eslint config (#21388) 2022-10-10 20:02:20 +08:00
vitest.config.js Update JS dependencies and eslint (#22190) 2022-12-20 17:15:47 -05:00
webpack.config.js Remove worker-loader (#23548) 2023-03-18 00:36:32 -04:00

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>