mirror of
https://github.com/scm-manager/scm-manager.git
synced 2026-05-07 08:16:57 +02:00
Merge branch 'develop' into feature/filetree_file_status_icon
This commit is contained in:
Florian Scholdei
9
docs/de/development/javadoc.md
Normal file
9
docs/de/development/javadoc.md
Normal file
@@ -0,0 +1,9 @@
|
||||
---
|
||||
title: Javadoc
|
||||
---
|
||||
|
||||
Die Javadoc finden Sie unter [javadoc](https://scm-manager.org/javadoc/).
|
||||
|
||||
### Entwicklungshinweis
|
||||
Bitte beachten Sie, dass Fehler (Errors) in Javadoc-Kommentaren zum beabsichtigten Scheitern des Build-Prozesses führen.
|
||||
Zudem wird dazu geraten, Warnhinweise bei neu hinzugefügten Javadoc-Kommentaren zu vermeiden.
|
||||
@@ -1,14 +1,14 @@
|
||||
---
|
||||
title: Dokumentation
|
||||
subtitle: SCM-Manager Dokumentation
|
||||
subtitle: SCM-Manager-Dokumentation
|
||||
---
|
||||
Diese Dokumentation beschreibt die Verwaltung und Verwendung vom SCM-Manager. Sie steht in verschiedenen Sprachen und Versionen zur Verfügung, die im Menü rechts ausgewählt werden können.
|
||||
|
||||
Der SCM-Manager 2 ist ein extrem leichtgewichtiges Source Code Management-Tool und kann über eine Vielzahl von Plugins individuell erweitert werden.
|
||||
Der SCM-Manager ist ein extrem leichtgewichtiges Source-Code-Management-Tool und kann über eine Vielzahl von Plugins individuell erweitert werden.
|
||||
Die Dokumentation zum SCM-Manager ist in fünf verschiedene Kategorien unterteilt:
|
||||
|
||||
- Der Abschnitt "Erste Schritte" beschreibt die Installation und die Konfiguration des SCM-Managers und beantwortet häufig gestellte Fragen.
|
||||
- Der Bereich "Administration" handelt von Themen, die beim Betreiben einer Instanz von Belangen sind.
|
||||
- Unter der Rubrik "Entwicklung" werden alle Informationen zusammengefasst, die für die Weiterentwicklung des SCM-Managers relevant sind. Hierbei wird beschrieben, wie der SCM-Manager gebaut werden kann und was es dabei zu Beachten gilt.
|
||||
- Der Bereich "Pluginentwicklung" legt den Fokus auf den Prozess eben dieser.
|
||||
- Unter dem Abschnitt "Anwenderorientiert" werden aus Anwendersicht die Funktionen des SCM-Managers in der Basis-Variante mit dem Mindest-Set an Plugins beschrieben. Die Features der optionalen Plugins werden in separaten Dokumentationen vorgestellt.
|
||||
- Der Abschnitt „Erste Schritte“ beschreibt die Installation und die Konfiguration des SCM-Managers und beantwortet häufig gestellte Fragen.
|
||||
- Der Bereich „Administration“ handelt von Themen, die beim Betreiben einer Instanz von Belangen sind.
|
||||
- Unter der Rubrik „Entwicklung“ werden alle Informationen zusammengefasst, die für die Weiterentwicklung des SCM-Managers relevant sind. Hierbei wird beschrieben, wie der SCM-Manager gebaut werden kann und was es dabei zu beachten gilt.
|
||||
- Der Bereich „Pluginentwicklung“ legt den Fokus auf den Prozess eben dieser.
|
||||
- Unter dem Abschnitt „Anwenderorientiert“ werden aus Anwendersicht die Funktionen des SCM-Managers in der Basis-Variante mit dem Mindestsatz an Plugins beschrieben. Die Features der optionalen Plugins werden in separaten Dokumentationen vorgestellt.
|
||||
|
||||
@@ -45,7 +45,7 @@ Falls die Lebensdauer verringert wird, wird jeder bisher ausgestellter JWT ungü
|
||||
Sollte in der `config.yml` des Servers die Option "endless JWT" aktiviert sein, dann wird diese Einstellung ignoriert.
|
||||
|
||||
#### Anonyme Zugriff
|
||||
Der SCM-Manager 2 hat das Konzept für anonyme Zugriffe über einen "_anonymous"-Benutzer realisiert. Beim Aktivieren des anonymen Zugriffs wird ein neuer Benutzer erstellt mit dem Namen "_anonymous". Dieser Nutzer kann wie ein gewöhnlicher Benutzer für unterschiedliche Aktionen berechtigt werden. Bei einem Zugriff auf den SCM-Manager ohne Zugangsdaten wird dieser anonyme Benutzer verwendet.
|
||||
Der SCM-Manager hat das Konzept für anonyme Zugriffe über einen "_anonymous"-Benutzer realisiert. Beim Aktivieren des anonymen Zugriffs wird ein neuer Benutzer erstellt mit dem Namen "_anonymous". Dieser Nutzer kann wie ein gewöhnlicher Benutzer für unterschiedliche Aktionen berechtigt werden. Bei einem Zugriff auf den SCM-Manager ohne Zugangsdaten wird dieser anonyme Benutzer verwendet.
|
||||
Ist der anonyme Zugriff nur für Protokoll aktiviert, können die REST API und die VCS Protokolle anonym genutzt werden. Wurde der anonyme Zugriff vollständig aktiviert, ist auch ein Zugriff über den Webclient anonym möglich.
|
||||
|
||||
Beispiel: Falls der anonyme Zugriff aktiviert ist und der "_anonymous"-Benutzer volle Zugriffsrechte auf ein bestimmtes Git-Repository hat, kann jeder über eine Kommandozeile mit den klassischen Git-Befehlen ohne Zugangsdaten auf dieses Repository zugreifen. Zugriffe über SSH werden aktuell nicht unterstützt.
|
||||
|
||||
@@ -9,7 +9,7 @@ title: Building SCM-Manager from Source
|
||||
- Maven 3 or higher ([download](https://maven.apache.org/))
|
||||
- Git ([download](https://git-scm.com/))
|
||||
|
||||
### Build SCM-Manager 2.x from Source
|
||||
### Build SCM-Manager from Source
|
||||
|
||||
```bash
|
||||
git clone https://github.com/scm-manager/scm-manager.git
|
||||
|
||||
@@ -3,3 +3,7 @@ title: Javadoc
|
||||
---
|
||||
|
||||
You can find the Javadoc at [javadoc](https://scm-manager.org/javadoc/).
|
||||
|
||||
### Development note
|
||||
Please keep in mind that any newly introduced Javadoc error causes build breaks by design.
|
||||
Furthermore, it is advised to avoid warnings in case of newly introduced Javadoc comments.
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title: DOD for UI development
|
||||
---
|
||||
|
||||
Use this as a kind of a checklist whenever you develop something in the UI of SCM-Manager 2.x., regardless whether you are developing core features or plugins.
|
||||
Use this as a kind of checklist whenever you develop something in the UI of SCM-Manager, regardless whether you are developing core features or plugins.
|
||||
|
||||
| | Don't forget to |
|
||||
|---|-----------------|
|
||||
|
||||
@@ -4,7 +4,7 @@ subtitle: SCM-Manager Documentation
|
||||
---
|
||||
This documentation describes the administration and usage of SCM-Manager. It is available in different languages and versions, which can be selected in the menu on the right.
|
||||
|
||||
SCM-Manager 2 is an extremely lightweight source code management tool that can be individually extended through a variety of plugins.
|
||||
SCM-Manager is an extremely lightweight source code management tool that can be individually extended through a variety of plugins.
|
||||
This documentation is divided into five categories:
|
||||
|
||||
- The section "Getting started" introduces the installation and configuration of SCM-Manager and answers frequently asked questions.
|
||||
|
||||
@@ -44,7 +44,7 @@ If the amount of hours get reduced, each created JWT will be invalidated.
|
||||
This setting will be ignored, if the endless JWT option is set to true in the server `config.yml`.
|
||||
|
||||
#### 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.
|
||||
In SCM-Manager 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.
|
||||
If the anonymous mode is protocol only you may access the SCM-Manager via the REST API and VCS protocols. With fully enabled anonymous access you can also use the webclient without credentials.
|
||||
|
||||
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.
|
||||
|
||||
Reference in New Issue
Block a user