Add user-oriented SCM-Manager documentation

docs/en/user/admin/index.md

@@ -0,0 +1,14 @@
+---
+title: Administration
+partiallyActive: true
+---
+The SCM-Manager instance can be administered in the Administration area. From here, plugins can be managed, permission roles can be defined and adjusted, and settings can be made.
+
+* [Plugins](plugins/)
+* [Permission Roles](roles/)
+* [Settings](settings/)
+
+### Information
+On the information page in the administration area you can find the version of your SCM-Manager instance and helpful links to get in touch with the SCM-Manager support team.
+
+![Administration-Information](assets/administration-information.png)

docs/en/user/admin/plugins.md

@@ -0,0 +1,19 @@
+---
+title: Administration
+subtitle: Plugins
+---
+In the plugins section, plugins for SCM-Manager can be managed with the help of the external plugin center. Plugins are distinguished between installed and available plugins and are grouped based on their main functionality like for example workflow or authentication.
+
+Plugins can be managed by functionality icons on the tiles. System relevant plugins that come with SCM-Manager by default cannot be deinstalled or updated.
+
+In order for changes to plugins to become effective, the SCM-Manager server needs to be restarted. That can be done after every single action. It is also possible to queue several actions like the installation of a new plugin, updates or the deletion of a plugin and to perform all actions with one restart. If an action (installation, deinstallation, update) for a plugin was performed, the buttons "Execute changes" and "Abort changes"  appear. If you choose to execute  the changes, a popup window that shows the current queue (all actions without a restart) appears. Now the user can decide whether to execute the changes by restarting the server. If there are actions in the queue that are no longer desired, the queue can be emptied with the about changes  button.
+
+### Installed
+The overview for installed plugins shows all plugins that are currently installed on the SCM-Manager instance. Plugins that are optional can be deinstalled or updated here.
+
+![Administration-Plugins-Installed](assets/administration-plugins-installed.png)
+
+### Available
+The overview of all available plugins shows all plugins that are compatible with the current version of the SCM-Manager instance that are available through the SCM-plugin-center. The plugins can be downloaded by clicking on the icon and will be installed after a restart of the SCM-Manager server.
+
+![Administration-Plugins-Available](assets/administration-plugins-available.png)

docs/en/user/admin/roles.md

@@ -0,0 +1,11 @@
+---
+title: Administration
+subtitle: Permission Roles
+---
+The page "Permission Roles" can be used to create profiles with certain permissions. Each role gets a name and a set of permissions. Roles can be assigned to users and groups for repositories.
+
+There are a few predefined system roles which cannot be changed or deleted.
+
+By clicking on a role you can see the information about it and which permissions the role has. User-defined roles can be edited or deleted at any time.
+
+![Administration-PermissionRoles](assets/administration-permissionRoles.png)

docs/en/user/admin/settings.md

