From e3445e60d8afdf396b0d8e7f23b7cbfe46e43ab5 Mon Sep 17 00:00:00 2001 From: Lunny Xiao Date: Thu, 6 Apr 2023 10:39:10 +0800 Subject: [PATCH 1/6] improve permission documentation --- docs/content/doc/usage/permissions.en-us.md | 28 +++++++++++++++------ 1 file changed, 20 insertions(+), 8 deletions(-) diff --git a/docs/content/doc/usage/permissions.en-us.md b/docs/content/doc/usage/permissions.en-us.md index 013dbfabd4570..6cbd14b0723b6 100644 --- a/docs/content/doc/usage/permissions.en-us.md +++ b/docs/content/doc/usage/permissions.en-us.md @@ -23,7 +23,7 @@ Gitea supports permissions for repository so that you can give different access ## Unit -In Gitea, we call a sub module of a repository `Unit`. Now we have following units. +In Gitea, we call a sub module of a repository `Unit`. Now we have following possible units. | Name | Description | Permissions | | --------------- | ---------------------------------------------------- | ----------- | @@ -35,6 +35,8 @@ In Gitea, we call a sub module of a repository `Unit`. Now we have following uni | ExternalWiki | Link to an external wiki | Read | | ExternalTracker | Link to an external issue tracker | Read | | Projects | The URL to the template repository | Read Write | +| Packages | Packages which linked to this repository | Read Write | +| Actions | Review actions logs or restart/cacnel pipelines | Read Write | | Settings | Manage the repository | Admin | With different permissions, people could do different things with these units. @@ -49,6 +51,8 @@ With different permissions, people could do different things with these units. | ExternalWiki | Link to an external wiki | - | - | | ExternalTracker | Link to an external issue tracker | - | - | | Projects | View the boards | Change issues across boards | - | +| Packages | View the packages | Upload/Delete packages | - | +| Actions | View the Actions logs | Approve / Cacnel / Restart | - | | Settings | - | - | Manage the repository | And there are some differences for permissions between individual repositories and organization repositories. @@ -58,16 +62,24 @@ And there are some differences for permissions between individual repositories a For individual repositories, the creators are the only owners of repositories and have no limit to change anything of this repository or delete it. Repositories owners could add collaborators to help maintain the repositories. Collaborators could have `Read`, `Write` and `Admin` permissions. +For a private repository, it's the same as anonymous visit a public repository. You can read all possible units of this repository. You can clone the code, post issues, reply issue comments, send a pull request and etc. With `Write` permission, you can push code to some branches of this repository if it's allowed by the branch protection rules. You can also change the wiki pages. With `Admin` permission, you can change the repository's settings. +But you cannot delete or transfer this repository if you are not that repository's owner. + ## Organization Repository Different from individual repositories, the owner of organization repositories are the owner team of this organization. -### Team +### Owner Team + +The owner team will be created when the organization is created, and the creator will become the first member of the owner team. The owner team cannot be deleted and only members of the owner team can create a new team. + +### Other Teams + +Every member of an organization must be in at least one team. + +A team in an organization has unit permissions settings. It can have members and repositories scope. -A team in an organization has unit permissions settings. It can have members and repositories scope. A team could access all the repositories in this organization or special repositories changed by the owner team. A team could also be allowed to create new -repositories. +- A team could access all the repositories in this organization or special repositories. +- A team could also be allowed to create new repositories. -The owner team will be created when the organization is created, and the creator will become the first member of the owner team. -Every member of an organization must be in at least one team. The owner team cannot be deleted and only -members of the owner team can create a new team. An admin team can be created to manage some of the repositories, whose members can do anything with these repositories. -The Generate team can be created by the owner team to do the operations allowed by their permissions. +When creating teams, there are two types teams. One is admin team, another is general team. An admin team can be created to manage some of the repositories, whose members can do anything with these repositories. The Generate team can be created to do the operations allowed by their permissions. From faa68842eb84b6cd19a44f9cdea3dd77f1732f2d Mon Sep 17 00:00:00 2001 From: Lunny Xiao Date: Thu, 6 Apr 2023 10:51:54 +0800 Subject: [PATCH 2/6] Update docs/content/doc/usage/permissions.en-us.md Co-authored-by: yp05327 <576951401@qq.com> --- docs/content/doc/usage/permissions.en-us.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/doc/usage/permissions.en-us.md b/docs/content/doc/usage/permissions.en-us.md index 6cbd14b0723b6..1ba9db6e423ad 100644 --- a/docs/content/doc/usage/permissions.en-us.md +++ b/docs/content/doc/usage/permissions.en-us.md @@ -52,7 +52,7 @@ With different permissions, people could do different things with these units. | ExternalTracker | Link to an external issue tracker | - | - | | Projects | View the boards | Change issues across boards | - | | Packages | View the packages | Upload/Delete packages | - | -| Actions | View the Actions logs | Approve / Cacnel / Restart | - | +| Actions | View the Actions logs | Approve / Cancel / Restart | - | | Settings | - | - | Manage the repository | And there are some differences for permissions between individual repositories and organization repositories. From 40191c7252b2b55018257bc8f56ca1f04eca23e3 Mon Sep 17 00:00:00 2001 From: Lunny Xiao Date: Thu, 6 Apr 2023 13:57:18 +0800 Subject: [PATCH 3/6] Update doc --- docs/content/doc/usage/permissions.en-us.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/docs/content/doc/usage/permissions.en-us.md b/docs/content/doc/usage/permissions.en-us.md index 6cbd14b0723b6..617d060b995d2 100644 --- a/docs/content/doc/usage/permissions.en-us.md +++ b/docs/content/doc/usage/permissions.en-us.md @@ -71,15 +71,17 @@ Different from individual repositories, the owner of organization repositories a ### Owner Team -The owner team will be created when the organization is created, and the creator will become the first member of the owner team. The owner team cannot be deleted and only members of the owner team can create a new team. +The owner team will be created when the organization is created, and the creator will become the first member of the owner team. The owner team cannot be deleted and there is at least one member on owner team. Every member of an organization must be in at least one team. -### Other Teams +### Admin Team -Every member of an organization must be in at least one team. +When creating teams, there are two types teams. One is admin team, another is general team. An admin team can be created to manage some of the repositories, whose members can do anything with these repositories. Only members of the owner or admin team can create a new team. -A team in an organization has unit permissions settings. It can have members and repositories scope. +### General Team + +A general team in an organization has unit permissions settings. It can have members and repositories scope. - A team could access all the repositories in this organization or special repositories. -- A team could also be allowed to create new repositories. +- A team could also be allowed to create new repositories or not. -When creating teams, there are two types teams. One is admin team, another is general team. An admin team can be created to manage some of the repositories, whose members can do anything with these repositories. The Generate team can be created to do the operations allowed by their permissions. +The General team can be created to do the operations allowed by their permissions. One member could join multiple teams. From dbab3c283ccac4c8de4d5ce0060ba45747be6478 Mon Sep 17 00:00:00 2001 From: Lunny Xiao Date: Thu, 6 Apr 2023 19:58:19 +0800 Subject: [PATCH 4/6] Apply suggestions from code review Co-authored-by: KN4CK3R --- docs/content/doc/usage/permissions.en-us.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/content/doc/usage/permissions.en-us.md b/docs/content/doc/usage/permissions.en-us.md index 398003faaa313..65729d8f68051 100644 --- a/docs/content/doc/usage/permissions.en-us.md +++ b/docs/content/doc/usage/permissions.en-us.md @@ -71,11 +71,11 @@ Different from individual repositories, the owner of organization repositories a ### Owner Team -The owner team will be created when the organization is created, and the creator will become the first member of the owner team. The owner team cannot be deleted and there is at least one member on owner team. Every member of an organization must be in at least one team. +The owner team will be created when the organization is created, and the creator will become the first member of the owner team. The owner team cannot be deleted and there is at least one member. ### Admin Team -When creating teams, there are two types teams. One is admin team, another is general team. An admin team can be created to manage some of the repositories, whose members can do anything with these repositories. Only members of the owner or admin team can create a new team. +When creating teams, there are two types of teams. One is the admin team, another is the general team. An admin team can be created to manage some of the repositories, whose members can do anything with these repositories. Only members of the owner or admin team can create a new team. ### General Team From 810b8bff593bf872b7f502b3f07288d721d33b4e Mon Sep 17 00:00:00 2001 From: Lunny Xiao Date: Mon, 5 Jun 2023 09:05:30 +0800 Subject: [PATCH 5/6] Update the sentences --- docs/content/doc/usage/permissions.en-us.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/content/doc/usage/permissions.en-us.md b/docs/content/doc/usage/permissions.en-us.md index 398003faaa313..9880073a07758 100644 --- a/docs/content/doc/usage/permissions.en-us.md +++ b/docs/content/doc/usage/permissions.en-us.md @@ -62,7 +62,8 @@ And there are some differences for permissions between individual repositories a For individual repositories, the creators are the only owners of repositories and have no limit to change anything of this repository or delete it. Repositories owners could add collaborators to help maintain the repositories. Collaborators could have `Read`, `Write` and `Admin` permissions. -For a private repository, it's the same as anonymous visit a public repository. You can read all possible units of this repository. You can clone the code, post issues, reply issue comments, send a pull request and etc. With `Write` permission, you can push code to some branches of this repository if it's allowed by the branch protection rules. You can also change the wiki pages. With `Admin` permission, you can change the repository's settings. +For a private repository, the experience is similar to visiting an anonymous public repository. You have access to all the available content within the repository, including the ability to clone the code, create issues, respond to issue comments, submit pull requests, and more. If you have 'Write' permission, you can push code to specific branches of the repository, provided it's permitted by the branch protection rules. Additionally, you can make changes to the wiki pages. With 'Admin' permission, you have the ability to modify the repository's settings. + But you cannot delete or transfer this repository if you are not that repository's owner. ## Organization Repository From e681058e36ba4aff6533cb7698db664f3b1b57f8 Mon Sep 17 00:00:00 2001 From: Lunny Xiao Date: Mon, 5 Jun 2023 09:09:15 +0800 Subject: [PATCH 6/6] Update the permission doc --- docs/content/doc/usage/permissions.en-us.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/doc/usage/permissions.en-us.md b/docs/content/doc/usage/permissions.en-us.md index 89b2b820b52c6..655c67de86c1e 100644 --- a/docs/content/doc/usage/permissions.en-us.md +++ b/docs/content/doc/usage/permissions.en-us.md @@ -70,7 +70,7 @@ But you cannot delete or transfer this repository if you are not that repository ## Organization Repository -Different from individual repositories, the owner of organization repositories are the owner team of this organization. +For individual repositories, the owner is the user who created it. For organization repositories, the owners are the members of the owner team on this organization. All the permissions depends on the team permission settings. ### Owner Team