feat: update naming

nmshd · Sep 22, 2023 · 9c7b60e · 9c7b60e
1 parent bc0b7ae
commit 9c7b60e
Show file tree

Hide file tree

Showing 77 changed files with 225 additions and 166 deletions.
diff --git a/_data/navigation.yml b/_data/navigation.yml
@@ -1,12 +1,12 @@
 main:
   - title: "Use"
-    url: /use/install-the-app
+    url: /use
   - title: "Explore"
     url: /explore
   - title: "Integrate"
     url: /integrate
   - title: "Operate"
-    url: /operate/get-an-overview-of-connector
+    url: /operate
   - title: "Contribute"
     url: /contribute
   - title: "Blog"
@@ -83,14 +83,14 @@ docs_integrate:
     children:
       - title: "Get in touch with Connector REST API"
         url: /integrate/get-in-touch-with-connector-rest-api
-      - title: "Connector Integration Tutorial"
-        url: /integrate/connector-integration-tutorial
       - title: "Use Cases"
         url: /integrate/use-cases
+      - title: "Connector Integration Tutorial"
+        url: /integrate/connector-integration-tutorial
+      - title: "Introduction"
+        url: /integrate/introduction
   - title: Data Model
     children:
-      - title: "Error Codes"
-        url: /integrate/error-codes
       - title: "Introducing the enmeshed Data Model"
         url: /integrate/introducing-the-enmeshed-data-model
       - title: "Overview of Requests and RequestItems"
@@ -123,12 +123,18 @@ docs_integrate:
     children:
       - title: "Requesting one-time consents"
         url: /integrate/requesting-one-time-consents
+  - title: Troubleshooting
+    children:
+      - title: "Error Codes"
+        url: /integrate/error-codes
+      - title: "FAQ"
+        url: /integrate/faq
+      - title: "Support"
+        url: /integrate/support
 
 docs_operate:
-  - title: Getting Started
+  - title: Setting up
     children:
-      - title: "Get an overview of Connector"
-        url: /operate/get-an-overview-of-connector
       - title: "Set-up Connector for development use (with Docker compose)"
         url: /operate/set-up-connector-for-development-use-with-docker-compose
   - title: Operations
@@ -149,3 +155,9 @@ docs_operate:
         url: /operate/privacy-considerations
       - title: "Performance Considerations"
         url: /operate/performance-considerations
+  - title: Troubleshooting
+    children:
+      - title: "FAQ"
+        url: /operate/faq
+      - title: "Support"
+        url: /operate/support
diff --git a/_docs_explore/52-connector.md b/_docs_explore/52-connector.md
@@ -4,8 +4,6 @@ permalink: /explore/connector
 toc: true
 ---
 
-You can find many Connector-specific information in the [integrate]({% link _docs_operate/get-an-overview-of-connector.md %}) part of these docs.
-
 # Connector Building Blocks
 
 ## Connector Docker Image
@@ -32,3 +30,27 @@ The Connector uses a MongoDB database to store its data. You can read more about
 ## Connector SDK
 
 Read more about the [Connector SDKs]({% link _docs_integrate/working-with-the-connector-sdks.md %}).
