mirror of https://codeberg.org/forgejo/forgejo.git synced 2024-12-04 10:29:28 +03:00

Beyond coding. We forge.

Find a file

Loïc Dachary 25c528d428 [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`) (cherry picked from commit `5b4d25bd03`) (cherry picked from commit `24caf07034`) (cherry picked from commit `6cc68e9b08`) (cherry picked from commit `995d871d8e`) (cherry picked from commit `57568b055c`)		2023-07-10 18:39:40 +02:00
.forgejo	[CI] Forgejo Actions based release process (squash) MySQL optimization	2023-07-10 18:08:15 +02:00
.github/workflows	delete Gitea specific files that need rewriting for Forgejo	2023-07-10 18:39:40 +02:00
assets
build
cmd	[CLI] implement forgejo-cli actions register	2023-07-10 18:08:15 +02:00
contrib
custom/conf	Revert "Restrict `[actions].DEFAULT_ACTIONS_URL` to only `github` or `self` (#25581 ) (#25604 )"	2023-07-10 18:08:15 +02:00
docker
docs	Revert "Restrict `[actions].DEFAULT_ACTIONS_URL` to only `github` or `self` (#25581 ) (#25604 )"	2023-07-10 18:08:15 +02:00
models	[CLI] implement forgejo-cli actions register	2023-07-10 18:08:15 +02:00
modules	[CLI] implement forgejo-cli actions register	2023-07-10 18:08:15 +02:00
options
public/img
releases
routers	[CLI] implement forgejo-cli actions register	2023-07-10 18:08:15 +02:00
services
snap
templates
tests	[CLI] implement forgejo-cli actions register	2023-07-10 18:08:15 +02:00
web_src
.air.toml
.changelog.yml
.dockerignore
.drone.yml
.editorconfig
.eslintrc.yaml
.gitattributes
.gitignore
.gitpod.yml
.golangci.yml
.ignore
.markdownlint.yaml
.npmrc
.spectral.yaml
.stylelintrc.yaml
BSDmakefile
build.go
CHANGELOG.md
CODE_OF_CONDUCT.md
CONTRIBUTING.md	[DOCS] CONTRIBUTING	2023-07-10 18:39:40 +02:00
DCO
Dockerfile	[CI] backward compatible executable compilation	2023-07-10 18:08:15 +02:00
Dockerfile.rootless	[CI] backward compatible executable compilation	2023-07-10 18:08:15 +02:00
go.mod
go.sum
LICENSE
main.go	[CLI] implement forgejo-cli	2023-07-10 18:08:15 +02:00
MAINTAINERS
Makefile	[CI] backward compatible executable compilation	2023-07-10 18:08:15 +02:00
package-lock.json
package.json
playwright.config.js
vitest.config.js
webpack.config.js

docs/README.md

Gitea: Docs

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>