@@ -0,0 +1,59 @@
+---
+title: Administration
+subtitle: Settings
+displayToc: true
+---
+The settings area is where the global configuration of SCM-Manager happens. Many SCM-Manager plugins that need some kind of configuration get an area in the settings. This makes it maximally configurable if required.
+
+### General
+#### Realm Description
+The field "Realm Description" is used to set the authentication realm for logins with basic authentication.
+
+#### Namespace Strategy
+SCM-Manager groups repositories by namespaces. This grouping can be based on different strategies:
+
+* Username: The username of the user that creates the repository is used. 
+* Current year: The current year is used.
+* Repository type: The type (Git, HG, SVN) is used.
+* Custom: The namespace can be freely set when creating the repository.
+
+#### Login Info URL
+The login screen of SCM-Manager shows helpful plugins and features. If you want to show your own information in the login screen, you can change the URL here.
+
+#### Enable XSRF Protection
+Activate this option to make attacks using cross site scripting (XSS / XSRF) on SCM-Manager more difficult. This feature is still in an experimental state.
+
+#### Plugin Center URL
+A plugin center can be used to conveniently manage plugins. If you want to use a plugin center that is not the default one, you only have to change this URL. If SCM-Manager is operated as part of a Cloudogu EcoSystem, the plugin center URL can be changed in the etcd.
+
+#### Enable Anonymous Access
+In SCM-Manager 2 the access for anonymous access is realized by using an "_anonymous" user. When the feature is activated, a new user with the name "_anonymous" is created. This user can be authorized just like any other user. This user is used for access to SCM-Manager without login credentials (this does not apply to access via web UI).
+
+Example: If anonymous access is enabled and the "_anonymous" user has full access on a certain Git repository, everybody can access this repository via command line and the classic Git commands without any login credentials. Access via SSH is not supported at this time.
+
+#### Login Attempt Limit
+It can be configured how many failed login attempts a user can have before the account gets disabled. The counter for failed login attempts is reset after a successful login. This feature can be deactivated by setting the value "-1".
+
+#### Login Attempt Limit Timeout
+If the deactivation of accounts after too many unsuccessful login attempts is activated. This timeout can be used to set for how long accounts will be disabled.
+
+#### Base URL
+The base URL represents the URL that a SCM-Manager instance is available at. The checkbox "Force Base URL" can be used to force redirects to the base URL. If activated, access to this application through different URLs are redirected to the base URL.
+
+Example: The base URL is www.scm.manager.com/scm but there is a second URL www.scm-manager.io/scm. Both URLs point to the same SCM-Manager instance. If the redirect to the base URL is forced, access via www.scm-manager.io/scm is redirected directly to www.scm-manager.com/scm.
+
+**Warning:** If the base URL is set to a faulty value and "Force Base URL" is activated, the SCM-Manager instance is no longer accessible. 
+
+#### Proxy Settings
+If the SCM-Manager instance is behind a proxy server, the connection can be configured here.
+
+![Administration-Configuration](assets/administration-settings-general.png)
+
+### Mercurial
+The global settings for the source code management tool "Mercurial", hg for short, can be configured here.
+
+### Git
+The global settings for the source code management tool "Git", can be configured here.
+
+### Subversion
+The global settings for the source code management tool "Subversion", svn for short, can be configured here.

docs/en/user/group/external.md

@@ -0,0 +1,9 @@
+---
+title: Groups
+subtitle: External groups (CAS)
+---
+Users who log on to SCM-Manager via a CAS (Central Authentication Service) instance receive additional groups from the CAS. External groups can be used without manual creation in SCM-Manager. However, adding the groups marked as "external" has the advantages that the groups created are taken into account in the auto-completion and authorizations can be assigned directly to an external group. Which external groups are assigned to a user can be read out on the profile page of a registered user.
+
+See example: CasGroup
+
+![External-CAS-Group](assets/external-cas-group.png)

docs/en/user/group/index.md

@@ -0,0 +1,25 @@
+---
+title: Groups
+partiallyActive: true
+---
+The group area includes everything that can be broken down into a group of several users and their authorizations.
+
+* [External groups (CAS)](external/)
+* [Settings](settings/)
+
+It is possible to create groups in SCM-Manager to not authorize each user individually. Groups can be authorized and can contain an unlimited number of users.
+
+### Overview
+The groups overview shows a list of all groups that are existing. Groups are distinguished between internal and external groups. Internal groups are groups that were created in SCM-Manager and are indicated by a house icon. External groups were created by external sources like a connected LDAP instance and have a world icon.
+
+![Groups Overview](assets/groups-overview.png)
+
+### Create a Group
+Groups only require a name. It is also possible to add members to a group directly when they are created. Only the permissions of the group have to be added afterwards.
+
+![Create Group](assets/create-group.png)
+
+### Group Information
+The information page of a group shows the meta data as well as the members.
+
+![Group-Information](assets/groups-information.png)

docs/en/user/group/settings.md

