foster/forgejo-docs
0
0
Fork 0
mirror of https://codeberg.org/forgejo/docs.git synced 2024-11-26 18:29:35 -05:00
Code Issues Activity
forgejo-docs/docs/user/index.md

53 lines
2.4 KiB
Markdown
Raw Normal View History

split the documentation into user/developer/admin
2023-03-01 12:47:26 -05:00
---
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
refactor: use astro content collections for docs Reviewed-on: https://codeberg.org/forgejo/website/pulls/323 # Conflicts: # v1.19/admin/command-line.md # v1.19/admin/config-cheat-sheet.md # v1.19/admin/database-preparation.md # v1.19/admin/email-setup.md # v1.19/admin/incoming-email.md # v1.19/admin/index.md # v1.19/admin/logging-documentation.md # v1.19/admin/reverse-proxy.md # v1.19/admin/seek-assistance.md # v1.19/admin/upgrade.md # v1.19/developer/code-forgejo-org.md # v1.19/developer/index.md # v1.19/index.md # v1.19/license.md # v1.19/user/agit-support.md # v1.19/user/api-usage.md # v1.19/user/authentication.md # v1.19/user/email-settings.md # v1.19/user/first-repository.md # v1.19/user/index.md # v1.19/user/issue-pull-request-templates.md # v1.19/user/issue-tracking-basics.md # v1.19/user/labels.md # v1.19/user/linked-references.md # v1.19/user/merge-message-templates.md # v1.19/user/oauth2-provider.md # v1.19/user/packages/cargo.md # v1.19/user/packages/chef.md # v1.19/user/packages/composer.md # v1.19/user/packages/conan.md # v1.19/user/packages/conda.md # v1.19/user/packages/container.md # v1.19/user/packages/generic.md # v1.19/user/packages/helm.md # v1.19/user/packages/index.md # v1.19/user/packages/maven.md # v1.19/user/packages/npm.md # v1.19/user/packages/nuget.md # v1.19/user/packages/pub.md # v1.19/user/packages/pypi.md # v1.19/user/packages/rubygems.md # v1.19/user/packages/storage.md # v1.19/user/packages/vagrant.md # v1.19/user/project.md # v1.19/user/protection.md # v1.19/user/push-options.md # v1.19/user/push-to-create.md # v1.19/user/repo-permissions.md # v1.19/user/webhooks.md # v1.19/user/wiki.md # v1.20/user/semver.md
2023-07-26 18:20:30 -04:00
- [Your First Repository](./first-repository/)
- [The Basics of Issue Tracking](./issue-tracking-basics/)
- [Integrated Wiki](./wiki/)
- [Email Settings](./email-settings/)
Add next.forgejo.org documentation
2023-08-29 21:49:52 -04:00
- [Forgejo Next](./forgejo-next/)
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
- Collaborating with Others
user: pull-request: import from Codeberg
2023-11-15 16:51:07 -05:00
- [Pull requests and Git flow](./pull-requests-and-git-flow/)
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
- [Invite Collaborators](https://docs.codeberg.org/collaborating/invite-collaborators/)
user: pull-request: import from Codeberg
2023-11-15 16:51:07 -05:00
- [Labels](./labels/)
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
- [Create and Manage an Organization](https://docs.codeberg.org/collaborating/create-organization/)
refactor: use astro content collections for docs Reviewed-on: https://codeberg.org/forgejo/website/pulls/323 # Conflicts: # v1.19/admin/command-line.md # v1.19/admin/config-cheat-sheet.md # v1.19/admin/database-preparation.md # v1.19/admin/email-setup.md # v1.19/admin/incoming-email.md # v1.19/admin/index.md # v1.19/admin/logging-documentation.md # v1.19/admin/reverse-proxy.md # v1.19/admin/seek-assistance.md # v1.19/admin/upgrade.md # v1.19/developer/code-forgejo-org.md # v1.19/developer/index.md # v1.19/index.md # v1.19/license.md # v1.19/user/agit-support.md # v1.19/user/api-usage.md # v1.19/user/authentication.md # v1.19/user/email-settings.md # v1.19/user/first-repository.md # v1.19/user/index.md # v1.19/user/issue-pull-request-templates.md # v1.19/user/issue-tracking-basics.md # v1.19/user/labels.md # v1.19/user/linked-references.md # v1.19/user/merge-message-templates.md # v1.19/user/oauth2-provider.md # v1.19/user/packages/cargo.md # v1.19/user/packages/chef.md # v1.19/user/packages/composer.md # v1.19/user/packages/conan.md # v1.19/user/packages/conda.md # v1.19/user/packages/container.md # v1.19/user/packages/generic.md # v1.19/user/packages/helm.md # v1.19/user/packages/index.md # v1.19/user/packages/maven.md # v1.19/user/packages/npm.md # v1.19/user/packages/nuget.md # v1.19/user/packages/pub.md # v1.19/user/packages/pypi.md # v1.19/user/packages/rubygems.md # v1.19/user/packages/storage.md # v1.19/user/packages/vagrant.md # v1.19/user/project.md # v1.19/user/protection.md # v1.19/user/push-options.md # v1.19/user/push-to-create.md # v1.19/user/repo-permissions.md # v1.19/user/webhooks.md # v1.19/user/wiki.md # v1.20/user/semver.md
2023-07-26 18:20:30 -04: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/)
user: pull-request: import from Codeberg
2023-11-15 16:51:07 -05:00
- [Projects / Kanban boards](./project/)
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
- [Citable Code](https://docs.codeberg.org/collaborating/citable-code/)
refactor: use astro content collections for docs Reviewed-on: https://codeberg.org/forgejo/website/pulls/323 # Conflicts: # v1.19/admin/command-line.md # v1.19/admin/config-cheat-sheet.md # v1.19/admin/database-preparation.md # v1.19/admin/email-setup.md # v1.19/admin/incoming-email.md # v1.19/admin/index.md # v1.19/admin/logging-documentation.md # v1.19/admin/reverse-proxy.md # v1.19/admin/seek-assistance.md # v1.19/admin/upgrade.md # v1.19/developer/code-forgejo-org.md # v1.19/developer/index.md # v1.19/index.md # v1.19/license.md # v1.19/user/agit-support.md # v1.19/user/api-usage.md # v1.19/user/authentication.md # v1.19/user/email-settings.md # v1.19/user/first-repository.md # v1.19/user/index.md # v1.19/user/issue-pull-request-templates.md # v1.19/user/issue-tracking-basics.md # v1.19/user/labels.md # v1.19/user/linked-references.md # v1.19/user/merge-message-templates.md # v1.19/user/oauth2-provider.md # v1.19/user/packages/cargo.md # v1.19/user/packages/chef.md # v1.19/user/packages/composer.md # v1.19/user/packages/conan.md # v1.19/user/packages/conda.md # v1.19/user/packages/container.md # v1.19/user/packages/generic.md # v1.19/user/packages/helm.md # v1.19/user/packages/index.md # v1.19/user/packages/maven.md # v1.19/user/packages/npm.md # v1.19/user/packages/nuget.md # v1.19/user/packages/pub.md # v1.19/user/packages/pypi.md # v1.19/user/packages/rubygems.md # v1.19/user/packages/storage.md # v1.19/user/packages/vagrant.md # v1.19/user/project.md # v1.19/user/protection.md # v1.19/user/push-options.md # v1.19/user/push-to-create.md # v1.19/user/repo-permissions.md # v1.19/user/webhooks.md # v1.19/user/wiki.md # v1.20/user/semver.md
2023-07-26 18:20:30 -04:00
- [Automatically Linked References](./linked-references/)
- [Blocking users](./blocking-user/)
fix "customization" typo
2023-09-09 17:07:29 -04:00
- [Profile customization](./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/)
refactor: use astro content collections for docs Reviewed-on: https://codeberg.org/forgejo/website/pulls/323 # Conflicts: # v1.19/admin/command-line.md # v1.19/admin/config-cheat-sheet.md # v1.19/admin/database-preparation.md # v1.19/admin/email-setup.md # v1.19/admin/incoming-email.md # v1.19/admin/index.md # v1.19/admin/logging-documentation.md # v1.19/admin/reverse-proxy.md # v1.19/admin/seek-assistance.md # v1.19/admin/upgrade.md # v1.19/developer/code-forgejo-org.md # v1.19/developer/index.md # v1.19/index.md # v1.19/license.md # v1.19/user/agit-support.md # v1.19/user/api-usage.md # v1.19/user/authentication.md # v1.19/user/email-settings.md # v1.19/user/first-repository.md # v1.19/user/index.md # v1.19/user/issue-pull-request-templates.md # v1.19/user/issue-tracking-basics.md # v1.19/user/labels.md # v1.19/user/linked-references.md # v1.19/user/merge-message-templates.md # v1.19/user/oauth2-provider.md # v1.19/user/packages/cargo.md # v1.19/user/packages/chef.md # v1.19/user/packages/composer.md # v1.19/user/packages/conan.md # v1.19/user/packages/conda.md # v1.19/user/packages/container.md # v1.19/user/packages/generic.md # v1.19/user/packages/helm.md # v1.19/user/packages/index.md # v1.19/user/packages/maven.md # v1.19/user/packages/npm.md # v1.19/user/packages/nuget.md # v1.19/user/packages/pub.md # v1.19/user/packages/pypi.md # v1.19/user/packages/rubygems.md # v1.19/user/packages/storage.md # v1.19/user/packages/vagrant.md # v1.19/user/project.md # v1.19/user/protection.md # v1.19/user/push-options.md # v1.19/user/push-to-create.md # v1.19/user/repo-permissions.md # v1.19/user/webhooks.md # v1.19/user/wiki.md # v1.20/user/semver.md
2023-07-26 18:20:30 -04:00
- [Branch and tag protection](./protection/)
user: blame: adapt to Forgejo (#146) Caution: it needs to be squashed before merge to be backported. It is kept as two commits to preserve the original version. Reviewed-on: https://codeberg.org/forgejo/docs/pulls/146 Reviewed-by: Loïc Dachary <dachary@noreply.codeberg.org> Co-authored-by: Earl Warren <contact@earl-warren.org> Co-committed-by: Earl Warren <contact@earl-warren.org>
2023-09-22 13:58:24 -04:00
- [Git blame](./blame/)
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
- Advanced Usage
refactor: use astro content collections for docs Reviewed-on: https://codeberg.org/forgejo/website/pulls/323 # Conflicts: # v1.19/admin/command-line.md # v1.19/admin/config-cheat-sheet.md # v1.19/admin/database-preparation.md # v1.19/admin/email-setup.md # v1.19/admin/incoming-email.md # v1.19/admin/index.md # v1.19/admin/logging-documentation.md # v1.19/admin/reverse-proxy.md # v1.19/admin/seek-assistance.md # v1.19/admin/upgrade.md # v1.19/developer/code-forgejo-org.md # v1.19/developer/index.md # v1.19/index.md # v1.19/license.md # v1.19/user/agit-support.md # v1.19/user/api-usage.md # v1.19/user/authentication.md # v1.19/user/email-settings.md # v1.19/user/first-repository.md # v1.19/user/index.md # v1.19/user/issue-pull-request-templates.md # v1.19/user/issue-tracking-basics.md # v1.19/user/labels.md # v1.19/user/linked-references.md # v1.19/user/merge-message-templates.md # v1.19/user/oauth2-provider.md # v1.19/user/packages/cargo.md # v1.19/user/packages/chef.md # v1.19/user/packages/composer.md # v1.19/user/packages/conan.md # v1.19/user/packages/conda.md # v1.19/user/packages/container.md # v1.19/user/packages/generic.md # v1.19/user/packages/helm.md # v1.19/user/packages/index.md # v1.19/user/packages/maven.md # v1.19/user/packages/npm.md # v1.19/user/packages/nuget.md # v1.19/user/packages/pub.md # v1.19/user/packages/pypi.md # v1.19/user/packages/rubygems.md # v1.19/user/packages/storage.md # v1.19/user/packages/vagrant.md # v1.19/user/project.md # v1.19/user/protection.md # v1.19/user/push-options.md # v1.19/user/push-to-create.md # v1.19/user/repo-permissions.md # v1.19/user/webhooks.md # v1.19/user/wiki.md # v1.20/user/semver.md
2023-07-26 18:20:30 -04:00
- [Issue and Pull Request Templates](./issue-pull-request-templates/)
- [Actions](./actions/)
- [Merge Message templates](./merge-message-templates/)
- [Webhooks](./webhooks/)
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
- 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/)
refactor: use astro content collections for docs Reviewed-on: https://codeberg.org/forgejo/website/pulls/323 # Conflicts: # v1.19/admin/command-line.md # v1.19/admin/config-cheat-sheet.md # v1.19/admin/database-preparation.md # v1.19/admin/email-setup.md # v1.19/admin/incoming-email.md # v1.19/admin/index.md # v1.19/admin/logging-documentation.md # v1.19/admin/reverse-proxy.md # v1.19/admin/seek-assistance.md # v1.19/admin/upgrade.md # v1.19/developer/code-forgejo-org.md # v1.19/developer/index.md # v1.19/index.md # v1.19/license.md # v1.19/user/agit-support.md # v1.19/user/api-usage.md # v1.19/user/authentication.md # v1.19/user/email-settings.md # v1.19/user/first-repository.md # v1.19/user/index.md # v1.19/user/issue-pull-request-templates.md # v1.19/user/issue-tracking-basics.md # v1.19/user/labels.md # v1.19/user/linked-references.md # v1.19/user/merge-message-templates.md # v1.19/user/oauth2-provider.md # v1.19/user/packages/cargo.md # v1.19/user/packages/chef.md # v1.19/user/packages/composer.md # v1.19/user/packages/conan.md # v1.19/user/packages/conda.md # v1.19/user/packages/container.md # v1.19/user/packages/generic.md # v1.19/user/packages/helm.md # v1.19/user/packages/index.md # v1.19/user/packages/maven.md # v1.19/user/packages/npm.md # v1.19/user/packages/nuget.md # v1.19/user/packages/pub.md # v1.19/user/packages/pypi.md # v1.19/user/packages/rubygems.md # v1.19/user/packages/storage.md # v1.19/user/packages/vagrant.md # v1.19/user/project.md # v1.19/user/protection.md # v1.19/user/push-options.md # v1.19/user/push-to-create.md # v1.19/user/repo-permissions.md # v1.19/user/webhooks.md # v1.19/user/wiki.md # v1.20/user/semver.md
2023-07-26 18:20:30 -04:00
- [Access Token scope](./token-scope/)
- [LDAP, PAM, FreeIPA](./authentication/)
- [OAuth2, Client Types](./oauth2-provider/)
- [Semantic version](./semver/)
- [API Usage](./api-usage/)
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 Reference](https://codeberg.org/api/swagger)
- [Migrating Repositories](https://docs.codeberg.org/advanced/migrating-repos/)
refactor: use astro content collections for docs Reviewed-on: https://codeberg.org/forgejo/website/pulls/323 # Conflicts: # v1.19/admin/command-line.md # v1.19/admin/config-cheat-sheet.md # v1.19/admin/database-preparation.md # v1.19/admin/email-setup.md # v1.19/admin/incoming-email.md # v1.19/admin/index.md # v1.19/admin/logging-documentation.md # v1.19/admin/reverse-proxy.md # v1.19/admin/seek-assistance.md # v1.19/admin/upgrade.md # v1.19/developer/code-forgejo-org.md # v1.19/developer/index.md # v1.19/index.md # v1.19/license.md # v1.19/user/agit-support.md # v1.19/user/api-usage.md # v1.19/user/authentication.md # v1.19/user/email-settings.md # v1.19/user/first-repository.md # v1.19/user/index.md # v1.19/user/issue-pull-request-templates.md # v1.19/user/issue-tracking-basics.md # v1.19/user/labels.md # v1.19/user/linked-references.md # v1.19/user/merge-message-templates.md # v1.19/user/oauth2-provider.md # v1.19/user/packages/cargo.md # v1.19/user/packages/chef.md # v1.19/user/packages/composer.md # v1.19/user/packages/conan.md # v1.19/user/packages/conda.md # v1.19/user/packages/container.md # v1.19/user/packages/generic.md # v1.19/user/packages/helm.md # v1.19/user/packages/index.md # v1.19/user/packages/maven.md # v1.19/user/packages/npm.md # v1.19/user/packages/nuget.md # v1.19/user/packages/pub.md # v1.19/user/packages/pypi.md # v1.19/user/packages/rubygems.md # v1.19/user/packages/storage.md # v1.19/user/packages/vagrant.md # v1.19/user/project.md # v1.19/user/protection.md # v1.19/user/push-options.md # v1.19/user/push-to-create.md # v1.19/user/repo-permissions.md # v1.19/user/webhooks.md # v1.19/user/wiki.md # v1.20/user/semver.md
2023-07-26 18:20:30 -04:00
- [Push to create](./push-to-create/)
- [Agit setup](./agit-support/)
- [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/)
Copy permalink