diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 1704a6079..6f0de9241 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -105,7 +105,7 @@ On this page is search function for icons available as well.
Extend section
| Admonition Name | Used For | Example |
-| ---- ----------- | -------- | ------- |
+| --------------- | -------- | ------- |
| Info | Information in documentation provides details about a topic or process that the reader needs to know. It is usually essential and relevant to the main subject of the document. | Statement annotations provide a way to express knowledge about statements. This group is dedicated to properties that configure the Statement Annotation feature |
| Note | A note provides additional details that may or may not be directly related to the main topic. It could be an explanation, clarification, or an aside that the writer thinks would be helpful for the reader to know. | The graph selection drop-down might or might not be visible depending the existence of an (optional) EasyNav Module configuration. In case no specific module configuration exists or non has not has been set for the current workspace the graph selection will be shown. A EasyNav Module configuration pre-configures a graph. Thus, the dropdown will not be shown if such has been configured for the current workspace. |
| Abstract | An abstract is a brief summary that provides an overview of the main points or contents of a document. It typically appears at the beginning of a document and is intended to give the reader an idea of what to expect from the document. | This tutorial explores the benefits of using cloud computing in enterprise organizations. It discusses the advantages of cloud computing over traditional on-premises infrastructure, and provides guidance for migrating to the cloud. |
diff --git a/docs/deploy-and-configure/configuration/graphinsights/explore-application-view-enable-graphinsights.png b/docs/deploy-and-configure/configuration/graphinsights/explore-application-view-enable-graphinsights.png
new file mode 100644
index 000000000..6ab8c591b
Binary files /dev/null and b/docs/deploy-and-configure/configuration/graphinsights/explore-application-view-enable-graphinsights.png differ
diff --git a/docs/deploy-and-configure/configuration/graphinsights/explore-application-view-graphinsights-override.png b/docs/deploy-and-configure/configuration/graphinsights/explore-application-view-graphinsights-override.png
new file mode 100644
index 000000000..d124cfc98
Binary files /dev/null and b/docs/deploy-and-configure/configuration/graphinsights/explore-application-view-graphinsights-override.png differ
diff --git a/docs/deploy-and-configure/configuration/graphinsights/explore-workspace-enable-graphinsights.png b/docs/deploy-and-configure/configuration/graphinsights/explore-workspace-enable-graphinsights.png
deleted file mode 100644
index a6805fe35..000000000
Binary files a/docs/deploy-and-configure/configuration/graphinsights/explore-workspace-enable-graphinsights.png and /dev/null differ
diff --git a/docs/deploy-and-configure/configuration/graphinsights/index.md b/docs/deploy-and-configure/configuration/graphinsights/index.md
index 593ad3459..546301d32 100644
--- a/docs/deploy-and-configure/configuration/graphinsights/index.md
+++ b/docs/deploy-and-configure/configuration/graphinsights/index.md
@@ -1,9 +1,9 @@
---
tags:
- Configuration
- - Graph-Insights
- GraphInsights
---
+
# Graph Insights
## Enable Graph Insights
@@ -19,7 +19,7 @@ You can find the environment variables set as usual in `environments/default.env
Add your license to `licenses/graphinsights.lic` then start the extension on an already running Corporate Memory
deployment.
-``` console
+``` shell-session
mkdir licenses
ln -s your-license-file.lic graphinsights.lic
make enable-extension EXTENSION=graphinsights
@@ -33,7 +33,7 @@ In helm based deployment you can enable Graph Insights by enabling it in your va
It creates a new StatefulSet.
Preemptively, you have to create a secret containing your license file.
-``` console
+``` shell-session
kubectl -n cmem create secret generic graphinsights-license --from-file your-graphinsights.lic
```
@@ -58,7 +58,7 @@ You should enable this in your `value.yaml` file.
```
Also make sure you have set the clients and client credentials.
-See [Configure OAuth clients (helm)](../../../deploy-and-configure/configuration/graphinsights/index.md#configure-oauth-clients-helm)
+See [Configure OAuth clients (helm)](#configure-oauth-clients-helm)
The configuration mentioned below is rendered with those files, but you usually don't have to touch those:
@@ -72,16 +72,40 @@ for more information.
## Activate and verify the installation
-First, you have to enable the Graph Insight in your Explore Application view configuration. By default, it is disabled.
+First, you have to enable Graph Insights in your Explore application view configuration. By default, it is disabled.
+
+!!! info
+
+ The `enableGraphInsights` configuration is part of every application view, no matter whether the Graph Insights
+ extension is deployed or not.
+ Switching it on does not result in a working Graph Insights tab as long as no Graph Insights service is running,
+ so make sure you have enabled the extension as described above.
+
+Open the :eccenca-module-workspace-configuration:
+[Application view configuration](../../../explore-and-author/workspace-configuration/index.md) module, select the
+application view you want to change and expand the **Application view** section.
+There you find the `enableGraphInsights` configuration.
+
+!!! note
+
+ The switch next to the configuration key shows the value of the system default and is always disabled.
+ In order to change the value for your application view, you have to press the **Override** button first.
+
+{ class="bordered" }
+
+After pressing **Override**, an editable switch appears for your application view.
+Set it to `true` and press **Save**.
+
+{ class="bordered" }
-
-
+Then you are able to use Graph Insights.
+Therefore, select the graph to view in Graph Insights and click the :eccenca-item-add-artefact: **Prepare Graph Insights snapshot** button.
-Then you are able to create a snapshot, send it to Graph Insights and select the Graph Insights tab in explore.
+{ class="bordered" }
-
+This will enable the **Graph Insights** tab.
-
+{ class="bordered" }
## Configuration
@@ -96,7 +120,7 @@ This is why the configuration differs in both deployments, but we tried to use t
### Explore configuration
-In our **docker-orchestration** you find the file which is loaded as `graphinsight` profile
+In our **docker-orchestration** you find the file which is loaded as `graphinsights` profile
at `conf/explore/application-graphinsights.yml`.
Environment variables as usual can be found in `environments/default.env` and `environments/config.env`.
Sizing can be changed in the loaded memory profile, e.g. at `environments/config.mem.16g.env`.
@@ -312,8 +336,7 @@ global:
#### Creating separate OAuth clients for Graph Insights
-If you start Corporate Memory with the docker-orchestration (or use our keycloak helm chart) for the first time, the
-separate clients are already created when starting the Postgresql container.
+If you start Corporate Memory with the docker-orchestration (or use our keycloak helm chart) for the first time, the separate clients are already created when starting the Postgresql container.
However, regenerating a new client secret is advisable:
@@ -324,10 +347,10 @@ However, regenerating a new client secret is advisable:
- Press `Regenerate`
- Then copy the new secret and fill in the values from above.
-
+{ class="bordered" }
Also have a look below and check if your
-[Backchannel logout URL](../../../deploy-and-configure/configuration/graphinsights/index.md#set-backchannel-logout-url-for-graph-insights) is set.
+[Backchannel logout URL](#set-backchannel-logout-url-for-graph-insights) is set.
In an already running deployment you would have to create those clients on your own.
@@ -346,4 +369,4 @@ In addition, one last step is missing: To have the logout working properly you h
- Select the client `graph-insights`.
- Scroll down to this section and add this: `https:///graphinsights/logout/connect/back-channel/keycloak`
-
+{ class="bordered" }