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

docs: organise as TRG folder structure #428

Merged
merged 6 commits into from
Nov 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The Portal application consists of

The helm chart for installing the Portal is available in the [portal](https://github.com/eclipse-tractusx/portal) repository.

Please refer to the [docs](./docs/) directory for the overarching user and developer documentation of the Portal application.
Please refer to the [docs](./docs/) directory for the overarching documentation of the Portal application.

The Portal is designed to work with the [IAM](https://github.com/eclipse-tractusx/portal-iam).

Expand Down
17 changes: 17 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
### Portal Documentation

The documentation of the Catena-X Portal. Refer to the different sections:

- [Administration](./admin/)
- [API](./api/)
- [Architecture](./architecture/)
- [Developer](./developer/)
- [User](./user/)

## NOTICE

This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).

- SPDX-License-Identifier: Apache-2.0
- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation
- Source URL: https://github.com/eclipse-tractusx/portal-assets
20 changes: 20 additions & 0 deletions docs/admin/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
### Administration

Sections

- [DB Views and Details](./DB%20Views%20and%20Details/)
- [Development Process](./Dev%20Process/)
- [Interface Contracts](./Interface%20Contracts/)
- [Operations](./Operations/)
- [Operator Wallet Setup](./Operator%20Wallet%20Setup/)
- [Others](./Others/)
- [Tests](./Tests/)
- [Version Upgrade](./Version%20Upgrade/)

## NOTICE

This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).

- SPDX-License-Identifier: Apache-2.0
- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation
- Source URL: https://github.com/eclipse-tractusx/portal-assets
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Interface Partner Health Check

Interface partner health/availability checks run
with [a specific technical user for technical tests](../../03.%20User%20Management/03.%20Technical%20User/01.%20Summary.md)
with [a specific technical user for technical tests](/docs/user/03.%20User%20Management/03.%20Technical%20User/01.%20Summary.md)
and now is implemented for

