From b73f50c347c054d06bdd548425013834386acab8 Mon Sep 17 00:00:00 2001
From: dominik003 <info@dominik-lammers.de>
Date: Mon, 9 Oct 2023 13:29:01 +0200
Subject: [PATCH] docs: Add t4c instance documentation

---
 docs/user/docs/settings/model-sources/t4c.md | 40 ++++++++++++++++++++
 1 file changed, 40 insertions(+)
 create mode 100644 docs/user/docs/settings/model-sources/t4c.md

diff --git a/docs/user/docs/settings/model-sources/t4c.md b/docs/user/docs/settings/model-sources/t4c.md
new file mode 100644
index 0000000000..c75d462f25
--- /dev/null
+++ b/docs/user/docs/settings/model-sources/t4c.md
@@ -0,0 +1,40 @@
+<!--
+ ~ SPDX-FileCopyrightText: Copyright DB Netz AG and the capella-collab-manager contributors
+ ~ SPDX-License-Identifier: Apache-2.0
+ -->
+
+# Manage T4C instances
+
+## Define a T4C instance
+
+1.  Please navigate to `Profile` > `Settings`
+1.  Select `T4C` bewlow `Model sources`
+1.  You can see all existing instances (if any). To add a new instance, click
+    on the "Add an instance" card. You have to enter the following information:
+    <!-- prettier-ignore -->
+    1. **Name**: Any name to identify the instance
+    1. **Capella version**: Capella version that corresponds to the instance
+    1. **License configuration**: License key of your license server
+    1. **Protocol**: Protocol that should be used to communicate between
+    capella sessions and the T4C server
+    1. **Host**: Hostname of the T4C server
+    1. **Port**, **CDO Port**, and **HTTP Port** Corresponding ports of your server
+    1. **License server API**: License server API url
+    1. **REST API**: REST API URL of the T4C server
+    1. **Username**: Username with access to the REST API, required for communication
+    with the REST API
+    1. **Password**: Password corresponding to username
+
+## Archive a T4C instance
+
+1.  Please navigate to `Profile` > `Settings`
+1.  Select `T4C` bewlow `Model sources`
+1.  Click on the instance that you want to archive
+1.  Click on the `Archive` button. When everything worked you should see a
+    messages stating "Instance updated: The instance _name_ is now archived"
+
+An archived instance can no longer be selected when creating a new T4C model
+and is highlighted with a gray background and an `Archived` tag in the bottom
+right in the T4C instance overview. Existing linked T4C models and all
+repositories corresponding to the archived instance will continue to work as
+before.