diff --git a/assets/images/collaborating/create-organization/Create-orga.PNG b/assets/images/collaborating/create-organization/Create-orga.PNG new file mode 100644 index 0000000..1b34e36 Binary files /dev/null and b/assets/images/collaborating/create-organization/Create-orga.PNG differ diff --git a/assets/images/collaborating/create-organization/NewOrga.PNG b/assets/images/collaborating/create-organization/NewOrga.PNG new file mode 100644 index 0000000..ae75649 Binary files /dev/null and b/assets/images/collaborating/create-organization/NewOrga.PNG differ diff --git a/assets/images/collaborating/create-organization/Orga.PNG b/assets/images/collaborating/create-organization/Orga.PNG new file mode 100644 index 0000000..b53db82 Binary files /dev/null and b/assets/images/collaborating/create-organization/Orga.PNG differ diff --git a/assets/images/collaborating/create-organization/ViewOrga.PNG b/assets/images/collaborating/create-organization/ViewOrga.PNG new file mode 100644 index 0000000..d774ca4 Binary files /dev/null and b/assets/images/collaborating/create-organization/ViewOrga.PNG differ diff --git a/assets/images/collaborating/create-organization/new-team.png b/assets/images/collaborating/create-organization/new-team.png new file mode 100644 index 0000000..40960cd Binary files /dev/null and b/assets/images/collaborating/create-organization/new-team.png differ diff --git a/assets/images/collaborating/create-organization/orga-settings.png b/assets/images/collaborating/create-organization/orga-settings.png new file mode 100644 index 0000000..0bc0c1f Binary files /dev/null and b/assets/images/collaborating/create-organization/orga-settings.png differ diff --git a/assets/images/collaborating/create-organization/people.PNG b/assets/images/collaborating/create-organization/people.PNG new file mode 100644 index 0000000..d166e16 Binary files /dev/null and b/assets/images/collaborating/create-organization/people.PNG differ diff --git a/assets/images/collaborating/create-organization/switch-context.PNG b/assets/images/collaborating/create-organization/switch-context.PNG new file mode 100644 index 0000000..f626571 Binary files /dev/null and b/assets/images/collaborating/create-organization/switch-context.PNG differ diff --git a/assets/images/collaborating/create-organization/team-settings.PNG b/assets/images/collaborating/create-organization/team-settings.PNG new file mode 100644 index 0000000..76b0443 Binary files /dev/null and b/assets/images/collaborating/create-organization/team-settings.PNG differ diff --git a/assets/images/collaborating/create-organization/teams.PNG b/assets/images/collaborating/create-organization/teams.PNG new file mode 100644 index 0000000..ebe3917 Binary files /dev/null and b/assets/images/collaborating/create-organization/teams.PNG differ diff --git a/assets/images/collaborating/invite-collaborators/add-collaborator.PNG b/assets/images/collaborating/invite-collaborators/add-collaborator.PNG new file mode 100644 index 0000000..e99afcd Binary files /dev/null and b/assets/images/collaborating/invite-collaborators/add-collaborator.PNG differ diff --git a/assets/images/collaborating/invite-collaborators/collaborator-rights.PNG b/assets/images/collaborating/invite-collaborators/collaborator-rights.PNG new file mode 100644 index 0000000..14cd774 Binary files /dev/null and b/assets/images/collaborating/invite-collaborators/collaborator-rights.PNG differ diff --git a/assets/images/collaborating/invite-collaborators/settings.PNG b/assets/images/collaborating/invite-collaborators/settings.PNG new file mode 100644 index 0000000..8a89cc4 Binary files /dev/null and b/assets/images/collaborating/invite-collaborators/settings.PNG differ diff --git a/content/collaborating/create-organization.md b/content/collaborating/create-organization.md new file mode 100644 index 0000000..3f6bb83 --- /dev/null +++ b/content/collaborating/create-organization.md @@ -0,0 +1,65 @@ +--- +eleventyNavigation: + key: CreateOrganization + title: Create and Manage an Organization + parent: Collaborating + order: 40 +--- + +## 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. + +## 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) + +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`: + +![create-orga](/assets/images/collaborating/create-organization/Create-orga.PNG) + +You are then directed to the organization's dashboard. + +## Switch between your account and the organization +On the dashboard, click on the avatar at the left and select the context you want to work with: + +![switch-context](/assets/images/collaborating/create-organization/switch-context.PNG) + +## View organization +The organization's dashboard gives you an overview of the organization: + +![view-orga](/assets/images/collaborating/create-organization/ViewOrga.PNG) + +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) + +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. + +## Edit organization +The cog 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: + +![settings](/assets/images/collaborating/create-organization/orga-settings.png) + +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) + +Click the green `+ New Team` to create a new team. Define the name, permissions and access in the new form: + +![new-team](/assets/images/collaborating/create-organization/new-team.png) + +To edit a team, go to the `Teams` tab and click on the team you want to edit: + +![new-team](/assets/images/collaborating/create-organization/team-settings.png) + +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 \ No newline at end of file diff --git a/content/collaborating/index.md b/content/collaborating/index.md index 4d9a104..4ff7340 100644 --- a/content/collaborating/index.md +++ b/content/collaborating/index.md @@ -3,7 +3,7 @@ eleventyNavigation: key: Collaborating title: Collaborating with Others icon: user-friends - order: 30 + order: 10 --- These documentation pages contain detailed information on how you can collaborate diff --git a/content/collaborating/invite-collaborators.md b/content/collaborating/invite-collaborators.md new file mode 100644 index 0000000..1f9c217 --- /dev/null +++ b/content/collaborating/invite-collaborators.md @@ -0,0 +1,26 @@ +--- +eleventyNavigation: + key: InviteCollaborators + title: Invite Collaborators + parent: Collaborating + order: 30 +--- + +## 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*. + +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)). + +## 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) + +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) + +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) diff --git a/content/collaborating/pull-requests-and-git-flow.md b/content/collaborating/pull-requests-and-git-flow.md index 754fa17..5813345 100644 --- a/content/collaborating/pull-requests-and-git-flow.md +++ b/content/collaborating/pull-requests-and-git-flow.md @@ -3,6 +3,7 @@ eleventyNavigation: key: PullRequestsGitFlow title: Pull requests and Git flow parent: Collaborating + order: 20 --- ## Benefits of a pull-request based workflow