TRG 1.06 - Administrator's Guide

Status	Created	Post-History
Active	22-Apr-2024
Draft	21-Mar-2024	Transferred from Release Acceptance Criteria into TRG

Why

Tractus-X components and applications may be operated in various productive environments. An Administrator`s guide shall help operators to install and operate the solution. It can also be a vehicle to share best-practices on maintenance etc.

Description

• The Admin Guide must be stored in the folder: /docs/admin
  • It is up-to-date for every release
  • English is a must
• The /docs/README.md describes shortly what documentation is available

Best Practice

• Favor diagrams as mermaid block in .md files directly over image files, where possible
• Have a look to peer repositories within Tractus-X for inspiration
• Anchor a link to your admin guide within your README.md (see TRG 1.01)