diff --git a/assets/images/collaborating/create-organization/Dashboard.PNG b/assets/images/collaborating/create-organization/Dashboard.PNG index 3f7544e..e893edc 100644 Binary files a/assets/images/collaborating/create-organization/Dashboard.PNG and b/assets/images/collaborating/create-organization/Dashboard.PNG differ diff --git a/assets/images/collaborating/create-organization/cog.png b/assets/images/collaborating/create-organization/cog.png new file mode 100644 index 0000000..5bd0ca5 Binary files /dev/null and b/assets/images/collaborating/create-organization/cog.png differ diff --git a/assets/images/collaborating/create-organization/cog.webp b/assets/images/collaborating/create-organization/cog.webp new file mode 100644 index 0000000..4232ca1 Binary files /dev/null and b/assets/images/collaborating/create-organization/cog.webp differ diff --git a/assets/images/collaborating/create-organization/create-orga.webp b/assets/images/collaborating/create-organization/create-orga.webp new file mode 100644 index 0000000..987cb02 Binary files /dev/null and b/assets/images/collaborating/create-organization/create-orga.webp differ diff --git a/assets/images/collaborating/create-organization/dashboard.webp b/assets/images/collaborating/create-organization/dashboard.webp new file mode 100644 index 0000000..9466b83 Binary files /dev/null and b/assets/images/collaborating/create-organization/dashboard.webp differ diff --git a/assets/images/collaborating/create-organization/NewOrga.PNG b/assets/images/collaborating/create-organization/new-orga.png similarity index 58% rename from assets/images/collaborating/create-organization/NewOrga.PNG rename to assets/images/collaborating/create-organization/new-orga.png index ae75649..7dd60e9 100644 Binary files a/assets/images/collaborating/create-organization/NewOrga.PNG and b/assets/images/collaborating/create-organization/new-orga.png differ diff --git a/assets/images/collaborating/create-organization/new-orga.webp b/assets/images/collaborating/create-organization/new-orga.webp new file mode 100644 index 0000000..7d640c5 Binary files /dev/null and b/assets/images/collaborating/create-organization/new-orga.webp differ diff --git a/assets/images/collaborating/create-organization/new-team.webp b/assets/images/collaborating/create-organization/new-team.webp new file mode 100644 index 0000000..9861508 Binary files /dev/null and b/assets/images/collaborating/create-organization/new-team.webp differ diff --git a/assets/images/collaborating/create-organization/orga-settings.webp b/assets/images/collaborating/create-organization/orga-settings.webp new file mode 100644 index 0000000..970594c Binary files /dev/null and b/assets/images/collaborating/create-organization/orga-settings.webp differ diff --git a/assets/images/collaborating/create-organization/orga.webp b/assets/images/collaborating/create-organization/orga.webp new file mode 100644 index 0000000..26b5368 Binary files /dev/null and b/assets/images/collaborating/create-organization/orga.webp differ diff --git a/assets/images/collaborating/create-organization/people.PNG b/assets/images/collaborating/create-organization/people.PNG index 76e50e8..9a21b94 100644 Binary files a/assets/images/collaborating/create-organization/people.PNG and b/assets/images/collaborating/create-organization/people.PNG differ diff --git a/assets/images/collaborating/create-organization/people.webp b/assets/images/collaborating/create-organization/people.webp new file mode 100644 index 0000000..ff3782a Binary files /dev/null and b/assets/images/collaborating/create-organization/people.webp differ diff --git a/assets/images/collaborating/create-organization/profile.png b/assets/images/collaborating/create-organization/profile.png new file mode 100644 index 0000000..7b8e324 Binary files /dev/null and b/assets/images/collaborating/create-organization/profile.png differ diff --git a/assets/images/collaborating/create-organization/profile.webp b/assets/images/collaborating/create-organization/profile.webp new file mode 100644 index 0000000..aa0192a Binary files /dev/null and b/assets/images/collaborating/create-organization/profile.webp differ diff --git a/assets/images/collaborating/create-organization/team-settings.PNG b/assets/images/collaborating/create-organization/team-settings.PNG index 76b0443..1046986 100644 Binary files a/assets/images/collaborating/create-organization/team-settings.PNG and b/assets/images/collaborating/create-organization/team-settings.PNG differ diff --git a/assets/images/collaborating/create-organization/team-settings.webp b/assets/images/collaborating/create-organization/team-settings.webp new file mode 100644 index 0000000..f914b12 Binary files /dev/null and b/assets/images/collaborating/create-organization/team-settings.webp differ diff --git a/assets/images/collaborating/create-organization/teams.PNG b/assets/images/collaborating/create-organization/teams.PNG index ebe3917..6b2a625 100644 Binary files a/assets/images/collaborating/create-organization/teams.PNG and b/assets/images/collaborating/create-organization/teams.PNG differ diff --git a/assets/images/collaborating/create-organization/teams.webp b/assets/images/collaborating/create-organization/teams.webp new file mode 100644 index 0000000..31ec1dc Binary files /dev/null and b/assets/images/collaborating/create-organization/teams.webp differ diff --git a/assets/images/collaborating/create-organization/ViewOrga.PNG b/assets/images/collaborating/create-organization/view-orga.png similarity index 100% rename from assets/images/collaborating/create-organization/ViewOrga.PNG rename to assets/images/collaborating/create-organization/view-orga.png diff --git a/assets/images/collaborating/create-organization/view-orga.webp b/assets/images/collaborating/create-organization/view-orga.webp new file mode 100644 index 0000000..9124e42 Binary files /dev/null and b/assets/images/collaborating/create-organization/view-orga.webp differ diff --git a/content/collaborating/create-organization.md b/content/collaborating/create-organization.md index 5870ebd..40aea30 100644 --- a/content/collaborating/create-organization.md +++ b/content/collaborating/create-organization.md @@ -7,68 +7,131 @@ eleventyNavigation: --- ## What is an organization? -An organization is a group of users that have access to a shared account. As such, they can all access the different projects (repositories) of the organization. -An organization can be composed of several teams, each possibly having a defined role in the project's development. Owners and administrators can define the access rights of each team. +An organization is a group of users that have access to a shared account. As such, they can all access the different projects (repositories) of the organization. An organization can be composed of several teams, each having a defined role in the project's development and also different access rights. This makes organzations an easy and powerful tool to collaborate on a project. +Everyone can create organizations on Codeberg for free. The following sections will show you how to create and manage an organization. + +> Details about the roles involved (owner, admin, member...) are given in the sections [Teams](#teams) and [People](#people) below. + + ## Create an Organization On your Dashboard, click on the `+` next to your avatar and select `New Organization`: -![new-orga](/assets/images/collaborating/create-organization/NewOrga.PNG) + + + new-orga + -In the new form, choose a name for your organization (here "PolarClub"), define its visibility and choose what the administrators of repositories can do. Validate by clicking the green `Create Organization`: +In the new form, choose a name for your organization (here `PolarClub`) and define its visibility. Finally, choose what the administrators of repositories can do: if the box is ticked, repository administrators will be able to grant any team access to the repository (see [Teams](#teams) below for details on repository administrators). -![create-orga](/assets/images/collaborating/create-organization/Create-orga.PNG) +Confirm by clicking the green `Create Organization`: + + + + create-orga + You are then directed to the organization's dashboard. ## Switch between your personal account and the organization On the dashboard, click on the avatar on the left and select the context (personal account or organization) you want to work with. Alternatively, access your repositories or your organization from the tabs on the right side. -![dashboard](/assets/images/collaborating/create-organization/Dashboard.png) + + + dashboard + ## View organization The organization's dashboard gives you an overview of the organization: -![view-orga](/assets/images/collaborating/create-organization/ViewOrga.PNG) + + + view-orga + If you click on the `View [name of organization]` (here `PolarClub`), you will be directed to the organization's page: -![orga](/assets/images/collaborating/create-organization/Orga.PNG) + + + orga + -From there, you can access all repositories (there is none in this example) and create a new one. There is a list of all the members (`People`) and teams; in this example, there is only 1 member (Knut the polar bear), and 1 team (`Owners`) with 1 member and no repository. +From there, you can access all repositories (there is none in this example) and create a new one. There is a list of all the members (`People`) and teams; in this example, there is only one member (Knut the polar bear), and one team (`Owners`) with one member (yourself) and no repository. ## Edit organization -The cog next to the organization's name will lead you to the organization's settings, where you can change the organization's name; add a full name, a description, a link to a website and a location; change the visibility and persmissions; and add/change the avatar: +The cog next to the organization's name will lead you to the organization's settings: -![settings](/assets/images/collaborating/create-organization/orga-settings.png) + + + cog + + +This is where you can change general settings related to your organization, such as its name, avatar, website or visibility. It is also where you can delete your organization, and access more advanced settings like organization webhooks: + + + + orga-settings + + +The `Name` of the organization is the name that will define the URLs of the organization and of all its repositories; it is recommended to keep it short. This name will also appear on the member's profiles (see [People](#people)). On the other hand, the `Full Name` is the name that will appear on the organization's home page. In the `Labels` tab, you can create labels that will be used across all repositories of this organization. This will help with issues and pull requests. The default label set is a good starting point. In the top right corner, you have access to the people (members) and teams of your organization. These can also be accessed from the organization's page. + ## Teams The `Teams` tab gives you an overview of the different teams, of their members and of their number of repositories. You can also join a team from there if you have the permission to do so: -![teams](/assets/images/collaborating/create-organization/teams.PNG) + + + teams + -Click the green `+ New Team` to create a new team. Define the name, permissions and access in the new form: +When you create an organization, a team `Owners` is created and you are automatically added to this team. Members of the Owners' team have all rights: they can edit (including delete) the organization, add or remove teams and members, define the access rights of each team, and they have full administrator rights to all repositories of the organization. -![new-team](/assets/images/collaborating/create-organization/new-team.png) +Click the green `+ New Team` to create a new team. Define its name, permissions and access in the new form: -To edit a team, go to the `Teams` tab and click on the team you want to edit: + + + new-team + -![team-settings](/assets/images/collaborating/create-organization/team-settings.png) +You can choose whether members of the team can only access some repositories explicitly added to the team, or whether they can access all repositories of the organziation. +You can also allow members to be able to create new repositories for the organization. In this case, the member who creates the repository will be granted administrator rights for this repository, that is, editing all settings of the repository except those in the `Danger Zone` (transfer ownership, delete wiki data and repository, and archive repository). The member will then be added as a collaborator to the repository with administrator rights (see [Invite Collaborators](/collaborating/invite-collaborators) for details). +If you have allowed repository administrators to grant or remove access for teams (see [Create an Organization](#create-orga) above), they can do so in `Settings > Collaborators` tab of the repository. + +If you choose either `Read` or `Write` access, you can additionally define which sections of the repositories the members will have (read or write) access to. On the other hand, `Administrator` access automatically grants read and write access to all sections; this part of the form is therefore hidden in this case. Administrator rights are also required to add or remove collaborators and teams to the repositories. + +If you belong to the team `Owners`, you can edit a team. For this, go to the `Teams` tab and click on the team you want to edit: + + + + team-settings + Click on `Settings` to edit the team as shown above for the creation of a team. This is also where you can add or remove members to a team, and assign repositories to a team. + ## People +On the `People` tab, you can get an overview of all the people who belong to your organization: + + + + people + + Somewhat counter-intuitively, this is not where you can add members; this is done in the `Teams` tab (see [Teams](#teams) above). But you can remove members from the `People` tab. -![people](/assets/images/collaborating/create-organization/People.PNG) +The visibility of the members can also be edited here: `Hidden` means that the memberships of the members will not be shown on their profiles, while `Visible` makes the avatar of the organization appear in the info card on their profile, as shown in the screenshot below. Note that your membership will always be visible to you on your profile; this visibility setting is for other users only. -The visibility of the members can also be edited here: `Hidden` means that the membership of the member will not be shown on his/her profile, while `Visible` means that the membership will be shown on the profile. Note that your membership will always be visible to you on your profile; this visibility setting is for other users only. + + + profile + -The role of each member is shown here, as well as whether they have activated the two-factor authentification (`2FA`, see [Setting up Two-factor Authentication](/contentsecurity/2fa)). +Members can have one of two roles: `Member` or `Owner`. +It is also shown here whether each member has activated the two-factor authentification (`2FA`, see [Setting up Two-factor Authentication](/security/2fa)). -You can also choose to leave the organization from here. +Finally, you can choose to leave the organization from here. diff --git a/content/collaborating/invite-collaborators.md b/content/collaborating/invite-collaborators.md index 1f9c217..cb68e68 100644 --- a/content/collaborating/invite-collaborators.md +++ b/content/collaborating/invite-collaborators.md @@ -7,20 +7,20 @@ eleventyNavigation: --- ## Why invite collaborators? -If your project repository is public (see [Your first Repository](/content/getting-started/first-repository) on how to set up the visibility of a repository), everyone can see your repository and every Codeberg user can contribute through issues and pull requests. But this is not collaborating since you will be have to fix the issues and deal with the pull requests on your own. -On the other hand, if your repository is private, only you, your collaborators and the members of your organization (depending on their rights, see [Create and Manage an Organization](/content/collaborating/organizations)) can access your repository. In other words, if you want Codeberg users outside of your organization to be able to work with you on your project, you have to grant them access to your repository by adding them as *collaborators*. +If your project repository is public (see [Your first Repository](/getting-started/first-repository) on how to set up the visibility of a repository), everyone can see your repository and every Codeberg user can contribute through issues and pull requests. But this is not collaborating since you will be have to fix the issues and deal with the pull requests on your own. +On the other hand, if your repository is private, only you, your collaborators and the members of your organization (depending on their rights, see [Create and Manage an Organization](/collaborating/create-organization)) can access your repository. In other words, if you want Codeberg users outside of your organization to be able to work with you on your project, you have to grant them access to your repository by adding them as *collaborators*. -It is important to understand that only registered Codeberg users can contribute. If you want a colleague or friend to work with you, you first have to make sure he/she has a Codeberg account (see [Your First Steps on Codeberg](/content/getting-started/first-steps)). +It is important to understand that only registered Codeberg users can contribute. If you want a colleague or friend to work with you, you first have to make sure he/she has a Codeberg account (see [Your First Steps on Codeberg](/getting-started/first-steps)). ## Add a collaborator To add a user to a repository as a collaborator, first go to the settings of your repository. -![settings](/assets/images/collaborating/invite-collaborators/settings.PNG) +![settings](/assets/images/collaborating/invite-collaborators/settings.png) Then navigate to the `Collaborators` tab and search for the user you want to add, and click on `Add Collaborator`. -![add-collaborator](/assets/images/collaborating/invite-collaborators/add-collaborator.PNG) +![add-collaborator](/assets/images/collaborating/invite-collaborators/add-collaborator.png) Once added, you can define the access rights by clicking on the shield: `Read` (can see but not edit), `Write` (can see and edit) or `Administrator` (can do everything!). This is also where you can remove collaborators. -![collaborator-rights](/assets/images/collaborating/invite-collaborators/collaborator-rights.PNG) +![collaborator-rights](/assets/images/collaborating/invite-collaborators/collaborator-rights.png)