+
+## What is the Connector?
+
+It is a software component which runs in the network of any organization, hosting a set of APIs to easily consume Enmeshed features. It is usually run with the provided Docker image. The Connector requires a document database to store its data.
+
+Going a bit more technical, the Connector uses NodeJS with Express to host an HTTP server. It spans up REST APIs used as the primary integration mechanism. However, it is also possible to write custom TypeScript/JavaScript Modules which are run on the Connector itself. The Connector makes use of the Enmeshed Runtime to provide all features of the Enmeshed Transport Layer as a consumable API.
+
+## Why does my organization need a Connector?
+
+Enmeshed consists of different layers, each of which provide a different set of functionality and abstractions. The very low levels introduce a common set of communication and encryption contracts, which are required for all the upper levels. Just like you do not want to implement your own network stack, you usually do not want to implement the contracts by yourself.
+
+The Connector stores required Enmeshed metadata on a central point within the organization network, making it possible for existing system to access all the features of the Connector. With this approach, it is not necessary to implement the whole stack of Enmeshed in each and every system, like user key management and encryption capabilities.
+
+Additionally, the Connector should be run within the organizations network, as it acts as the digital identity of the organization itself, as well as a secure gateway to Enmeshed. Although it could be hosted by a third-party as a software-as-a-service, we discourage this approach for production environments. The hosting provider would be able to impersonate the actual organization within the Enmeshed ecosystem and would be able to access the plaintext data of users, messages, files, an so on.
+
+If you ask yourself now "Why does Enmeshed itself host Connectors then?" - good catch! We do host Connectors but only for development, test or demo reasons.
+
+## So how does my organization get started?
+
+Unfortunately, there is no button with which you can switch on the digitalization. Processes need to be set up, old processes need to be digitalized, data might need to be mapped, and so on. However, one needs to start somehow and we can help you on your journey.
+
+We propose to set up a first test Connector by your IT department or let us do the hosting. Then you can decide how far Enmeshed and its supported features and processes work for you.
+
+If you like to try on your own: There is a Connector Tutorial in the next chapter which is a good starting point to set up the Connector on a try out basis. More details are available in the "Setting up the Connector" and integration sections. If you like to dig deeper, there are operation tutorials which might answer some questions with regards to overall security and privacy.
diff --git a/_docs_integrate/automate-request-handling.md b/_docs_integrate/automate-request-handling.md
@@ -5,7 +5,7 @@ title: "Automate request handling"
 type: scenario
 toc: true
 properties:
-  - id: SC42
+  - id: SC042
   - category: Working with requests
   - description:
   - customer: All

diff --git a/_docs_integrate/automated-authentication-management-with-external-system.md b/_docs_integrate/automated-authentication-management-with-external-system.md
@@ -5,7 +5,7 @@ title: "Automated authentication management with external system"
 type: scenario
 toc: true
 properties:
-  - id: SC35
+  - id: SC035
   - category: Requesting authentication
   - description:
   - customer: All

diff --git a/_docs_integrate/automated-consent-management-with-external-system.md b/_docs_integrate/automated-consent-management-with-external-system.md
@@ -5,7 +5,7 @@ title: "Automated consent management with external system"
 type: scenario
 toc: true
 properties:
-  - id: SC31
+  - id: SC031
   - category: Requesting consent of users
   - description:
   - customer: All

diff --git a/_docs_integrate/connector-integration-tutorial.md b/_docs_integrate/connector-integration-tutorial.md
@@ -6,7 +6,7 @@ title: "Connector Integration Tutorial"
 type: scenario
 toc: true
 properties:
-  - id: SC95
+  - id: SC095
   - category: 1Getting Started
   - description: https//enmeshed.eu/integrate/connector-tutorial
   - customer:

diff --git a/_docs_integrate/create-attribute-for-peer.md b/_docs_integrate/create-attribute-for-peer.md
@@ -5,7 +5,7 @@ title: "Create attribute for peer"
 type: scenario
 toc: true
 properties:
-  - id: SC67
+  - id: SC067
   - category: Manage attributes of others
   - description:
   - customer: All

diff --git a/_docs_integrate/create-own-identityattribute.md b/_docs_integrate/create-own-identityattribute.md
@@ -5,7 +5,7 @@ title: "Create own IdentityAttribute"
 type: scenario
 toc: true
 properties:
-  - id: SC49
+  - id: SC049
   - category: Manage attributes of yourself
   - description:
   - customer: All

diff --git a/_docs_integrate/creating-complex-requests.md b/_docs_integrate/creating-complex-requests.md
@@ -5,7 +5,7 @@ title: "Creating complex requests"
 type: scenario
 toc: true
 properties:
-  - id: SC39
+  - id: SC039
   - category: Working with requests
   - description:
   - customer: All

diff --git a/_docs_integrate/delete-identity-from-enmeshed.md b/_docs_integrate/delete-identity-from-enmeshed.md
@@ -5,7 +5,7 @@ title: "Delete Identity from Enmeshed"
 type: scenario
 toc: true
 properties:
