fedi/forgejo
1
0
Fork 0
mirror of https://codeberg.org/forgejo/forgejo.git synced 2024-11-15 02:45:22 +00:00
Code Issues Packages Projects Releases Wiki Activity
Beyond coding. We forge. (Code of Conduct: https://codeberg.org/forgejo/code-of-conduct)
14671 commits 19 branches 233 tags 598 MiB
Go 73.9%
go-html-template 11.3%
JavaScript 5.1%
Roff 4.7%
CSS 3.2%
Other 1.6%
Go to file
Loïc Dachary b37e18f275
[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)
2023-03-06 01:20:58 +01:00
.woodpecker [CI] implementation: Woodpecker based CI 2023-03-05 23:05:53 +00:00
assets Use import of OCI structs (#22765) 2023-02-06 10:07:09 +00:00
build Consume hcaptcha and pwn deps (#22610) 2023-01-29 09:49:51 -06:00
cmd Close the temp file when dumping database to make the temp file can be deleted on Windows (#23249) (#23251) 2023-03-02 11:47:07 -05:00
contrib Add Bash and Zsh completion scripts (#22646) 2023-02-21 12:32:24 -05:00
CONTRIBUTING [DOCS] CONTRIBUTING 2023-03-06 01:20:58 +01:00
custom/conf Add InsecureSkipVerify to Minio Client for Storage (#23166) (#23177) 2023-02-28 00:29:17 +02:00
docker Wrap unless-check in docker manifests (#23079) (#23081) 2023-02-23 01:34:47 +01:00
docs Add basic documentation for labels, including scoped labels (#23304) (#23309) 2023-03-05 20:38:46 +08:00
models Use correct README link to render the README (#23152) (#23264) 2023-03-04 00:38:11 -05:00
modules Fix various bugs for "install" page (#23194) (#23286) 2023-03-05 11:59:58 +01:00
options Fix various bugs for "install" page (#23194) (#23286) 2023-03-05 11:59:58 +01:00
public Add Chef package registry (#22554) 2023-02-06 09:49:21 +08:00
releases [CI] implementation: Woodpecker based CI 2023-03-05 23:05:53 +00:00
routers Fix various bugs for "install" page (#23194) (#23286) 2023-03-05 11:59:58 +01:00
services Fill head commit to in payload when notifying push commits for mirroring (#23215) (#23292) 2023-03-04 19:02:50 +01:00
snap Remove unnecessary whitespace in snapcraft.yaml (#22090) 2022-12-10 08:31:16 -06:00
templates Fix various bugs for "install" page (#23194) (#23286) 2023-03-05 11:59:58 +01:00
tests [CI] set PASSWORD_HASH_ALGO = argon2 for integration tests 2023-03-05 23:05:53 +00:00
tools Move fuzz tests into tests/fuzz (#22376) 2023-01-09 15:30:14 +08:00
web_src Scoped labels: set aria-disabled on muted Exclusive option for a11y (#23306) (#23311) 2023-03-05 23:05:11 +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 only trigger docs build and publish when docs changed (#22968) 2023-02-20 21:08:41 +08: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-05 23:05:53 +00:00
.gitpod.yml Split default gitpod view to include all tasks (#22555) 2023-01-20 13:46:33 -06: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 Stop packaging node_modules in release tarballs (#15273) 2021-04-09 01:08:14 -04:00
.spectral.yaml Add spectral linter for Swagger (#20321) 2022-07-11 18:07:16 -05:00
.stylelintrc.yaml Upgrade to stylelint 15 (#22944) 2023-02-21 09:23:45 -06: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 Changelog 1.18.5 (#23045) (#23049) 2023-02-21 13:36:19 -06:00
CONTRIBUTING.md [DOCS] CONTRIBUTING 2023-03-06 01:20:58 +01:00
DCO Remove address from DCO (#22595) 2023-01-24 18:52:38 +00:00
Dockerfile [CI] implementation: forgejo container images 2023-03-05 23:05:53 +00:00
Dockerfile.rootless [CI] implementation: forgejo container images 2023-03-05 23:05:53 +00:00
go.mod Bump golang.org/x/net from 0.4.0 to 0.7.0 (#22980) 2023-02-20 23:52:21 +08:00
go.sum Bump golang.org/x/net from 0.4.0 to 0.7.0 (#22980) 2023-02-20 23:52:21 +08:00
LICENSE
main.go Add Bash and Zsh completion scripts (#22646) 2023-02-21 12:32:24 -05:00
MAINTAINERS Add sillyguodong to maintainers (#23067) 2023-02-22 18:32:00 +08:00
Makefile [CI] implementation: Woodpecker based CI 2023-03-05 23:05:53 +00:00
package-lock.json update to mermaid v10 (#23178) (#23299) 2023-03-05 02:13:50 -05:00
package.json update to mermaid v10 (#23178) (#23299) 2023-03-05 02:13:50 -05: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 update to mermaid v10 (#23178) (#23299) 2023-03-05 02:13:50 -05: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>