@@ -0,0 +1,13 @@
+---
+title: Groups
+subtitle: Settings
+---
+### General
+In the general settings page of a group the description and the members can be edited. Also, it is possible to delete a group here. The deletion is irreversible.
+
+![General Group Settings](assets/groups-settings-general.png)
+
+### Permissions
+Groups can get global and repository-specific permissions. All permissions of a group are valid for all its members. 
+
+![Group Permissions](assets/groups-settings-permissions.png)

docs/en/user/repo/branches.md

@@ -0,0 +1,22 @@
+---
+title: Repository
+subtitle: Branches
+---
+### Overview
+The branches overview shows the branches that are already existing. By clicking on a branch, the details page of the branch is shown.
+
+The tag "Default" shows which branch is currently set as the default branch of the repository in SCM-Manager. The default branch is always shown first when opening the repository in SCM-Manager.
+
+The button "Create Branch" opens the form to create a new branch.
+
+![Branches Overview](assets/repository-branches-overview.png)
+
+### Create a Branch
+New branches can be created with the "Create Branch" form. There, you have to choose the branch that the new branch will be branched from and to provide a name for the new branch. It is not possible to create branches in an empty Git repository.
+
+![Create Branch](assets/repository-create-branch.png)
+
+### Branch Details Page
+This page shows some commands to work with the branch on the command line.
+
+![Branch Details Page](assets/repository-branch-detailView.png)

docs/en/user/repo/code.md

@@ -0,0 +1,42 @@
+---
+title: Repository
+subtitle: Code
+displayToc: true
+---
+The "Code" section contains all information that refers to the code respectively the content of the repository. At the top of the page is the action bar, which can be used to navigate within the code section.
+
+### Sources
+The sources overview shows the files and folders within the repository. If branches exist, it shows the sources for the selected branch.
+
+Below the action bar is a breadcrumb navigation that shows the path of the files that are displayed. By clicking on the different sections of the path it is possible to navigate (back) through the file structure of the repository.
+
+![Repository-Code-Sources](assets/repository-code-sourcesView.png)
+
+### Changesets
+The changesets/commits overview shows the change history of the branch. Each entry represents a commit. 
+
+The Details button leads to the content/changes of a changeset.
+
+The Sources button leads to the sources overview that shows the state from after this commit.
+
+![Repository-Code-Changesets](assets/repository-code-changesetsView.png)
+
+### Changeset Details
+The details page of a changeset shows the metadata and all changes that are part of the changeset. The diffs are presented in the well-known format per file with syntax highlighting.
+
+![Repository-Code-Changesets](assets/repository-code-changesetDetails.png)
+
+### File Details
+After clicking on a file in the sources, the details of the file are shown. Depending on the format of the file, there are different views:
+
+- Image file: The rendered image is shown.
+- Markdown file: The rendered markdown is shown. The view can also be changed to a text view that is not rendered.
+- Text based file: The content is shown. If available with syntax highlighting.
+- Unsupported formats: A download button is shown.
+
+![Repository-Code-FileDetails](assets/repository-code-fileViewer.png)
+
+### File History
+In the detailed file view there is a switch button in the upper right corner which allows to switch to the history view. The history shows all commits that changed the file.
+
+![Repository-Code-FileHistory](assets/repository-code-fileHistory.png)

docs/en/user/repo/index.md