- [BPDM](#BPDM)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ gantt

```

As outlined in the [Security Policy](../../../SECURITY.md), the findings are documented as security advisories.
As outlined in the [Security Policy](/SECURITY.md), the findings are documented as security advisories.

<br>
<br>
Expand Down
11 changes: 11 additions & 0 deletions docs/api/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
### API

Please refer to the `docs/api` directory of the [portal-backend repository](https://github.com/eclipse-tractusx/portal-backend) or the [API Hub](https://eclipse-tractusx.github.io/api-hub/portal-backend) for the respective version you are interested in.

## NOTICE

This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).

- SPDX-License-Identifier: Apache-2.0
- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation
- Source URL: https://github.com/eclipse-tractusx/portal-assets
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@

Details to the build, test and deploy process can be found in the following files:

- [Release Process](../Operations/Release-Process.md)
- [Tests](../Tests/Tests.md)
- [Release Process](/docs/admin/Operations/Release-Process.md)
- [Tests](/docs/admin/Tests/Tests.md)
<br>
<br>

Expand Down
21 changes: 21 additions & 0 deletions docs/architecture/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
### Architecture

Sections

- [Architecture Constraints](./Architecture%20Constraints.md)
- [Building Block View](./Building%20block%20view.md)
- [Context and Scope](./Context%20and%20scope.md)
- [Development Concept](./Development%20Concept.md)
- [Requirements](./Requirements.md)
- [Operational Concept](./operational-concept.md)
- [Security Assessment](./Security-Assessment.md)
- [Solution Strategy](./Solution%20strategy.md)
- [Whitebox Overall System](./Whitebox%20Overall%20System.md)

## NOTICE

This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).

- SPDX-License-Identifier: Apache-2.0
- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation
- Source URL: https://github.com/eclipse-tractusx/portal-assets
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ All threats identified are mitigated.
- Infrastructure as Code - KICS
- Securing code, dependencies, containers, IaC and Cloud Deployments - SNYK

Also see [Penetrations Tests](../Tests/Tests.md#penetration-tests).
Also see [Penetrations Tests](/docs/admin/Tests/Tests.md#penetration-tests).

## NOTICE

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Note: will be added soon

## Logging

The portal supports application and db logging. Details are stored here: [Auditing](../Operations/Auditing.md).
The portal supports application and db logging. Details are stored here: [Auditing](/docs/admin/Operations/Auditing.md).

## Monitoring

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ User accounts might be companyIdP federated or CX user accounts. In both scenari

The deletion of users is audit relevant and will be audit logged inside the db.

More details to the audit logging can get found here: [Audit Log Details](/docs/developer/Technical%20Documentation/Operations/Auditing.md)
More details to the audit logging can get found here: [Audit Log Details](/docs/admin/Operations/Auditing.md)

### Own User Deletion Flow

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ The process step `FINISH_SELF_DESCRIPTION_LP` is only triggered via the api `POS

### ACTIVATE_APPLICATION

In the process step `ACTIVATE_APPLICATION` the users of the onboarded company will be assigned with the correct roles for the portal as well as the bpn mapper in the central idp. After that the theme is set for the shared realm. The company application is set to active and the company is set to active. If it is an external company application, an `TRIGGER_CALLBACK_OSP_APPROVED` is created. All company admins will than be notified via the notification logic in the portal. And for the same users a [mail process](../Process%20Workers/mailing.md) is created.
In the process step `ACTIVATE_APPLICATION` the users of the onboarded company will be assigned with the correct roles for the portal as well as the bpn mapper in the central idp. After that the theme is set for the shared realm. The company application is set to active and the company is set to active. If it is an external company application, an `TRIGGER_CALLBACK_OSP_APPROVED` is created. All company admins will than be notified via the notification logic in the portal. And for the same users a [mail process](/docs/user/Process%20Workers/mailing.md) is created.

## Retrigger

Expand Down
16 changes: 8 additions & 8 deletions docs/developer/09. Process Workers/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@ The main process worker project is the `Processes.Worker` which runs all the pro

The process worker supports the following processes:

- [ApplicationChecklist](../09.%20Process%20Workers/01.%20application_checklist.md) - handles the registration process for a new company
- [DIMUserCreation](../09.%20Process%20Workers/02.%20dim_user_creation.md) - handles the creation of technical users in the DIM middle layer
- [IdentityProviderProvisioning](../09.%20Process%20Workers/03.%20identity_provider_provisioning.md) - cleans up an identity provider
- [Invitation](../09.%20Process%20Workers/04.%20invitation.md) - handles the invitation of new users
- [Mailing](../09.%20Process%20Workers/05.%20mailing.md) - handles the mail sending
- [NetworkRegistration](../09.%20Process%20Workers/06.%20network_registration.md) - handles the osp registration
- [OfferSubscription](../09.%20Process%20Workers/07.%20offer_subscription.md) - handles the subscription and automatic activation for an offer
- [UserProvisioning](../09.%20Process%20Workers/08.%20user_provisioning.md) - handles the cleanup of users
- [ApplicationChecklist](/docs/developer/09.%20Process%20Workers/01.%20application_checklist.md) - handles the registration process for a new company
- [DIMUserCreation](/docs/developer/09.%20Process%20Workers/02.%20dim_user_creation.md) - handles the creation of technical users in the DIM middle layer
- [IdentityProviderProvisioning](/docs/developer/09.%20Process%20Workers/03.%20identity_provider_provisioning.md) - cleans up an identity provider
- [Invitation](/docs/developer/09.%20Process%20Workers/04.%20invitation.md) - handles the invitation of new users
- [Mailing](/docs/developer/09.%20Process%20Workers/05.%20mailing.md) - handles the mail sending
- [NetworkRegistration](/docs/developer/09.%20Process%20Workers/06.%20network_registration.md) - handles the osp registration
- [OfferSubscription](/docs/developer/09.%20Process%20Workers/07.%20offer_subscription.md) - handles the subscription and automatic activation for an offer
- [UserProvisioning](/docs/developer/09.%20Process%20Workers/08.%20user_provisioning.md) - handles the cleanup of users

## Retriggering

Expand Down
2 changes: 1 addition & 1 deletion docs/developer/10. Disable Clearinghouse SD/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The result is a high dependency in the registration flow on the clearinghouse co

This enables the process to be finished, and the customer to proceed with their journey without sacrificing the details in the long run. Due to the implementation of a retrigger process, the data quality is ensured, and the skipped SD information is recreated at a later stage.

- [Use Case Diagrams](../10.%20Disable%20Clearinghouse%20SD/Use-Case-Diagrams.md)
- [Use Case Diagrams](/docs/developer/10.%20Disable%20Clearinghouse%20SD/Use-Case-Diagrams.md)

## NOTICE

Expand Down
23 changes: 23 additions & 0 deletions docs/developer/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
### Developer

Sections

- [Personas](./00.%20Personas/)
- [Registration](./01.%20Registration/)
- [Identity](./02.%20Identity/)
- [Technical Integration](./02.%20Technical%20Integration/)
- [User Management](./03.%20User%20Management/)
- [Apps](./04.%20Apps/)
- [Service(s)](<./05.%20Service(s)/>)
- [Credential Management](./07.%20Credential%20Management/)
- [Certificate Management](./08.%20Certificate%20Management/)
- [Process Workers](./09.%20Process%20Workers/)
- [Disable Clearinghouse SD](./10.%20Disable%20Clearinghouse%20SD/)

## NOTICE

This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).

- SPDX-License-Identifier: Apache-2.0
- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation
- Source URL: https://github.com/eclipse-tractusx/portal-assets
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ User accounts might be companyIdP federated or CX user accounts. In both scenari

The deletion of users is audit relevant and will be audit logged inside the db.

More details to the audit logging can get found here: [Audit Log Details](/docs/developer/Technical%20Documentation/Operations/Auditing.md)
More details to the audit logging can get found here: [Audit Log Details](/docs/admin/Operations/Auditing.md)
<br>
<br>

Expand Down
24 changes: 24 additions & 0 deletions docs/user/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
### User

Sections

- [Personas](./00.%20Personas/)
- [Onboarding](./01.%20Onboarding/)
- [Identity](./02.%20Identity/)
- [Technical Integration](./02.%20Technical%20Integration/)
- [User Management](./03.%20User%20Management/)
- [App(s)](<./04.%20App(s)/>)
- [Service(s)](<./05.%20Service(s)/>)
- [Notifications](./06.%20Notifications/)
- [Credential Management](./07.%20Credential%20Management/)
- [Certificate Management](./08.%20Certificate%20Management/)
- [Others](./09.%20Others/)
- [Style Guide](./Style-Guide/)

## NOTICE

This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).

- SPDX-License-Identifier: Apache-2.0
- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation
- Source URL: https://github.com/eclipse-tractusx/portal-assets
Loading