Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Provide details on the different "Type" #407

Closed
AbdullahMuk opened this issue Jan 7, 2025 · 3 comments · Fixed by #409
Closed

Provide details on the different "Type" #407

AbdullahMuk opened this issue Jan 7, 2025 · 3 comments · Fixed by #409
Assignees
Labels
task/documentation Improvements or additions to documentation

Comments

@AbdullahMuk
Copy link
Collaborator

Description

Make it easy for user to understand the different "Type" that exist on the AP Page "Provided Connectors" (Under "Service Partner Section")

Current Documentation

  1. https://ap.docs.sovity.de/user-guide/authority-section
  2. https://ap.docs.sovity.de/user-guide/manage-data-space-components

Proposed Changes

  1. on https://ap.docs.sovity.de/user-guide/authority-section, under the section "Connector overview", create a subsection and list down the "type" users can expect.
  2. on https://ap.docs.sovity.de/user-guide/manage-data-space-components, create a section called "Connector Overview" -> create a subsection and list down the "type" users can expect.

Justification

improvements needed for clarity

Additional Context

Deadline

Notes

@AbdullahMuk AbdullahMuk added the task/documentation Improvements or additions to documentation label Jan 7, 2025
@AbdullahMuk
Copy link
Collaborator Author

@tmberthold please take care of this documentation enhancement. please talk to @kamilczaja to get insights on the different "Type". thank you!

@tmberthold
Copy link
Contributor

Note for myself:

Possible connector status:

  • Online, Running, Init, Provisioning, AwaitingRunning, Deprovisioning, AwaitingStopped, Offline, Stopped, Error, NotFound, Dead, Unknown

https://github.com/sovity/authority-portal/blob/41340c13168a778b0d09b402162f91dbbf894180/authority-portal-frontend/src/app/core/utils/ui-utils.ts#L71

Possible Connector types:

  • Own, Provided, Caas, Configuring

https://github.com/sovity/authority-portal/blob/41340c13168a778b0d09b402162f91dbbf894180/authority-portal-frontend/src/app/core/utils/ui-utils.ts#L56

@kamilczaja
Copy link
Collaborator

kamilczaja commented Jan 7, 2025

Note for myself:

Possible connector status:

  • Online, Running, Init, Provisioning, AwaitingRunning, Deprovisioning, AwaitingStopped, Offline, Stopped, Error, NotFound, Dead, Unknown

authority-portal/authority-portal-frontend/src/app/core/utils/ui-utils.ts

Line 71 in 41340c1

export const getConnectorStatusOuterRingClasses = (
Possible Connector types:

  • Own, Provided, Caas, Configuring

authority-portal/authority-portal-frontend/src/app/core/utils/ui-utils.ts

Line 56 in 41340c1

export const getConnectorsTypeClasses = (status: ConnectorTypeDto): string => {

  • "Dead" is not showing in the UI & is not exposed to the API.
  • Only connectors of type "CAAS" can have online statuses other than "Online"/"Offline"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
task/documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants