Add introduction and description of individual documentation sections

This commit is contained in:
Florian Scholdei
2020-06-16 16:00:00 +02:00
parent f2d1875fa6
commit ca94f294e3
2 changed files with 22 additions and 5 deletions

14
docs/de/index.md Normal file
View File

@@ -0,0 +1,14 @@
---
title: 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.
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.

View File

@@ -2,10 +2,13 @@
title: Documentation
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.
This documentation describes the administration and usage of SCM-Manager.
SCM-Manager 2 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:
## Version and language
The documentation belongs to a specific language and version of SCM-Manager.
You can choose your version and language on the menu to the right.
- The section "Getting started" introduces the installation and configuration of SCM-Manager and answers frequently asked questions.
- The "Administration" area deals with issues that are important when operating an instance.
- The rubric "Development" contains information for the further development of SCM-Manager. It describes how SCM-Manager can be built and what needs to be considered.
- The area of "Plugin Development" focuses on the process of plugin development.
- "User-oriented" summarizes the features from the user's point of view in the basic version with the minimal set of plugins. The features of the optional plugins are introduced in separate documentations.