fc108d2064
TODO: - [x] clone from website instead of caesar - [x] skip the proof of change commit Preview: https://forgejo.codeberg.page/@docs_pull_5/ This is a simplistic approach to get started with previews. It copies the website, moves the docs under `/forgejo-docs/{{ base branch }}`, create the website and publishes it for preview. No doubt the actual workflow will be different but that needs to be decided. * Added a WEBSITETOKEN secret created from the forgejo-website user. It is a token with write access to repositories. https://codeberg.org/forgejo/docs/settings/actions/secrets. Contrary to woodpecker it is not in an environment variable but will be replaced when inserting `${{ secrets.WEBSITETOKEN }}` somewhere * In the environment the variable was replaced CI_COMMIT_PULL_REQUEST → `${{ env.GITHUB_REF_NAME }}` * The preview is published at https://forgejo.codeberg.page/@docs_pull_N/ instead of https://forgejo.codeberg.page/@pull_N/ * The `$$` were replaced with `$` in the script because Forgejo Actions does not interpret `$` and therefore does not need escaping them to `$$` Reviewed-on: https://codeberg.org/forgejo/docs/pulls/5 Reviewed-by: Loïc Dachary <dachary@noreply.codeberg.org> Reviewed-by: Caesar Schinas <caesar@caesarschinas.com> Co-authored-by: Earl Warren <contact@earl-warren.org> Co-committed-by: Earl Warren <contact@earl-warren.org> |
||
|---|---|---|
| .forgejo/workflows | ||
| docs | ||
| images/user | ||
| .editorconfig | ||
| .gitignore | ||
| README.md | ||
Forgejo Documentation
This is the documentation for Forgejo and is published on the Forgejo website.
The main development branch of this repo is the
next branch,
which documents the version of Forgejo that is currently being developed.
Each time a new major version of Forgejo is released, a new branch will be created in this repo to document the stable release.
Current release branches are as follows:
Documentation content lives in the docs subfolder, and images in the images subfolder.
Contributing
Pull Requests
PRs should usually be sent against the next branch.
Sometimes it will be appropriate to send a PR against a specific release branch if the changes only affect that release.
Most changes should either be sent as a single commit per PR, or should be squashed before merging. Fast-forwarding is the preferred merge strategy. Changes can then be backported (or if appropriate frontported) by cherry-picking.
Rarely, it will make sense to create a feature branch containting a series of commits that will be merged instead of squashing and fast-forwarding. Such a feature branch can then be merged into multiple versions of the docs if appropriate. In this case, the feature branch should usually be taken from the last common ancestor of all of the version branches into which it will potentially be merged.
Links
All internal links within the documentation content should be relative to each page's path
at the https://forgejo.org/docs/{{version}}/ URL.
File extensions (.md) should not be included, and every URL should end with a trailing slash.
Look at existing links for examples.
Images
Images should use relative URLs to the image files, which will be published at https://forgejo.org/images/{{version}}/.
Code of Conduct
All contributors are required to abide by the Forgejo Code of Conduct.
Feel free to reach out to the moderation team in case of any conflicts.
License
The documentation content originates from several different sources and each page has a different license.
Please check the license frontmatter key near the top of each file to see the relevant license.
Where not otherwise stated, content is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License.