Skip to content

Commit

Permalink
docs: move developer directory into docs (#226)
Browse files Browse the repository at this point in the history
- move developer into docs directory and enable docs app
- move helper user docs into user user directory and enable docs app
- move pen test information to Tests.md
- update test automation docs
- remove obsolete version files
  • Loading branch information
evegufy authored Jan 18, 2024
1 parent 1e0a051 commit 7890974
Show file tree
Hide file tree
Showing 313 changed files with 2,411 additions and 14,565 deletions.
1 change: 0 additions & 1 deletion .eslintignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,2 @@
**/public/documentation/js/lib
**/developer
**/docs
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Link to Github issue.

Please delete options that are not relevant.

- [ ] I have followed the [contributing guidelines](https://github.com/eclipse-tractusx/portal-assets/blob/main/developer/Technical%20Documentation/Dev%20Process/How%20to%20contribute.md#commit-and-pr-guidelines)
- [ ] I have followed the [contributing guidelines](https://github.com/eclipse-tractusx/portal-assets/blob/main/docs/developer/Technical%20Documentation/Dev%20Process/How%20to%20contribute.md#commit-and-pr-guidelines)
- [ ] I have performed [IP checks](https://eclipse-tractusx.github.io/docs/release/trg-7/trg-7-04#checking-libraries-using-the-eclipse-dash-license-tool) for added or updated 3rd party libraries
- [ ] I have created and linked IP issues or requested their creation by a committer
- [ ] I have added copyright and license headers, footers (for .md files) or files (for images)
Expand Down
34 changes: 0 additions & 34 deletions developer/Technical Documentation/Operations/Tests.md

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
The last step of the company application is the verification of the data. The user can revalidate if al data are correctly added. In case anything is wrong or missing, the "back" button will support to update any entered data.
<br>

Link Functional Details: [Click here](/docs/01.%20Onboarding/02.%20Registration/06.%20Verify%20Registration%20Data.md)
Link Functional Details: [Click here](/docs/user/01.%20Onboarding/02.%20Registration/06.%20Verify%20Registration%20Data.md)

<br>
<br>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<img width="613" alt="image" src="https://github.com/catenax-ng/tx-portal-assets/assets/94133633/67fb1a76-2cfe-48c1-9630-cdaefd655718">
</p>

Functional Link: [Link](/docs/02.%20Technical%20Integration/02.%20Identity%20Provider%20Management/02.%20Company%20IdPs.md)
Functional Link: [Link](/docs/user/02.%20Technical%20Integration/02.%20Identity%20Provider%20Management/02.%20Company%20IdPs.md)

### Implementation

Expand Down Expand Up @@ -94,9 +94,9 @@ add inside the response body the identity_provider_type (please use the "label"

Connected Functions:

- [Configure Company](/developer/02.%20Technical%20Integration/02.%20Identity%20Provider%20Management/02.%20Configure%20Company%20IdP.md)
- [User Migration New IdP](/developer/02.%20Technical%20Integration/02.%20Identity%20Provider%20Management/03.%20User%20Migration.md)
- [User Migration New IdP](/developer/02.%20Technical%20Integration/02.%20Identity%20Provider%20Management/04.%20Delete%20Identity%20Provider.md)
- [Configure Company](/docs/developer/02.%20Technical%20Integration/02.%20Identity%20Provider%20Management/02.%20Configure%20Company%20IdP.md)
- [User Migration New IdP](/docs/developer/02.%20Technical%20Integration/02.%20Identity%20Provider%20Management/03.%20User%20Migration.md)
- [User Migration New IdP](/docs/developer/02.%20Technical%20Integration/02.%20Identity%20Provider%20Management/04.%20Delete%20Identity%20Provider.md)

## NOTICE

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## IDP Configuration

Functional Link: [Link](/docs/02.%20Technical%20Integration/02.%20Identity%20Provider%20Management/02.%20Configure%20Company%20IdP.md)
Functional Link: [Link](/docs/user/02.%20Technical%20Integration/02.%20Identity%20Provider%20Management/02.%20Configure%20Company%20IdP.md)

<br>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ With the configuration of a new IdP, existing user accounts should not get lost.
For the migration of additional existing user accounts, which have been created under the shared IdP previously, the administrator can call the user migration list via the IdP config page.
<br>

Functional Details: [Here](/docs/02.%20Technical%20Integration/02.%20Identity%20Provider%20Management/03.%20User%20Migration.md)
Functional Details: [Here](/docs/user/02.%20Technical%20Integration/02.%20Identity%20Provider%20Management/03.%20User%20Migration.md)

<br>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

<br>

Functional Connection: [Link](/docs/02.%20Technical%20Integration/02.%20Identity%20Provider%20Management/04.%20Identity%20Provider%20Deletion.md)
Functional Connection: [Link](/docs/user/02.%20Technical%20Integration/02.%20Identity%20Provider%20Management/04.%20Identity%20Provider%20Deletion.md)

<br>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

<br>

Functional Connection: [Link](/docs/02.%20Technical%20Integration/02.%20Identity%20Provider%20Management/05.%20Disable%20Identity%20Provider.md)
Functional Connection: [Link](/docs/user/02.%20Technical%20Integration/02.%20Identity%20Provider%20Management/05.%20Disable%20Identity%20Provider.md)

<br>

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
### Change Company Role

[Functional Description](/docs/02.%20Technical%20Integration/05.%20Company%20Role/Change%20Company%20Role.md)
[Functional Description](/docs/user/02.%20Technical%20Integration/05.%20Company%20Role/Change%20Company%20Role.md)

<br>
<br>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
The use case participation page is created to enable data provider/consumer and solution providers to view their use case participation and to request the participation for new use cases.
The use case participation is a verified credential which is stored on the company wallet which generates trust and liability in the network. The company signing the framework agrees to the use case date sharing rules.

Functional Description: [here](/docs/06.%20Certificates/01.%20UseCase%20Participation.md)
Functional Description: [here](/docs/user/06.%20Certificates/01.%20UseCase%20Participation.md)

<br>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Currently Supported:

<br>

Functional Description: [here](/docs/06.%20Certificates/02.%20Other%20Certificates.md)
Functional Description: [here](/docs/user/06.%20Certificates/02.%20Other%20Certificates.md)

<br>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The administrator can:

<br>

Link to functional details: [Click here](./docs/06.%20Certificates/03.%20Credential%20Admin%20Board.md)
Link to functional details: [Click here](./docs/user/06.%20Certificates/03.%20Credential%20Admin%20Board.md)

<br>
<br>
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: https://github.com/catenax-ng/tx-portal-assets/blob/945546d91065b8870aa8f69ce94b48eac7a5ade2/docs/Technical%20Details/Auditing.md
More details to the audit logging can get found here: https://github.com/catenax-ng/tx-portal-assets/blob/945546d91065b8870aa8f69ce94b48eac7a5ade2/docs/user/Technical%20Details/Auditing.md

### Own User Deletion Flow

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This might be relevant if the credentials are getting old/long used already, due

<br>

Functional Description: [Click here](/docs/03.%20User%20Management/03.%20Technical%20User/04.%20Reset%20Credentials.md)
Functional Description: [Click here](/docs/user/03.%20User%20Management/03.%20Technical%20User/04.%20Reset%20Credentials.md)

<br>

Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@

Links:

[Design](</docs/App(s)/Marketplace/Design.md>)
[FAQ](</docs/App(s)/Marketplace/FAQ.md>)
[Design](</docs/user/App(s)/Marketplace/Design.md>)
[FAQ](</docs/user/App(s)/Marketplace/FAQ.md>)

<br>
<br>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@

Links:

[Design](</docs/App(s)/Marketplace/Design.md>)
[FAQ](</docs/App(s)/Marketplace/FAQ.md>)
[Design](</docs/user/App(s)/Marketplace/Design.md>)
[FAQ](</docs/user/App(s)/Marketplace/FAQ.md>)

<br>
<br>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@

Links:

[Design](</docs/App(s)/Marketplace/Design.md>)
[FAQ](</docs/App(s)/Marketplace/FAQ.md>)
[Design](</docs/user/App(s)/Marketplace/Design.md>)
[FAQ](</docs/user/App(s)/Marketplace/FAQ.md>)

<br>
<br>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@

Links:

[Design](</docs/App(s)/Marketplace/Design.md>)
[FAQ](</docs/App(s)/Marketplace/FAQ.md>)
[Design](</docs/user/App(s)/Marketplace/Design.md>)
[FAQ](</docs/user/App(s)/Marketplace/FAQ.md>)

<br>
<br>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ The page includes following functions

Links:

[Design](</docs/04.%20App(s)/05.%20App%20Subscription/03.%20Subscription%20Overview%20(App%20Provider).md>)
[FAQ](</docs/04.%20App(s)/05.%20App%20Subscription/05.%20FAQ.md>)
[Design](</docs/user/04.%20App(s)/05.%20App%20Subscription/03.%20Subscription%20Overview%20(App%20Provider).md>)
[FAQ](</docs/user/04.%20App(s)/05.%20App%20Subscription/05.%20FAQ.md>)

<br>
<br>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@
To activate a customer subscription request, the /autosetup endpoint is provided to autosetup the app client, create relevant technical users and activate the app for the customer.
<br>
The activation will allow the customer company to assign the app user roles to existing user accounts. With the assigned roles, the respective users will find the app inside the "My Business App" feature on the home page.
=> details to "My Business Apps" can be found [here](</docs/04.%20App(s)/01.%20Marketplace/04.%20My%20Business%20Apps.md>)
=> details to "My Business Apps" can be found [here](</docs/user/04.%20App(s)/01.%20Marketplace/04.%20My%20Business%20Apps.md>)

<br>
<br>

Links:

[EndUser Docu](</docs/04.%20App(s)/05.%20App%20Subscription/04.%20Subscription%20Activation%20(App%20Provider).md>)
[FAQ](</docs/04.%20App(s)/05.%20App%20Subscription/05.%20FAQ.md>)
[EndUser Docu](</docs/user/04.%20App(s)/05.%20App%20Subscription/04.%20Subscription%20Activation%20(App%20Provider).md>)
[FAQ](</docs/user/04.%20App(s)/05.%20App%20Subscription/05.%20FAQ.md>)

<br>
<br>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Enable customers of an app to unsubscribe the active subscription.
With the unsubscription connected objects (see details below) are getting inactivated as well.

[Functional Description](</docs/04.%20App(s)/05.%20App%20Subscription/05.%20App%20Unsubscribe.md>)
[Functional Description](</docs/user/04.%20App(s)/05.%20App%20Subscription/05.%20App%20Unsubscribe.md>)

<br>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ On purpose, the change scenarios are kept limited for the first release of "app
<br>
<br>

Functional Details: [click here](</docs/04.%20App(s)/06.%20App%20Change%20Process/01.%20Summary.md>)
Functional Details: [click here](</docs/user/04.%20App(s)/06.%20App%20Change%20Process/01.%20Summary.md>)

<br>
<br>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ App Providers can adjust the app lead image via the "App Overview" page.
The change has direct impact on the app card displayed on the marketplace as well as the app detail page and other connected pages where the lead image is fetched.
Please note that a delay of displaying the new lead image could appear, in case a longer cache hold of the image is configured.

Functional Description: [click](</docs/04.%20App(s)/06.%20App%20Change%20Process/02.%20Change%20App%20Lead%20Image.md>)
Functional Description: [click](</docs/user/04.%20App(s)/06.%20App%20Change%20Process/02.%20Change%20App%20Lead%20Image.md>)

<br>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Inside the board all active subscriptions can get viewed and filtered. Select th

<br>

Functional Description: [Link](</docs/04.%20App(s)/06.%20App%20Change%20Process/03.%20Change%20App%20Tenant%20URL.md>)
Functional Description: [Link](</docs/user/04.%20App(s)/06.%20App%20Change%20Process/03.%20Change%20App%20Tenant%20URL.md>)

<br>
<br>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
App Providers can adjust the app description (short and long) via the "App Overview" page.
The change has direct impact on the app details displayed in the marketplace other connected pages where the app description is used/displayed.

Functional Description: [click](<./docs/04.%20App(s)/06.%20App%20Change%20Process/03.%20Change%20App%20Description.md>)
Functional Description: [click](<./docs/user/04.%20App(s)/06.%20App%20Change%20Process/03.%20Change%20App%20Description.md>)

<br>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Inside the board all active subscriptions can get viewed and filtered. Select th

<br>

Functional Description: [Link](</docs/04.%20App(s)/06.%20App%20Change%20Process/03.%20Change%20App%20Tenant%20URL.md>)
Functional Description: [Link](</docs/user/04.%20App(s)/06.%20App%20Change%20Process/03.%20Change%20App%20Tenant%20URL.md>)

<br>
<br>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
App Providers can adjust the app roles via the "App Overview" page.
The change has direct impact on the marketplace offer as well as active subscriptions.

Functional Description: [click](</docs/04.%20App(s)/06.%20App%20Change%20Process/06.%20Change%20App%20RolesL.md>)
Functional Description: [click](</docs/user/04.%20App(s)/06.%20App%20Change%20Process/06.%20Change%20App%20RolesL.md>)

<br>

Expand Down Expand Up @@ -76,7 +76,7 @@ Request Body

### Connected Implementations

- Notification - [click](/developer/Technical%20Documentation/Others/Notifications.md#offer-change-process)
- Notification - [click](/docs/developer/Technical%20Documentation/Others/Notifications.md#offer-change-process)

<br>
<br>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ Beside the generic list, services can get viewed in specific pre-configured view

Links:

- [Functional Description](</docs/05.%20Service(s)/Service%20Marketplace/01.%20Service%20Marketplace.md>)
- [FAQ](</docs/05.%Service(s)/01.%Marketplace/FAQ.md>)
- [Functional Description](</docs/user/05.%20Service(s)/Service%20Marketplace/01.%20Service%20Marketplace.md>)
- [FAQ](</docs/user/05.%Service(s)/01.%Marketplace/FAQ.md>)

<br>
<br>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ Beside the generic list, services can get viewed in specific pre-configured view

Links:

- [Functional Description](</docs/05.%20Service(s)/01.%20Service%20Marketplace/02.%20Service%20Details.md>)
- [FAQ](</docs/05.%Service(s)/01.%Marketplace/FAQ.md>)
- [Functional Description](</docs/user/05.%20Service(s)/01.%20Service%20Marketplace/02.%20Service%20Details.md>)
- [FAQ](</docs/user/05.%Service(s)/01.%Marketplace/FAQ.md>)

<br>
<br>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Till that, the service publication is only available via api endpoints. Users ca
Links:

- [Functional Description]()
- [FAQ](</docs/05.%20Service(s)/01.%20Service%20Release%20Process/02.%20FAQ.md>)
- [FAQ](</docs/user/05.%20Service(s)/01.%20Service%20Release%20Process/02.%20FAQ.md>)

<br>
<br>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ Service purchasing is describing the subscribe/purchase process of an service in

Links:

[EndUser Docu](</docs/05.%20Service(s)/03.%20Service%20Subscription/03.%20Service%20Subscription%20Activation%20(Provider).md>)
[FAQ](</docs/05.%20Service(s)/03.%20Service%20Subscription/05.%20FAQ.md>)
[EndUser Docu](</docs/user/05.%20Service(s)/03.%20Service%20Subscription/03.%20Service%20Subscription%20Activation%20(Provider).md>)
[FAQ](</docs/user/05.%20Service(s)/03.%20Service%20Subscription/05.%20FAQ.md>)

<br>
<br>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ The page includes following functions

Links:

[Design](</docs/05.%20Service(s)/03.%20Service%20Subscription/03.%20Subscription%20Overview%20(Provider).md>)
[FAQ](</docs/05.%20Service(s)/03.%20Service%20Subscription/05.%20FAQ.md>)
[Design](</docs/user/05.%20Service(s)/03.%20Service%20Subscription/03.%20Subscription%20Overview%20(Provider).md>)
[FAQ](</docs/user/05.%20Service(s)/03.%20Service%20Subscription/05.%20FAQ.md>)

<br>
<br>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@

Links:

[EndUser Docu](</docs/05.%20Service(s)/03.%20Service%20Subscription/03.%20Service%20Subscription%20Activation%20(Provider).md>)
[FAQ](</docs/05.%20Service(s)/03.%20Service%20Subscription/05.%20FAQ.md>)
[EndUser Docu](</docs/user/05.%20Service(s)/03.%20Service%20Subscription/03.%20Service%20Subscription%20Activation%20(Provider).md>)
[FAQ](</docs/user/05.%20Service(s)/03.%20Service%20Subscription/05.%20FAQ.md>)

<br>
<br>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Enable customers of an app to unsubscribe the active subscription.
With the unsubscription connected objects (see details below) are getting inactivated as well.

[Functional Description](</docs/05.%20Service(s)/03.%20Service%20Subscription/04.%20Service%20Unsubscribe.md>)
[Functional Description](</docs/user/05.%20Service(s)/03.%20Service%20Subscription/04.%20Service%20Unsubscribe.md>)

<br>
<br>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This feature gives users the power to control their own offers and allows them t

<br>

Functional Details: [click here](</docs/05.%20Service(s)/05.%20Service%20Change%20Process/02.%20Service%20Deactivation.md>)
Functional Details: [click here](</docs/user/05.%20Service(s)/05.%20Service%20Change%20Process/02.%20Service%20Deactivation.md>)

<br>

Expand Down
Loading

0 comments on commit 7890974

Please sign in to comment.