1
0
Fork 0
mirror of https://codeberg.org/forgejo/forgejo.git synced 2024-12-26 13:29:12 -05:00
Beyond coding. We forge. (Code of Conduct: https://codeberg.org/forgejo/code-of-conduct) https://forgejo.org/
Find a file
Loïc Dachary 663e28c412
[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)
2023-05-10 08:55:37 +02:00
.github/workflows delete Gitea specific files that need rewriting for Forgejo 2023-05-10 08:55:33 +02:00
.woodpecker [CI] implementation: Woodpecker based CI 2023-05-10 07:23:12 +02:00
assets Add RPM registry (#23380) 2023-05-05 20:33:37 +00:00
build Replace placeholders in licenses (#24354) 2023-05-05 13:46:17 +00:00
cmd Rewrite queue (#24505) 2023-05-08 19:49:59 +08:00
contrib Updated upgrade script that is informing user that Gitea service has to be running in order to upgrade it (#24260) 2023-04-25 13:19:58 -04:00
CONTRIBUTING [DOCS] CONTRIBUTING 2023-05-10 08:55:37 +02:00
custom/conf Rewrite queue (#24505) 2023-05-08 19:49:59 +08:00
docker Unify nightly naming across binaries and docker images (#24116) 2023-04-24 23:43:19 +08:00
docs Add Gitea Profile Readmes (#23260) 2023-05-09 05:57:24 +00:00
models Fix commits pushed with deploy keys not shown in dashboard (#24521) 2023-05-10 04:14:58 +00:00
modules Remove unnecessary code (#24610) 2023-05-10 04:57:06 +00:00
options Add Gitea Profile Readmes (#23260) 2023-05-09 05:57:24 +00:00
public Add RPM registry (#23380) 2023-05-05 20:33:37 +00:00
releases [CI] implementation: Woodpecker based CI 2023-05-10 07:23:12 +02:00
routers fix: release page for empty or non-existing target (#24470) 2023-05-10 11:43:55 +08:00
services Filter get single commit (#24613) 2023-05-10 09:34:07 +08:00
snap Remove unnecessary whitespace in snapcraft.yaml (#22090) 2022-12-10 08:31:16 -06:00
templates fix: release page for empty or non-existing target (#24470) 2023-05-10 11:43:55 +08:00
tests [CI] tests/pgsql.ini.tmpl: do not use minio 2023-05-10 07:30:24 +02:00
web_src Attach a tooltip to the action status icon (#24614) 2023-05-09 21:39:16 +02:00
.air.toml Set stop_on_error (#24453) 2023-04-30 18:31:16 -04: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 Upgrade to Node 20 on CI, enable actions cancellation (#24524) 2023-05-04 22:21:48 +00:00
.editorconfig Add markdownlint (#20512) 2022-07-28 09:22:47 +08:00
.eslintrc.yaml Update JS dependencies, add new eslint rules (#24597) 2023-05-09 02:35:49 +00:00
.gitattributes Mark /templates/swagger/v1_json.tmpl as generated file (#24306) 2023-04-24 13:18:24 -04:00
.gitignore [CI] implementation: Woodpecker based CI 2023-05-10 07:23:12 +02:00
.gitpod.yml Use official Vue extension in Gitpod (#24609) 2023-05-09 18:03:50 +00:00
.golangci.yml Enable forbidigo linter (#24278) 2023-04-24 05:50:58 -04:00
.ignore Add some .ignore entries (#18296) 2022-01-16 17:26:15 +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 Enhance stylelint rule config, remove dead CSS (#24472) 2023-05-02 23:15:52 -04:00
BSDmakefile update BSDmakefile to latest version from upstream (#24063) 2023-04-11 23:42:22 -04:00
build.go User/Org Feed render description as per web (#23887) 2023-04-04 04:39:47 +01:00
CHANGELOG.md Changelog for 1.19.3 (#24495) (#24506) 2023-05-03 22:05:47 -04: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-05-10 08:55:37 +02:00
DCO Remove address from DCO (#22595) 2023-01-24 18:52:38 +00:00
Dockerfile [CI] implementation: forgejo container images 2023-05-10 07:23:12 +02:00
Dockerfile.rootless [CI] implementation: forgejo container images 2023-05-10 07:23:12 +02:00
go.mod Add RPM registry (#23380) 2023-05-05 20:33:37 +00:00
go.sum Add RPM registry (#23380) 2023-05-05 20:33:37 +00:00
LICENSE Fix typo 2016-11-08 08:42:05 +01:00
main.go add CLI command to register runner tokens (#23762) 2023-04-17 13:07:13 -04:00
MAINTAINERS Apply to become maintainer (#24254) 2023-04-21 21:23:16 +08:00
Makefile [CI] implementation: Woodpecker based CI 2023-05-10 07:23:12 +02:00
package-lock.json Update JS dependencies, add new eslint rules (#24597) 2023-05-09 02:35:49 +00:00
package.json Update JS dependencies, add new eslint rules (#24597) 2023-05-09 02:35:49 +00: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 Remove font-awesome and fomantic icon module (#24471) 2023-05-01 13:25:54 -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>