1
0
Fork 0
Beyond coding. We forge. https://codeberg.org/forgejo/forgejo
Find a file
Loïc Dachary d68576ba67
[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)
2023-03-18 09:20:01 +01:00
.woodpecker [CI] implementation: Woodpecker based CI 2023-03-18 08:23:50 +01:00
assets
build
cmd
contrib
CONTRIBUTING [DOCS] CONTRIBUTING 2023-03-18 09:20:01 +01:00
custom/conf
docker
docs
models
modules
options
public
releases [CI] implementation: Woodpecker based CI 2023-03-18 08:23:50 +01:00
routers
services
snap
templates
tests [CI] [v1.20] tests/pgsql.ini.tmpl: do not use minio 2023-03-18 08:24:38 +01:00
tools
web_src
.air.toml
.changelog.yml
.dockerignore
.drone.yml
.editorconfig
.eslintrc.yaml
.gitattributes
.gitignore [CI] implementation: Woodpecker based CI 2023-03-18 08:23:50 +01:00
.gitpod.yml
.golangci.yml
.ignore
.lgtm
.markdownlint.yaml
.npmrc
.spectral.yaml
.stylelintrc.yaml
BSDmakefile
build.go
CHANGELOG.md
CODE_OF_CONDUCT.md
CONTRIBUTING.md [DOCS] CONTRIBUTING 2023-03-18 09:20:01 +01:00
DCO
Dockerfile [CI] implementation: forgejo container images 2023-03-18 08:23:50 +01:00
Dockerfile.rootless [CI] implementation: forgejo container images 2023-03-18 08:23:50 +01:00
go.mod
go.sum
LICENSE
main.go
MAINTAINERS
Makefile [CI] implementation: Woodpecker based CI 2023-03-18 08:23:50 +01:00
package-lock.json
package.json
playwright.config.js
vitest.config.js
webpack.config.js

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>