mirror of
1
Fork 0
Beyond coding. We forge.
Go to file
Loïc Dachary 1e6ba47216
[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)
2023-04-22 11:18:21 +02:00
.woodpecker [CI] implementation: Woodpecker based CI 2023-04-22 09:06:12 +02:00
CONTRIBUTING [DOCS] CONTRIBUTING 2023-04-22 11:18:21 +02:00
assets Allow `webp` images as avatars (#24248) 2023-04-21 13:15:49 -04:00
build Drop "unrolled/render" package (#23965) 2023-04-08 14:21:50 +08:00
cmd add CLI command to register runner tokens (#23762) 2023-04-17 13:07:13 -04:00
contrib Update github.com/google/go-github to v51 (#23946) 2023-04-08 19:27:30 +08:00
custom/conf Correct the access log format (#24085) 2023-04-13 21:14:06 +08:00
docker Wrap unless-check in docker manifests (#23079) 2023-02-22 16:33:31 -06:00
docs zh-cn support on doc pages (#24166) 2023-04-18 08:23:35 +08:00
models Improve test logger (#24235) 2023-04-21 16:32:25 -04:00
modules Improve test logger (#24235) 2023-04-21 16:32:25 -04:00
options [skip ci] Updated translations via Crowdin 2023-04-22 00:07:44 +00:00
public Update JS deps (#23853) 2023-04-02 19:47:14 -04:00
releases [CI] implementation: Woodpecker based CI 2023-04-22 09:06:12 +02:00
routers Show commit history for closed/merged PRs (#24238) 2023-04-21 12:36:37 -04:00
services Improve test logger (#24235) 2023-04-21 16:32:25 -04:00
snap Remove unnecessary whitespace in snapcraft.yaml (#22090) 2022-12-10 08:31:16 -06:00
templates Fix footer display (#24251) 2023-04-22 01:58:59 -04:00
tests [CI] [v1.20] tests/pgsql.ini.tmpl: do not use minio 2023-04-22 09:06:12 +02:00
web_src Fix footer display (#24251) 2023-04-22 01:58:59 -04: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 (#24218) 2023-04-19 22:36:41 -04:00
.editorconfig Add markdownlint (#20512) 2022-07-28 09:22:47 +08:00
.eslintrc.yaml Introduce eslint-plugin-no-jquery/no-event-shorthand (#24198) 2023-04-20 05:28:27 -04:00
.gitattributes Mark `public/img/svg/*.svg` as generated files (#24193) 2023-04-18 13:52:18 -04:00
.gitignore [CI] implementation: Woodpecker based CI 2023-04-22 09:06:12 +02:00
.gitpod.yml Remove docs from automatically building in Gitpod (#23978) 2023-04-07 15:55:25 -04:00
.golangci.yml Remove most path-based golangci exclusions (#24214) 2023-04-19 22:08:01 -04: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 Update JS deps (#23853) 2023-04-02 19:47:14 -04:00
BSDmakefile update BSDmakefile to latest version from upstream (#24063) 2023-04-11 23:42:22 -04:00
CHANGELOG.md Changelog v1.19.1 (#24079) (#24092) 2023-04-13 16:45:54 +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-04-22 11:18:21 +02:00
DCO Remove address from DCO (#22595) 2023-01-24 18:52:38 +00:00
Dockerfile [CI] implementation: forgejo container images 2023-04-22 09:06:12 +02:00
Dockerfile.rootless [CI] implementation: forgejo container images 2023-04-22 09:06:12 +02:00
LICENSE Fix typo 2016-11-08 08:42:05 +01:00
MAINTAINERS Apply to become maintainer (#24254) 2023-04-21 21:23:16 +08:00
Makefile [CI] implementation: Woodpecker based CI 2023-04-22 09:06:12 +02:00
build.go User/Org Feed render description as per web (#23887) 2023-04-04 04:39:47 +01:00
go.mod Allow `webp` images as avatars (#24248) 2023-04-21 13:15:49 -04:00
go.sum Allow `webp` images as avatars (#24248) 2023-04-21 13:15:49 -04:00
main.go add CLI command to register runner tokens (#23762) 2023-04-17 13:07:13 -04:00
package-lock.json Introduce eslint-plugin-no-jquery/no-event-shorthand (#24198) 2023-04-20 05:28:27 -04:00
package.json Introduce eslint-plugin-no-jquery/no-event-shorthand (#24198) 2023-04-20 05:28:27 -04: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 (#24218) 2023-04-19 22:36:41 -04:00
webpack.config.js Introduce GiteaLocaleNumber custom element to handle number localization on pages. (#23861) 2023-04-03 12:58:09 -04: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>