forgejo-docs/user/index.md

---
layout: '~/layouts/Markdown.astro'
title: 'Forgejo user guide'
---

These documents are targeted to people who are using Forgejo but are not
involved in running it on their machines.

- Getting started
  - [Your First Repository](first-repository)
  - [The Basics of Issue Tracking](issue-tracking-basics)
  - [Integrated Wiki](wiki)
  - [Email Settings](email-settings)
- Collaborating with Others
  - [Projects / Kanban boards](project)
  - [Pull requests and Git flow](https://docs.codeberg.org/collaborating/pull-requests-and-git-flow/)
  - [Invite Collaborators](https://docs.codeberg.org/collaborating/invite-collaborators/)
  - [Create and Manage an Organization](https://docs.codeberg.org/collaborating/create-organization/)
  - [Repository Permissions](repo-permissions)
  - [Resolve Conflicts](https://docs.codeberg.org/collaborating/resolve-conflicts/)
  - [Citable Code](https://docs.codeberg.org/collaborating/citable-code/)
  - [Labels](labels)
  - [Automatically Linked References](linked-references)
  - [Blocking users](blocking-user)
  - [Profile costumization](profile)
- Working with Git Repositories
  - [Clone & Commit via Web](https://docs.codeberg.org/git/clone-commit-via-web/)
  - [Tags and Releases](https://docs.codeberg.org/git/using-tags/)
  - [Branch and tag protection](protection)
- Advanced Usage
  - [Issue and Pull Request Templates](issue-pull-request-templates)
  - [Actions](actions)
  - [Merge Message templates](merge-message-templates)
  - [Webhooks](webhooks)
  - Authentication
    - [Generating an Access Token](https://docs.codeberg.org/advanced/access-token/)
    - [Access Token scope](token-scope)
    - [LDAP, PAM, FreeIPA](authentication)
    - [OAuth2, Client Types](oauth2-provider)
  - [Semantic version](semver)
  - [API Usage](api-usage)
  - [API Reference](https://codeberg.org/api/swagger)
  - [Migrating Repositories](https://docs.codeberg.org/advanced/migrating-repos/)
  - [Push Options](push-options)
  - [Push to create](push-to-create)
  - [Agit setup](agit-support)
  - [Packages](packages)
- See also
  - [Codeberg guide on Git](https://docs.codeberg.org/git/)
  - [Codeberg guide on Markdown](https://docs.codeberg.org/markdown/)
  - [Codeberg guide on Integrating with Matrix](https://docs.codeberg.org/integrations/matrix/)
  - [Codeberg guide on Integrating with Read the Docs](https://docs.codeberg.org/integrations/read-the-docs/)
split the documentation into user/developer/admin 2023-03-01 12:47:26 -05:00			`---`
			`layout: '~/layouts/Markdown.astro'`
replace 1.19 with 1.20 where relevant 2023-03-26 05:52:16 -04:00			`title: 'Forgejo user guide'`
split the documentation into user/developer/admin 2023-03-01 12:47:26 -05:00			`---`

Describe target audiences Since we have different types of documentation I consider it helpful to have a one-liner explaining who we want to reach with each part. Signed-off-by: André Jaenisch <andre.jaenisch@posteo.de> 2023-03-03 14:58:14 -05:00			`These documents are targeted to people who are using Forgejo but are not`
			`involved in running it on their machines.`

organize the index of the user guide Follow the model of https://docs.codeberg.org/ The pages or sections that are not relevant for Forgejo (such as working with the Codeberg CI are not included) The pages that have not yet been adapted to Forgejo are set to link to the Codeberg documentation instead 2023-03-07 04:03:06 -05:00			`- Getting started`
			`- [Your First Repository](first-repository)`
			`- [The Basics of Issue Tracking](issue-tracking-basics)`
			`- [Integrated Wiki](wiki)`
			`- [Email Settings](email-settings)`
			`- Collaborating with Others`
			`- [Projects / Kanban boards](project)`
			`- [Pull requests and Git flow](https://docs.codeberg.org/collaborating/pull-requests-and-git-flow/)`
			`- [Invite Collaborators](https://docs.codeberg.org/collaborating/invite-collaborators/)`
			`- [Create and Manage an Organization](https://docs.codeberg.org/collaborating/create-organization/)`
repo-permissions.md: adapt to Forgejo 2023-03-07 04:48:34 -05:00			`- [Repository Permissions](repo-permissions)`
organize the index of the user guide Follow the model of https://docs.codeberg.org/ The pages or sections that are not relevant for Forgejo (such as working with the Codeberg CI are not included) The pages that have not yet been adapted to Forgejo are set to link to the Codeberg documentation instead 2023-03-07 04:03:06 -05:00			`- [Resolve Conflicts](https://docs.codeberg.org/collaborating/resolve-conflicts/)`
			`- [Citable Code](https://docs.codeberg.org/collaborating/citable-code/)`
			`- [Labels](labels)`
linked-references.md: adapt to Forgejo 2023-03-07 05:01:07 -05:00			`- [Automatically Linked References](linked-references)`
Add moderation documentation - Add user docs for: https://codeberg.org/forgejo/forgejo/pulls/540 - Document `forgejo-moderation` branch. # Conflicts: # user/blocking-user.md 2023-06-03 10:10:27 -04:00			`- [Blocking users](blocking-user)`
docs: user: profile: document user custom profiles # Conflicts: # user/profile.md 2023-07-24 11:21:31 -04:00			`- [Profile costumization](profile)`
organize the index of the user guide Follow the model of https://docs.codeberg.org/ The pages or sections that are not relevant for Forgejo (such as working with the Codeberg CI are not included) The pages that have not yet been adapted to Forgejo are set to link to the Codeberg documentation instead 2023-03-07 04:03:06 -05:00			`- Working with Git Repositories`
			`- [Clone & Commit via Web](https://docs.codeberg.org/git/clone-commit-via-web/)`
			`- [Tags and Releases](https://docs.codeberg.org/git/using-tags/)`
			`- [Branch and tag protection](protection)`
			`- Advanced Usage`
issue-pull-request-templates.md: adapt to Forgejo 2023-03-07 05:10:27 -05:00			`- [Issue and Pull Request Templates](issue-pull-request-templates)`
docs: actions user documentation # Conflicts: # user/actions.md 2023-05-29 08:10:16 -04:00			`- [Actions](actions)`
merge-message-templates.md: adapt to Forgejo 2023-03-09 01:43:38 -05:00			`- [Merge Message templates](merge-message-templates)`
organize the index of the user guide Follow the model of https://docs.codeberg.org/ The pages or sections that are not relevant for Forgejo (such as working with the Codeberg CI are not included) The pages that have not yet been adapted to Forgejo are set to link to the Codeberg documentation instead 2023-03-07 04:03:06 -05:00			`- [Webhooks](webhooks)`
			`- Authentication`
docs: user: authentication: move token scope out of the oauth2 section # Conflicts: # user/token-scope.md 2023-07-24 10:14:11 -04:00			`- [Generating an Access Token](https://docs.codeberg.org/advanced/access-token/)`
			`- [Access Token scope](token-scope)`
organize the index of the user guide Follow the model of https://docs.codeberg.org/ The pages or sections that are not relevant for Forgejo (such as working with the Codeberg CI are not included) The pages that have not yet been adapted to Forgejo are set to link to the Codeberg documentation instead 2023-03-07 04:03:06 -05:00			`- [LDAP, PAM, FreeIPA](authentication)`
docs: user: authentication: move token scope out of the oauth2 section # Conflicts: # user/token-scope.md 2023-07-24 10:14:11 -04:00			`- [OAuth2, Client Types](oauth2-provider)`
add section about semantic version 2023-03-16 04:58:03 -04:00			`- [Semantic version](semver)`
organize the index of the user guide Follow the model of https://docs.codeberg.org/ The pages or sections that are not relevant for Forgejo (such as working with the Codeberg CI are not included) The pages that have not yet been adapted to Forgejo are set to link to the Codeberg documentation instead 2023-03-07 04:03:06 -05:00			`- [API Usage](api-usage)`
			`- [API Reference](https://codeberg.org/api/swagger)`
			`- [Migrating Repositories](https://docs.codeberg.org/advanced/migrating-repos/)`
push-options.md: adapt to Forgejo 2023-03-07 05:18:05 -05:00			`- [Push Options](push-options)`
docs: add push-to-create documentation Closes: https://codeberg.org/forgejo/website/issues/182 2023-03-14 17:18:54 -04:00			`- [Push to create](push-to-create)`
agit-support.md: adapt to Forgejo 2023-03-07 05:24:35 -05:00			`- [Agit setup](agit-support)`
docs: packages are user documentation, not admin 2023-03-19 06:57:10 -04:00			`- [Packages](packages)`
organize the index of the user guide Follow the model of https://docs.codeberg.org/ The pages or sections that are not relevant for Forgejo (such as working with the Codeberg CI are not included) The pages that have not yet been adapted to Forgejo are set to link to the Codeberg documentation instead 2023-03-07 04:03:06 -05:00			`- See also`
			`- [Codeberg guide on Git](https://docs.codeberg.org/git/)`
			`- [Codeberg guide on Markdown](https://docs.codeberg.org/markdown/)`
links to the new RTD integration guide + existing Matrix guide 2023-03-13 04:03:11 -04:00			`- [Codeberg guide on Integrating with Matrix](https://docs.codeberg.org/integrations/matrix/)`
			`- [Codeberg guide on Integrating with Read the Docs](https://docs.codeberg.org/integrations/read-the-docs/)`