mirrors/forgejo
1
0
Fork 0
mirror of https://codeberg.org/forgejo/forgejo synced 2024-06-24 10:55:00 +02:00
Code Issues Packages Projects Releases Wiki Activity
14821 commits 24 branches 219 tags 946 MiB
Go 73.6%
go-html-template 11.4%
JavaScript 5.1%
Roff 5%
CSS 3.4%
Other 1.3%
Go to file
Loïc Dachary 06015101a1
[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 6577fad1c9)
(cherry picked from commit d5b78a53fe)
(cherry picked from commit ddc09375ca)
2023-04-11 23:49:18 +02:00
.woodpecker [CI] [v1.19] pin test_env:1.19 2023-04-11 23:04:56 +02:00
assets Update act (#23512) (#23518) 2023-03-16 09:33:11 -05:00
build Consume hcaptcha and pwn deps (#22610) 2023-01-29 09:49:51 -06:00
cmd Make minio package support legacy MD5 checksum (#23768) (#23770) 2023-03-29 00:02:13 +08:00
contrib Add Bash and Zsh completion scripts (#22646) 2023-02-21 12:32:24 -05:00
CONTRIBUTING [DOCS] CONTRIBUTING 2023-04-11 23:49:18 +02:00
custom/conf Rename actions unit to repo.actions and add docs for it (#23733) (#23881) 2023-04-03 12:54:36 +02:00
docker Wrap unless-check in docker manifests (#23079) (#23081) 2023-02-23 01:34:47 +01:00
docs Update documentation to explain which projects allow Gitea to host static pages (#23993) (#24058) 2023-04-11 18:43:35 +02:00
models Fix branch protection priority (#24045) (#24061) 2023-04-11 21:07:38 +02:00
modules Remove Repository.getFilesChanged to fix Actions paths and paths-ignore filter (#23920) (#23969) 2023-04-08 16:16:21 +08:00
options Title can be empty when creating tag only (#23917) (#23961) 2023-04-07 20:13:57 +08:00
public Add Chef package registry (#22554) 2023-02-06 09:49:21 +08:00
releases [CI] implementation: Woodpecker based CI 2023-04-11 23:03:51 +02:00
routers Add actions support to package auth verification (#23729) (#24028) 2023-04-10 10:36:21 +02:00
services Use actions job link as commit status URL instead of run link (#24023) (#24032) 2023-04-10 08:46:36 -05:00
snap Remove unnecessary whitespace in snapcraft.yaml (#22090) 2022-12-10 08:31:16 -06:00
templates fix: do not escape space between PyPI repository url and package name… (#23981) (#24008) 2023-04-08 23:13:43 +02:00
tests [CI] set PASSWORD_HASH_ALGO = argon2 for integration tests 2023-04-11 23:04:55 +02:00
tools Move fuzz tests into tests/fuzz (#22376) 2023-01-09 15:30:14 +08:00
web_src Show errors for KaTeX and mermaid on the preview tab (#24009) (#24019) 2023-04-09 08:48:28 -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 test_env: hardcode major go version in use (#23464) 2023-03-14 04:12:14 -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-04-11 23:03:51 +02: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
.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 Replace Less with CSS (#23508) 2023-03-16 21:04:39 -04:00
BSDmakefile
build.go User/Org Feed render description as per web (#23887) (#23906) 2023-04-04 00:44:50 -04:00
CHANGELOG.md Add CHANGELOG for 1.19.0 (#23583) (#23586) 2023-03-20 16:34:28 +08:00
CONTRIBUTING.md [DOCS] CONTRIBUTING 2023-04-11 23:49:18 +02:00
DCO Remove address from DCO (#22595) 2023-01-24 18:52:38 +00:00
Dockerfile [CI] implementation: forgejo container images 2023-04-11 23:04:49 +02:00
Dockerfile.rootless [CI] implementation: forgejo container images 2023-04-11 23:04:49 +02:00
go.mod Do not crash when parsing an invalid workflow file (#23972) (#23976) 2023-04-07 09:55:59 -04:00
go.sum Do not crash when parsing an invalid workflow file (#23972) (#23976) 2023-04-07 09:55:59 -04: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-04-11 23:03:51 +02:00
package-lock.json Polyfill the window.customElements (#23592) (#23595) 2023-03-20 19:52:05 +01:00
package.json Polyfill the window.customElements (#23592) (#23595) 2023-03-20 19:52:05 +01: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 Replace Less with CSS (#23508) 2023-03-16 21:04:39 -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

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