fedi/forgejo
1
0
Fork 0
mirror of https://codeberg.org/forgejo/forgejo.git synced 2024-12-22 08:38:29 +00:00
Code Issues Packages Projects Releases Wiki Activity
Beyond coding. We forge. (Code of Conduct: https://codeberg.org/forgejo/code-of-conduct)
15661 commits 21 branches 237 tags 604 MiB
Go 73.9%
go-html-template 11.3%
JavaScript 5%
Roff 4.7%
CSS 3.2%
Other 1.7%
Go to file
Loïc Dachary 5b4d25bd03
[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)
2023-06-12 23:46:19 +02:00
.forgejo/workflows [CI] Use Forgejo Actions for PR & branch CI 2023-06-12 23:09:07 +02:00
.github/workflows delete Gitea specific files that need rewriting for Forgejo 2023-06-12 23:46:17 +02:00
assets Update github.com/google/go-github to v53 (#25157) 2023-06-09 19:42:51 +00:00
build Refactor INI package (first step) (#25024) 2023-06-02 17:27:30 +08:00
cmd Use the type RefName for all the needed places and fix pull mirror sync bugs (#24634) 2023-05-26 01:04:48 +00:00
contrib Update github.com/google/go-github to v53 (#25157) 2023-06-09 19:42:51 +00:00
custom/conf Remove the service worker (#25010) 2023-05-31 02:07:04 +00:00
docker Unify nightly naming across binaries and docker images (#24116) 2023-04-24 23:43:19 +08:00
docs Improve some documents: release version, logging, NFS lock (#25202) 2023-06-12 17:05:49 +08:00
models Fix duplicate Reviewed-by trailers (#24796) 2023-06-09 16:34:49 +02:00
modules [CI] Search .forgejo/workflows first 2023-06-12 23:09:07 +02:00
options [skip ci] Updated licenses and gitignores 2023-06-12 00:29:16 +00:00
public/img Modify OAuth login ui and fix display name, iconurl related logic (#25030) 2023-06-08 16:35:29 +00:00
releases [CI] Woodpecker based releases process 2023-06-12 23:08:38 +02:00
routers Do not overwrite the log mode when installing (#25203) 2023-06-12 10:52:49 +00:00
services Add WithPullRequest for actionsNotifier (#25144) 2023-06-11 09:06:43 +08:00
snap Upgrade snap to node 20 (#24990) 2023-05-29 22:41:56 +02:00
templates Adjust style for action run list (align icons, adjust padding) (#25170) 2023-06-12 09:36:08 +00:00
tests [CI] tests/pgsql.ini.tmpl: do not use minio 2023-06-12 23:09:06 +02:00
web_src Remove hacky patch for "safari emoji glitch fix" (#25208) 2023-06-12 15:44:53 +00:00
.air.toml Reduce verbosity of dev commands (#24917) 2023-05-24 20:11:04 +00:00
.changelog.yml
.dockerignore Remove the service worker (#25010) 2023-05-31 02:07:04 +00:00
.drone.yml Upgrade to Node 20 on CI, enable actions cancellation (#24524) 2023-05-04 22:21:48 +00:00
.editorconfig
.eslintrc.yaml Update js dependencies (#25137) 2023-06-08 10:54:31 +00:00
.gitattributes Add PDF rendering via PDFObject (#24086) 2023-05-29 12:10:00 +00:00
.gitignore [CI] Woodpecker based releases process 2023-06-12 23:08:38 +02:00
.gitpod.yml Use official Vue extension in Gitpod (#24609) 2023-05-09 18:03:50 +00:00
.golangci.yml Refactor INI package (first step) (#25024) 2023-06-02 17:27:30 +08:00
.ignore Remove the service worker (#25010) 2023-05-31 02:07:04 +00:00
.markdownlint.yaml
.npmrc Upgrade to npm lockfile v3 and explicitely set it (#23561) 2023-03-18 19:38:10 +01:00
.spectral.yaml
.stylelintrc.yaml Fix @font-face overrides (#24855) 2023-05-24 01:48:51 +00: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-06-12 23:46:19 +02:00
DCO
Dockerfile [CI] implementation: forgejo container images 2023-06-12 23:09:06 +02:00
Dockerfile.rootless [CI] implementation: forgejo container images 2023-06-12 23:09:06 +02:00
go.mod Update github.com/google/go-github to v53 (#25157) 2023-06-09 19:42:51 +00:00
go.sum Update github.com/google/go-github to v53 (#25157) 2023-06-09 19:42:51 +00:00
LICENSE
main.go Rewrite logger system (#24726) 2023-05-21 22:35:11 +00:00
MAINTAINERS Add self to maintainers (#23644) 2023-05-25 07:58:38 +08:00
Makefile [CI] Woodpecker based releases process 2023-06-12 23:08:38 +02:00
package-lock.json Update js dependencies (#25137) 2023-06-08 10:54:31 +00:00
package.json Update js dependencies (#25137) 2023-06-08 10:54:31 +00:00
playwright.config.js
vitest.config.js Update JS dependencies (#24218) 2023-04-19 22:36:41 -04:00
webpack.config.js Enable all webpack sourcemaps in dev build, disable all in prod build (#25089) 2023-06-06 12:57:08 +08: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

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