Skip to content

Commit

Permalink
docs: copy gitbook content to main (#411)
Browse files Browse the repository at this point in the history
  • Loading branch information
tmberthold authored Jan 13, 2025
1 parent 1c4363c commit f12c5e2
Show file tree
Hide file tree
Showing 10 changed files with 74 additions and 13 deletions.
4 changes: 4 additions & 0 deletions .gitbook.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
root: ./docs/

​structure:
summary: SUMMARY.md​
14 changes: 14 additions & 0 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Table of contents

* [Welcome](product/user-documentation/General%20Overview.md)
* [FAQ](product/user-documentation/faq.md)

## User Guide

* [Manage Dataspace](product/user-documentation/Manage%20Data%20Space%20components.md)
* [Authority Section](product/user-documentation/Authority%20Section.md)
* [Administration and Support](product/user-documentation/Administration%20and%20Support.md)

## Deployment

* [Deployment Guide](deployment-guide/goals/production/README.md)
4 changes: 4 additions & 0 deletions docs/deployment-guide/goals/production/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
icon: square-dashed-circle-plus
---

Deploying the Authority Portal in Production
============

Expand Down
4 changes: 4 additions & 0 deletions docs/product/user-documentation/Administration and Support.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
icon: user
---

# Administration and Support

## Profile & Roles
Expand Down
17 changes: 17 additions & 0 deletions docs/product/user-documentation/Authority Section.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
icon: user
---

# Authority Section

## Organization management
Expand Down Expand Up @@ -45,6 +49,19 @@ The process is as follows:
Under "All Connectors", Authority Users and Admins can see all registered connectors of all organizations in the Authority Portal.
Also, the connector details can be accessed from here.

Additionally, the status of each connector is displayed, providing insights into their current operational state. Each Connector can have the following statuses:
- Online: The connector is reachable and operational.
- Offline: The connector is not reachable by the Authority Portal crawler.

Connectors of type CAAS (Connector as a Service) can also support extended operational statuses. These additional statuses provide more granular insights into the state of Connector as a Service Connectors, reflecting their dynamic and managed nature.
- Init: The connector is in the initialization process.
- Provisioning: The connector is being set up and is not yet available for use.
- Deprovisioning: The connector is being decommissioned or removed.
- Error: An issue has occurred that requires attention.
- Unknown: Connector has been deleted via other systems and no longer exists.

In rare cases, additional statuses may appear, reflecting specific scenarios or exceptions in the system's operation.

## Dashboard & Reporting

Additionally Authority Users and Admins have access to the following features on the Dashboard:
Expand Down
4 changes: 4 additions & 0 deletions docs/product/user-documentation/General Overview.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
icon: hand-wave
---

# General Overview

This guide provides a general overview of the main sections and features of the portal, helping you navigate and understand the various components available.
Expand Down
29 changes: 16 additions & 13 deletions docs/product/user-documentation/Manage Data Space components.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
icon: user
---

# Manage the Data Space components

Besides the Data Space Authority roles, there are two other application roles that are able to manage elements of the Data Space.
Expand All @@ -23,7 +27,11 @@ Currently, the Service Partner Admin role grants the following rights in additio

#### 1. View a list of provided connectors

As a Service Partner Admin a user is able to access the "Provided Connectors" page where all provided connectors are displayed.
A Service Partner Admin is able to access the "Provided Connectors" page, where all provided connectors are displayed. On this page, connectors are categorized by their types. The types of connectors include:
- Own: Connectors registered and maintained directly by the organization.
- Provided: Connectors supplied by a third-party service partner.
- CaaS: Connector as a Service - Managed connectors.
- Configure Button: The Connector needs further configuration for being set up.

![provide-connector](images/provide-connectors-overview.png)

Expand All @@ -33,20 +41,15 @@ When clicking on the button "Provide Connector" in the upper right corner a mask

![provide-connector](images/provide-connector.png)

To provide a connector in the Authority Portal all fields of the mask must be submitted. The process is identical to the registration of connectors for users without any application role but registers the connector for another organization who is named in the slightly changed registration mask.

You might generate the required certificate within the browser or alternatively via a Linux shell with `openssl` and `keytool` installed:

```bash
$ openssl req -x509 -newkey rsa:2048 -keyout key.pem -out connector-certificate.crt -nodes -days 1825
$ openssl pkcs12 -export -in connector-certificate.crt -inkey key.pem -out connector-certificate.p12
$ keytool -importkeystore -srckeystore connector-certificate.p12 -srcstoretype pkcs12 -destkeystore connector-certificate.jks
```
To provide a connector in the Authority Portal all fields of the mask must be submitted.
After clicking on the "Create Connector" the list of provided connectors appears, where an added connector can be found which has to be configured further at some point in time.

> [!TIP]
> By ticking the checkbox "Use the Connector's JWKS URL [...]", you can define a JWKS endpoint to automatically fetch the certificate from and thus skip the certificate step. sovity's CaaS (Connector-as-a-Service) are equipped with this functionality.
![provide-connector](images/provide-connectors-list.png)

After clicking on the register button the list of provided connectors appears, where the added connector can be found.
By clicking in the list on "Configure", the additional data for the connector must be entered, such as the URL at which the frontend of the connector can be accessed.
The most important entry is the connector endpoint, the DSP-endpoint, so that the connector's offers can be searched and displayed in the authority portal, since the authority portal also crawls the connectors in the dataspace for available offers which the authority portal's crawler is allowed to access.
The process of the further configuration guides you through the necessary steps and needed information to specify the URLs or enter valid information about the connector certificate.
Please follow the steps in the dialog.

#### 3. Assign Service Partner Admin role to users within own organization

Expand Down
11 changes: 11 additions & 0 deletions docs/product/user-documentation/faq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
icon: message-question
---

## Welcome to our Frequently Asked Questions (FAQ) collection!

This section is designed to provide quick and clear answers to the most common queries we receive. Whether you're looking for information on our products or services or need help with troubleshooting, you'll find the answers here. If you can't find the answer to your question, don't hesitate to open a [dicussion](https://github.com/sovity/authority-portal/discussions).

### How does the availability check for the connectors work?

The connector online status is determined and set by the catalog crawler. If the crawler can fetch the catalog, it will set the connector to ONLINE, on a failure to OFFLINE. Keep in mind that the catalog crawler only crawls connectors in the same environment as the crawler itself.
Binary file modified docs/product/user-documentation/images/provide-connector.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit f12c5e2

Please sign in to comment.