@@ -0,0 +1,39 @@
+---
+title: Repository
+partiallyActive: true
+---
+The Repository area includes everything based on repositories in namespaces. This includes all operations on branches, the code and settings.
+
+* [Branches](branches/)
+* [Code](code/)
+* [Settings](settings/)
+
+### Overview
+The repository overview screen shows all repositories sorted by namespaces. Each repository is shown as a tile. After clicking on the tile the readme screen of the repository is shown.
+
+![Repository Overview](assets/repository-overview.png)
+
+The search bar at the top can be used to filter the repositories. The search uses the name and description of the repositories.
+
+The different tabs like branches, changesets or sources of the repository can be accessed through the blue icons.
+
+Icon             |  Description
+---|---
+![Repository Branches](assets/repository-overview-branches.png)  |  Opens the branches overview for the repository
+![Repository Changesets](assets/repository-overview-changesets.png) | Opens the changeset overview for the repository
+![Repository Sources](assets/repository-overview-sources.png) | Opens the sources overview for the repository
+![Repository Settings](assets/repository-overview-settings.png) | Opens the settings for the repository
+
+### Create a Repository
+In  SCM-Manager new Git, Mercurial & Subversion (SVN) repositories can be created via a form that can be accessed via the "Create Repository" button. A valid name and the repository type are mandatory.
+
+Optionally, repositories can be initialized during the creation. That creates a standard branch (master or default) for Git and Mercurial repositories. Additionally, it performs a commit that creates a README.md.
+
+If the namespace strategy is set to custom, the namespace field is also mandatory.
+
+![Create Repository](assets/create-repository.png)
+
+### Repository Information
+The information screen of repositories shows meta data about the repository. Amongst that are descriptions for the different options on how the repository can be used. 
+
+![Repository Information](assets/repository-information.png)

docs/en/user/repo/settings.md

@@ -0,0 +1,23 @@
+---
+title: Repository
+subtitle: Settings
+---
+By default, there are two items in the repository settings. Depending on additional plugins that are installed, there can be considerably more items.
+
+### General
+The "General" item allows you to edit the additional information of the repository. Git repositories for example also have the option to change the default branch here. The default branch is the one that is used when working with the repository if no specific branch is selected.
+
+At the bottom of this screen is also a button to delete the repository from SCM-Manager. The deletion is irreversible.
+
+![Repository-Settings-General-Git](assets/repository-settings-general-git.png)
+
+### Permissions
+Thanks to the finely granular permission concept of SCM-Manager, users and groups can be authorized based on definable roles or individual settings. Permissions can be granted globally or repository-specific. Global permissions are managed in the administration area of SCM-Manager. The following image shows repository-specific permissions.
+
+Permissions can be granted to groups or users. It is possible to manage each permission individually or to create roles that contain several permissions. Roles can be defined in the administration area.
+
+![Repository-Settings-PermissionOverview](assets/repository-settings-permissionOverview.png)
+
+To manage permissions individually, an "Advanced" dialog can be opened to manage every single permission.
+
+![Repository-Settings-PermissionList](assets/repository-settings-permissionList.png)

docs/en/user/user/index.md

@@ -0,0 +1,24 @@
+---
+title: User
+partiallyActive: true
+---
+The user area includes everything that can be broken down to a single user and their permissions.
+
+* [Settings](settings/)
+
+### Overview
+The user overview shows a list of all existing users. A page with details about a user can be accessed by clicking on the user. New users can be created with the "Create User" button.
+
+![User Overview](assets/user-overview.png)
+
+### Create User
+The "Create User" form can be used to create new users in SCM-Manager. New users don’t have any permissions and should therefore be configured right after they were created.
+
+![Create User](assets/create-user.png)
+
+### User Details Page
+The user details page shows the information about the user.
+
+The active box shows whether the user is able to use SCM-Manager. The type XML from the shown example indicates that the user was created in SCM-Manager. Users can also be created through external sources, for example based on the information from a LDAP instance that is connected through the LDAP plugin.
+
+![User-Information](assets/user-information.png)

docs/en/user/user/settings.md

@@ -0,0 +1,21 @@
+---
+title: User
+subtitle: Settings
+---
+### General
+In the general settings the display name, e-mail address and active status of an account can be edited. 
+
+On the bottom is also a button to delete the user. The deletion is irreversible.
+
+![General User Settings](assets/user-settings-general.png)
+
+### Password
+The password of a user can be changed in the password section. Users can also change their password themselves by clicking on the "Change password" link in the footer of SCM-Manager, under their username. That will take them to their settings where they can change their password, amongst others.
+
+![Change Password](assets/user-settings-password.png)
+
+### Permissions
+In the permissions section, the global, therefore not repository-specific permissions, can be configured for the user.
+There is a tooltip for each permission that provide some more details about the option.
+
+![User Permissions](assets/user-settings-permissions.png)