-  - id: SC61
+  - id: SC061
   - category: Identity Basics
   - description:
   - customer: All

diff --git a/_docs_integrate/error-codes.md b/_docs_integrate/error-codes.md
@@ -6,8 +6,8 @@ title: "Error Codes"
 type: scenario
 toc: true
 properties:
-  - id: SC89
-  - category: Data Model
+  - id: SC089
+  - category: Troubleshooting
   - description: https//enmeshed.eu/integrate/error-codes
   - customer:
   - component: integrate

diff --git a/_docs_integrate/event-introduction.md b/_docs_integrate/event-introduction.md
@@ -6,7 +6,7 @@ title: "Event introduction"
 type: scenario
 toc: true
 properties:
-  - id: SC43
+  - id: SC043
   - category: Handling events
   - description: https//enmeshed.eu/integrate/connector-events
   - customer: All

diff --git a/_docs_integrate/faq.md b/_docs_integrate/faq.md
@@ -0,0 +1,22 @@
+---
+permalink: integrate/faq
+published: true
+title: "FAQ"
+type: scenario
+toc: true
+properties:
+  - id: SC097
+  - category: Troubleshooting
+  - description:
+  - customer:
+  - component: integrate
+  - level:
+  - implementation status:
+  - documentation status:
+  - published: true
+  - link: integrate/faq
+require:
+required_by:
+---
+
+{% include scenarios/integrate/faq.md %}
diff --git a/_docs_integrate/get-in-touch-with-connector-rest-api.md b/_docs_integrate/get-in-touch-with-connector-rest-api.md
@@ -6,7 +6,7 @@ title: "Get in touch with Connector REST API"
 type: scenario
 toc: true
 properties:
-  - id: SC75
+  - id: SC075
   - category: 1Getting Started
   - description: https//enmeshed.eu/integrate/connector-api
   - customer:

diff --git a/_docs_integrate/get-users-who-did-not-consent-to-latest-version.md b/_docs_integrate/get-users-who-did-not-consent-to-latest-version.md
@@ -5,7 +5,7 @@ title: "Get users who did not consent to latest version"
 type: scenario
 toc: true
 properties:
-  - id: SC29
+  - id: SC029
   - category: Requesting consent of users
   - description:
   - customer: All

diff --git a/_docs_integrate/identityattribute-introduction.md b/_docs_integrate/identityattribute-introduction.md
@@ -5,7 +5,7 @@ title: "IdentityAttribute introduction"
 type: scenario
 toc: true
 properties:
-  - id: SC47
+  - id: SC047
   - category: Manage attributes of yourself
   - description:
   - customer: All

diff --git a/_docs_integrate/introducing-the-enmeshed-data-model.md b/_docs_integrate/introducing-the-enmeshed-data-model.md
@@ -6,7 +6,7 @@ title: "Introducing the enmeshed Data Model"
 type: scenario
 toc: true
 properties:
-  - id: SC90
+  - id: SC090
   - category: Data Model
   - description: https//enmeshed.eu/integrate/data-model-overview
   - customer:

diff --git a/_docs_integrate/introduction.md b/_docs_integrate/introduction.md
diff --git a/_docs_integrate/notify-service-of-enmeshed-event.md b/_docs_integrate/notify-service-of-enmeshed-event.md
@@ -5,7 +5,7 @@ title: "Notify service of enmeshed event"
 type: scenario
 toc: true
 properties:
-  - id: SC44
+  - id: SC044
   - category: Handling events
   - description:
   - customer: All

diff --git a/_docs_integrate/overview-of-attribute-values.md b/_docs_integrate/overview-of-attribute-values.md
@@ -6,7 +6,7 @@ title: "Overview of Attribute Values"
 type: scenario
 toc: true
 properties:
-  - id: SC92
+  - id: SC092
   - category: Data Model
   - description: https//enmeshed.eu/integrate/data-model-attribute-values
   - customer:

diff --git a/_docs_integrate/overview-of-consent-possibilities.md b/_docs_integrate/overview-of-consent-possibilities.md
@@ -5,7 +5,7 @@ title: "Overview of consent possibilities"
 type: scenario
 toc: true
 properties:
-  - id: SC24
+  - id: SC024
   - category: Requesting consent of users
   - description:
   - customer: All

diff --git a/_docs_integrate/overview-of-request-items.md b/_docs_integrate/overview-of-request-items.md
@@ -5,7 +5,7 @@ title: "Overview of request items"
 type: scenario
 toc: true
 properties:
-  - id: SC38
+  - id: SC038
   - category: Working with requests
   - description:
   - customer: All

diff --git a/_docs_integrate/overview-of-requests-and-requestitems.md b/_docs_integrate/overview-of-requests-and-requestitems.md
@@ -6,7 +6,7 @@ title: "Overview of Requests and RequestItems"
 type: scenario
 toc: true
 properties:
-  - id: SC91
+  - id: SC091
   - category: Data Model
   - description: https//enmeshed.eu/integrate/data-model-request-items
   - customer:

diff --git a/_docs_integrate/prepare-enmeshed-onboarding-package.md b/_docs_integrate/prepare-enmeshed-onboarding-package.md
@@ -5,7 +5,7 @@ title: "Prepare enmeshed onboarding package"
 type: scenario
 toc: true
 properties:
-  - id: SC74
+  - id: SC074
   - category: Get in touch with other Identities
   - description:
   - customer: All

diff --git a/_docs_integrate/process-incoming-attribute-deletion-requests.md b/_docs_integrate/process-incoming-attribute-deletion-requests.md
@@ -5,7 +5,7 @@ title: "Process incoming Attribute deletion requests"
 type: scenario
 toc: true
 properties:
-  - id: SC55
+  - id: SC055
   - category: Handling data deletion
   - description:
   - customer: All

diff --git a/_docs_integrate/process-incoming-relationship-deletion-requests.md b/_docs_integrate/process-incoming-relationship-deletion-requests.md
@@ -5,7 +5,7 @@ title: "Process incoming Relationship deletion requests"
 type: scenario
 toc: true
 properties:
-  - id: SC56
+  - id: SC056
   - category: Handling data deletion
   - description:
   - customer: All

diff --git a/...tegrate/process-received-enmeshed-onboarding-package-and-create-relationship.md b/...tegrate/process-received-enmeshed-onboarding-package-and-create-relationship.md
@@ -5,7 +5,7 @@ title: "Process received enmeshed onboarding package and create relationship"
 type: scenario
 toc: true
 properties:
-  - id: SC64
+  - id: SC064
   - category: Get in touch with other Identities
   - description:
   - customer: All

diff --git a/_docs_integrate/process-responses-to-outgoing-requests.md b/_docs_integrate/process-responses-to-outgoing-requests.md
@@ -5,7 +5,7 @@ title: "Process responses to outgoing requests"
 type: scenario
 toc: true
 properties:
-  - id: SC40
+  - id: SC040
   - category: Working with requests
   - description:
   - customer: All

diff --git a/_docs_integrate/propose-attribute-to-peer.md b/_docs_integrate/propose-attribute-to-peer.md
@@ -5,7 +5,7 @@ title: "Propose attribute to peer"
 type: scenario
 toc: true
 properties:
-  - id: SC66
+  - id: SC066
   - category: Manage attributes of others
   - description:
   - customer: All

diff --git a/_docs_integrate/read-attribute-from-peer.md b/_docs_integrate/read-attribute-from-peer.md
@@ -5,7 +5,7 @@ title: "Read attribute from peer"
 type: scenario
 toc: true
 properties:
-  - id: SC65
+  - id: SC065
   - category: Manage attributes of others
   - description:
   - customer: All

diff --git a/...ntegrate/request-and-process-attributes-by-code-or-link-of-existing-contacts.md b/...ntegrate/request-and-process-attributes-by-code-or-link-of-existing-contacts.md
@@ -5,7 +5,7 @@ title: "Request and process attributes by code or link of existing contacts"
 type: scenario
 toc: true
 properties:
-  - id: SC51
+  - id: SC051
   - category: Manage attributes of others
   - description:
   - customer: All