Skip to content

Commit

Permalink
docs: rebrand Authority Portal to Data Space Portal (#418)
Browse files Browse the repository at this point in the history
  • Loading branch information
tmberthold authored Feb 3, 2025
1 parent 4d12284 commit c8b1619
Show file tree
Hide file tree
Showing 14 changed files with 78 additions and 76 deletions.
12 changes: 6 additions & 6 deletions .github/ISSUE_TEMPLATE/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,15 @@ Feel free to edit this release checklist in-progress depending on what tasks nee
- [ ] Merge the `release-prep` PR.
- [ ] Wait for the main branch to be green.
- [ ] Create a release and re-use the changelog section as release description, and the version as title.
- [ ] Create a release in the [Authority Portal EE](https://github.com/sovity/authority-portal-ee) repository.
- [ ] Create a release in the [Data Space Portal EE](https://github.com/sovity/dataspace-portal-ee) repository.
- [ ] `release-prep` PR:
- [ ] Copy the [Keycloak themes](https://github.com/sovity/authority-portal/tree/main/authority-portal-keycloak) for all flavors
- [ ] Copy the [Keycloak themes](https://github.com/sovity/dataspace-portal/tree/main/authority-portal-keycloak) for all flavors
from here to the EE repository.
- [ ] Copy
the [OAuth2 proxy templates](https://github.com/sovity/authority-portal/tree/main/authority-portal-oauth2-proxy)
the [OAuth2 proxy templates](https://github.com/sovity/dataspace-portal/tree/main/authority-portal-oauth2-proxy)
from here to the EE repository.
- [ ] Copy
the [realm.json](https://github.com/sovity/authority-portal/blob/main/authority-portal-backend/authority-portal-quarkus/src/main/resources/realm.json) files for all flavors
the [realm.json](https://github.com/sovity/dataspace-portal/blob/main/authority-portal-backend/authority-portal-quarkus/src/main/resources/realm.json) files for all flavors
from here to the EE repository.
- [ ] Update the Catalog Crawler image in EE's `.env`.
- [ ] Link this release in the EE changelog.
Expand All @@ -49,6 +49,6 @@ Feel free to edit this release checklist in-progress depending on what tasks nee
- [ ] Notify the deployment team, which will send a message to the customer about the new release.
- [ ] `release-cleanup` PR:
- [ ] Revisit the changed list of tasks and compare it
with [.github/ISSUE_TEMPLATE/release.md](https://github.com/sovity/authority-portal/blob/main/.github/ISSUE_TEMPLATE/release.md).
with [.github/ISSUE_TEMPLATE/release.md](https://github.com/sovity/dataspace-portal/blob/main/.github/ISSUE_TEMPLATE/release.md).
Apply changes where it makes sense.
- [ ] Merge the `release-cleanup` PR.
- [ ] Merge the `release-cleanup` PR.
2 changes: 1 addition & 1 deletion .github/markdown-link-checker-config.jq
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
{"pattern": "https://(.*?)\\.azure\\.sovity\\.io"},
{"pattern": "http://edc[0-9]*:"},
{"pattern": "https://test-connector.hosting-environment.io"},
{"pattern": "https://github.com/sovity/authority-portal-ee"}
{"pattern": "https://github.com/sovity/dataspace-portal-ee"}
],
"replacementPatterns": [
{
Expand Down
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@
<img src="https://raw.githubusercontent.com/sovity/edc-ui/main/src/assets/images/sovity_logo.svg" alt="Logo" width="300">
</a>

<h3 align="center">Authority Portal</h3>
<h3 align="center">Data Space Portal</h3>
<p align="center" style="padding-bottom:16px">
Manage your Dataspace
Collaboration and governance for all participants
<br />
<a href="https://github.com/sovity/authority-portal/issues/new?assignees=&labels=kind%2Fbug&projects=&template=bug_report.yaml">Report Bug</a>
·
Expand All @@ -21,11 +21,13 @@ Manage your Dataspace

## About The Project

The **Authority Portal** is an open-source Software as a Service (SaaS) solution designed to streamline the management of your Dataspace. This innovative tool serves as a comprehensive Dataspace Administration Tool, offering a platform where you can seamlessly invite organizations and their users to participate in your Dataspace.
The **Data Space Portal** is an open-source Software as a Service (SaaS) solution designed to streamline the management of your Dataspace. This innovative tool serves as a comprehensive Dataspace Administration Tool, offering a platform where you can seamlessly invite organizations and their users to participate in your Dataspace.

The Authority Portal is not just about managing participants. It also provides multiple avenues to add or acquire connectors and service partners. These partners can offer their own Connector-as-a-Service (CaaS), extending the functionality and versatility of your Dataspace.
The Data Space Portal is not just about managing participants. It also provides multiple avenues to add or acquire connectors and service partners. These partners can offer their own Connector-as-a-Service (CaaS), extending the functionality and versatility of your Dataspace.

As a Dataspace administration tool, the Authority Portal necessitates technical connections with other dataspace components, including the CaaS component. This integration ensures a smooth and efficient operation, enhancing the overall user experience.
As a Dataspace administration tool, the Data Space Portal necessitates technical connections with other dataspace components, including the CaaS component. This integration ensures a smooth and efficient operation, enhancing the overall user experience.

<b>Note:</b> This component was previously known as Authority Portal (AP) and has been renamed to Data Space Portal (DSPortal). The functionality remains unchanged.

<p align="right">(<a href="#readme-top">back to top</a>)</p>

Expand Down Expand Up @@ -73,7 +75,7 @@ see [Frontend Local E2E Development](authority-portal-frontend/README.md#local-e

### Productive Deployment Guide

There is a guide on [How to deploy the Authority Portal for Production](docs/deployment-guide/goals/production/README.md) in this
There is a guide on [How to deploy the Data Space Portal for Production](docs/deployment-guide/goals/production/README.md) in this
repository.

<p align="right">(<a href="#readme-top">back to top</a>)</p>
Expand All @@ -86,6 +88,6 @@ See [`LICENSE`](./LICENSE) for more information.

## Contact

If you're interested in deploying the Authority Portal for productive use, we at sovity are ready to assist you. Our team is committed to providing the support you need to make the most of this powerful tool. Contact us today to learn more about how the Authority Portal can transform your dataspace management: contact@sovity.de
If you're interested in deploying the Data Space Portal for productive use, we at sovity are ready to assist you. Our team is committed to providing the support you need to make the most of this powerful tool. Contact us today to learn more about how the Data Space Portal can transform your dataspace management: contact@sovity.de

<p align="right">(<a href="#readme-top">back to top</a>)</p>
4 changes: 2 additions & 2 deletions authority-portal-backend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<img src="https://raw.githubusercontent.com/sovity/edc-ui/main/src/assets/images/sovity_logo.svg" alt="Logo" width="300">
</a>

<h3 align="center">Authority Portal</h3>
<h3 align="center">Data Space Portal</h3>
<p align="center" style="padding-bottom:16px">
Backend + Frontend + E2E Tests
<br />
Expand All @@ -21,7 +21,7 @@ Backend + Frontend + E2E Tests

## About This Component

Backend for the Authority Portal. Built with Quarkus, Kotlin and JOOQ.
Backend for the Data Space Portal. Built with Quarkus, Kotlin and JOOQ.

<p align="right">(<a href="#readme-top">back to top</a>)</p>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<img src="https://raw.githubusercontent.com/sovity/edc-ui/main/src/assets/images/sovity_logo.svg" alt="Logo" width="300">
</a>

<h3 align="center">Authority Portal API TypeScript Client Library</h3>
<h3 align="center">Data Space Portal API TypeScript Client Library</h3>

<p align="center">
<a href="https://github.com/sovity/authority-portal/issues/new?template=bug_report.md">Report Bug</a>
Expand All @@ -16,7 +16,7 @@

## About this component

TypeScript Client Library to access APIs of our Authority Portal Backend.
TypeScript Client Library to access APIs of our Data Space Portal Backend.

## How to install

Expand All @@ -28,7 +28,7 @@ npm i --save @sovity.de/authority-portal-client

## How to use

Configure your Authority Portal Client and use endpoints of our Authority Portal
Configure your Data Space Portal Client and use endpoints of our Data Space Portal
API:

```typescript
Expand Down
4 changes: 2 additions & 2 deletions authority-portal-backend/authority-portal-api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<img src="https://raw.githubusercontent.com/sovity/edc-ui/main/src/assets/images/sovity_logo.svg" alt="Logo" width="300">
</a>

<h3 align="center">Authority Portal API Specification</h3>
<h3 align="center">Data Space Portal API Specification</h3>

<p align="center">
<a href="https://github.com/sovity/authority-portal/issues/new?template=bug_report.md">Report Bug</a>
Expand All @@ -16,7 +16,7 @@

## About this component

Specification of Authority Portal API endpoints, for example endpoints for the Authority Portal UI.
Specification of Data Space Portal API endpoints, for example endpoints for the Data Space Portal UI.

## License

Expand Down
10 changes: 5 additions & 5 deletions authority-portal-backend/catalog-crawler/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<img src="https://raw.githubusercontent.com/sovity/edc-ui/main/src/assets/images/sovity_logo.svg" alt="Logo" width="300">
</a>

<h3 align="center">EDC-Connector Extension:<br />Catalog Crawler</h3>
<h3 align="center">Catalog Crawler</h3>

<p align="center">
<a href="https://github.com/sovity/authority-portal/issues/new?assignees=&labels=kind%2Fbug&projects=&template=bug_report.yaml">Report Bug</a>
Expand All @@ -19,14 +19,14 @@
The Catalog Crawler is an additional deployment unit needed to determine the online status of registered connectors and populate the Data Catalog:

- It is a modified EDC connector with the task to crawl the other connectors' public data offers.
- It periodically checks the Authority Portal's connector list for its environment.
- It periodically checks the Data Space Portal's connector list for its environment.
- It crawls the given connectors in regular intervals.
- It writes the data offers and connector statuses into the Authority Portal DB.
- Each environment configured in the Authority Portal requires its own Catalog Crawler with credentials for that environment's DAPS.
- It writes the data offers and connector statuses into the Data Space Portal DB.
- Each environment configured in the Data Space Portal requires its own Catalog Crawler with credentials for that environment's DAPS.

## Why does this component exist?

The Authority Portal uses a non-EDC stack and thus it cannot read the catalogs of participating connectors directly.
The Data Space Portal uses a non-EDC stack and thus it cannot read the catalogs of participating connectors directly.

## Deployment

Expand Down
6 changes: 3 additions & 3 deletions authority-portal-frontend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@
<img src="https://raw.githubusercontent.com/sovity/edc-ui/main/src/assets/images/sovity_logo.svg" alt="Logo" width="300">
</a>

<h3 align="center">Authority Portal</h3>
<h3 align="center">Data Space Portal</h3>

<p align="center">
Frontend (UI) of Authority Portal
Frontend (UI) of Data Space Portal
<br />
<a href="https://github.com/sovity/authority-portal/issues">Report Bug</a>
·
Expand Down Expand Up @@ -52,7 +52,7 @@

## About This Component

Frontend for sovity's Dataspace Authority Portal, written in Angular with
Frontend for sovity's Dataspace Data Space Portal, written in Angular with
TypeScript, NGXS State Management and TailwindCSS Framework.

<p align="right">(<a href="#readme-top">back to top</a>)
Expand Down
8 changes: 4 additions & 4 deletions authority-portal-keycloak/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<br />
<div align="center">

<h3 align="center">Authority Portal</h3>
<h3 align="center">Data Space Portal</h3>
<p align="center" style="padding-bottom:16px">
Custom Keycloak Theme
<br />
Expand All @@ -21,11 +21,11 @@ An MDS-Themed Kecyloak.

## Why does this component exist?

The Authority Portal uses the Keycloak Login Page. This is due to identity federation and SSO.
The Data Space Portal uses the Keycloak Login Page. This is due to identity federation and SSO.

For consistency, the MDS wanted a custom theming.

Registration processes, however, will be fully handled by the Authority Portal.
Registration processes, however, will be fully handled by the Data Space Portal.

<p align="right">(<a href="#readme-top">back to top</a>)</p>

Expand All @@ -39,4 +39,4 @@ See [`LICENSE`](../LICENSE) for more information.

contact@sovity.de

<p align="right">(<a href="#readme-top">back to top</a>)</p>
<p align="right">(<a href="#readme-top">back to top</a>)</p>
4 changes: 2 additions & 2 deletions authority-portal-oauth2-proxy/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<br />
<div align="center">

<h3 align="center">Authority Portal</h3>
<h3 align="center">Data Space Portal</h3>
<p align="center" style="padding-bottom:16px">
Custom OAuth2 proxy templates
<br />
Expand Down Expand Up @@ -35,4 +35,4 @@ See [`LICENSE`](../LICENSE) for more information.

contact@sovity.de

<p align="right">(<a href="#readme-top">back to top</a>)</p>
<p align="right">(<a href="#readme-top">back to top</a>)</p>
Loading

0 comments on commit c8b1619

Please sign in to comment.