From 7890974cfed6beb559987d46a808b3b570d0c2f2 Mon Sep 17 00:00:00 2001 From: Evelyn Gurschler Date: Thu, 18 Jan 2024 16:19:10 +0100 Subject: [PATCH] docs: move developer directory into docs (#226) - 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 --- .eslintignore | 1 - .github/pull_request_template.md | 2 +- .../Operations/Tests.md | 34 - .../01. Onboarding/01. Invite/01. Summary.md | 0 .../02. Overview Invited Companies.md | 0 .../03. Invite Company_Create Application.md | 0 .../02. Registration/01. Login.md | 0 .../02. Registration/02. Add Company Data.md | 0 .../03. Add Additional Users.md | 0 .../04. Company Role & Consent.md | 0 .../02. Registration/05. Document Upload.md | 0 .../06. Verify Registration Data.md | 2 +- .../02. Registration/07. Error Scenarios.md | 0 .../02. View Company Application(s).md | 0 .../03. Registration Approval Process.md | 0 .../04. Decline Application.md | 0 .../03. Registration Approval/index.md | 0 .../01. Connector Registration/01. Summary.md | 0 .../02. View Connector.md | 0 .../03. Create new Connector Registration.md | 0 .../05. Self Description.md | 0 .../06. Delete Connector.md | 0 .../07. Error Handling.md | 0 .../01. Summary.md | 0 .../02. Company IdPs.md | 8 +- .../02. Configure Company IdP.md | 2 +- .../03. User Migration.md | 2 +- .../04. Delete Identity Provider.md | 2 +- .../04. FAQ.md | 0 .../05. Disable Identity Provider.md | 2 +- .../03. Company Configuration/01. Summary.md | 0 .../02. View Preferred Use Cases.md | 0 .../03. Add new Use Case.md | 0 .../04. Delete Preferred Use Case.md | 0 .../05. Change Company Role.md | 2 +- .../04. Credentials/00. Wallet Creation.md | 0 .../01. Get UseCase Credential.md | 2 +- .../04. Credentials/02. Other Certificates.md | 2 +- .../03. Credential Admin Board.md | 2 +- .../01. User Account/01. Summary.md | 0 .../01. User Account/02. My User Account.md | 0 .../01. User Account/02. User Account.md | 0 ...w user account (single) - UPDATE NEEDED.md | 0 ...new user account (bulk) - UPDATE NEEDED.md | 0 .../02. Edit User Account/01. Summary.md | 0 .../02. Password Reset.md | 0 .../03. User Permissions.md | 0 .../04. Manage user assigned BPN.md | 0 .../02. Edit User Account/05. Suspend User.md | 0 .../02. Edit User Account/06. Delete User.md | 2 +- .../02. Edit User Account/index.md | 0 .../03. Technical User/01. Summary.md | 0 .../02. View Technical Users.md | 0 .../03. Create Technical User.md | 0 .../04. Delete Technical User.md | 0 .../04. Reset Credentials.md | 2 +- .../03. Technical User/05. FAQ.md | 0 .../04. App Access Management/01. Summary.md | 0 .../02. Assign App Role Page Overview.md | 0 .../03. Assign App Role.md | 0 .../developer}/03. User Management/index.md | 0 .../01. Marketplace/01. App Overview.md | 4 +- .../01. Marketplace/02. App Details.md | 4 +- .../01. Marketplace/03. App Favorites.md | 4 +- .../01. Marketplace/04. My Business Apps.md | 4 +- .../02. App Release Process/04. Delete App.md | 0 .../App Release Process.md | 0 .../01. App Approval Board Overview.md | 0 .../02. App Details.md | 0 .../03. Approve App Release.md | 0 .../04. Decline App Release.md | 0 .../01. App Board.md | 0 .../01. Subscription Flow.md | 0 .../01.App Subscription Request Management.md | 4 +- ... App Subscription Activation (Provider).md | 6 +- .../05. App Subscription/03. Unsubscribe.md | 2 +- .../06. App Change Process/01. Summary.md | 2 +- .../02. Change App Lead Image.md | 2 +- .../03. App Instance Url.md | 2 +- .../03. Change App Description.md | 2 +- .../04. App Deactivation.md | 0 .../05. App Instance Url.md | 2 +- .../06. App Role Change.md | 4 +- .../05. Service(s)/01. Service Change.md | 0 .../01. Service Marketplace.md | 4 +- .../02. Service Details.md | 4 +- .../01. Service Card.md | 0 .../02. Service Detail Page.md | 0 .../02. Service Publish Approval.md | 2 +- .../03.Terms&Conditions.md | 0 .../04.Technical Integration.md | 0 .../05.Verify & Submit.md | 0 .../02. Service Release Process/index.md | 0 .../01. Service Approval Board Overview.md | 0 .../02. Service Details.md | 0 .../03. Approve Service Release.md | 0 .../04. Decline Service Release.md | 0 .../01. Service Subscription.md | 4 +- ...Service Subscription Request Management.md | 4 +- ...vice Subscription Activation (Provider).md | 4 +- .../03. Unsubscribe.md | 2 +- .../01. App Board.md | 0 .../06. Service Change Process/01. Summary.md | 0 .../02. Service Deactivation.md | 2 +- .../Architecture/Architecture Constraints.md | 0 .../Architecture/Building block view.md | 0 .../Architecture/Context and scope.md | 0 .../Architecture/Development Concept.md | 2 +- .../Architecture/Requirements.md | 0 .../Architecture/Security-Assessment.md | 42 +- .../Architecture/Solution strategy.md | 0 .../Architecture/Whitebox Overall System.md | 0 .../Architecture/operational-concept.md | 2 +- .../DB Views and Details/App - DB - View.md | 0 .../Connector - DB - View.md | 0 .../DB Views and Details/Data Management.md | 0 .../Documents - DB - View.md | 2 +- .../Subscription - DB - View.md | 0 .../Dev Process/Dev-flow_deploy-dev-env.md | 0 .../Dev Process/Dev-flow_git-diagram.md | 0 .../Dev Process/Enumeration Handling.md | 0 .../Dev Process/How to contribute.md | 0 .../Dev Process/Multi Language.md | 0 .../Dev Process/Run frontend on localhost.md | 2 +- .../Dev Process/Shared Components.md | 0 .../Interface Contracts/BPDM (2).md | 0 .../Interface Contracts/BPDM.md | 8 +- .../Interface Contracts/CX-Membership.md | 2 +- .../Interface Contracts/Clearinghouse.md | 4 +- .../Dataspace-Discovery.md | 2 +- .../Interface Contracts/Managed Wallets.md | 6 +- .../Interface Contracts/Offer-Autosetup.md | 0 .../Interface Contracts/Self Description.md | 0 .../Operations/Auditing.md | 0 .../Operations/Release-Process.md | 0 .../Others/Document Management.md | 0 .../Others/Email Templates.md | 0 .../Others/Images, Graphics and Diagrams.md | 24 +- .../Others/Notifications.md | 0 .../Tests/Automation}/01. Summary.md | 0 .../Automation}/02. Access Token Retrieval.md | 0 .../03. InterfacePartnerHealthCheck.md | 0 .../Automation}/04. PortalHealthCheck.md | 0 .../Automation}/05. RegistrationScenarios.md | 0 .../06. NotificiationInitScenario.md | 0 .../07. ServiceAccountCUDScenarios.md | 0 .../Automation}/08. TestDataFileSetup.md | 0 .../Automation}/09. CreateAppScenario.md | 0 .../Tests/Automation}/10. ReportPortal.md | 4 +- .../Technical Documentation/Tests/Tests.md | 78 + .../Version Upgrade/portal-upgrade-details.md | 4 +- .../01. Registration Invite/01. Summary.md | 0 .../01. Registration Invite/02. FAQ.md | 0 .../01. Registration Invite/index.md | 0 .../02. Registration/01. Login.md | 0 .../02. Registration/02. Add Company Data.md | 0 .../03. Add Additional User(s).md | 0 .../04. Company Role & Consent.md | 0 .../02. Registration/05. Document Upload.md | 0 .../06. Verify Registration Data.md | 0 .../02. Registration/07. FAQ.md | 0 .../01. Onboarding/02. Registration/index.md | 0 .../02. View Company Application(s).md | 0 .../03. Registration Approval Process.md | 0 .../04. Decline Application.md | 0 .../03. Registration Approval/05. FAQ.md | 0 .../03. Registration Approval/index.md | 0 docs/{ => user}/01. Onboarding/index.md | 0 .../01. Connector Registration/00. Summary.md | 0 .../01. Connector Overview.md | 0 .../02. Connector Registration.md | 0 .../04. SelfDescription Retrigger.md | 0 .../05. Delete Connector.md | 0 .../01. Connector Registration/06. OpenAPI.md | 2 +- .../01. Connector Registration/07. FAQ.md | 0 .../08. Policy Management.md | 2 +- .../01. Connector Registration/index.md | 0 .../01. Summary.md | 0 .../02. Company IdPs.md | 6 +- .../02. Configure Company IdP.md | 2 +- .../03. User Migration.md | 0 .../04. Identity Provider Deletion.md | 0 .../05. Disable Identity Provider.md | 0 .../06. FAQ.md | 0 .../02. Identity Provider Management/index.md | 0 .../03. CX Membership/01. Open API.md | 2 +- .../03. CX Membership/index.md | 0 .../04. Dataspace Discovery/01. Open API.md | 2 +- .../04. Dataspace Discovery/index.md | 0 .../05. Company Role/Change Company Role.md | 0 .../05. Company Role/index.md | 0 .../02. Technical Integration/index.md | 0 .../01. User Account/01. Summary.md | 0 .../01. User Account/02. User Account.md | 0 .../03. Create new user account (single).md | 0 .../04. Create new user account (bulk).md | 0 .../01. User Account/05. FAQ.md | 0 .../01. User Account/index.md | 0 .../02. Modify User Account/01. Summary.md | 0 .../02. Password Reset.md | 0 .../03. User Permissions.md | 0 .../04. Manage user assigned BPN.md | 0 .../05. Suspend User.md | 0 .../06. Delete User.md | 2 +- .../02. Modify User Account/index.md | 0 .../01. Technical User Overview.md | 0 .../02. Create Technical User.md | 2 +- .../03. Delete Technical User.md | 0 .../03. Technical User/04. FAQ.md | 0 .../04. Reset Credentials.md | 0 .../03. Technical User/index.md | 0 .../01. App Access Management Overview.md | 0 .../02. Assign User App Role(s).md | 0 .../03. Update Users Assigned App Role(s).md | 0 .../04. Assign App Roles/04. FAQ.md | 0 .../04. Assign App Roles/index.md | 0 docs/{ => user}/03. User Management/index.md | 0 .../01. Marketplace/01. App Overview.md | 0 .../01. Marketplace/02. App Details.md | 0 .../01. Marketplace/03. App Favorites.md | 0 .../01. Marketplace/04. My Business Apps.md | 0 .../04. App(s)/01. Marketplace/05. FAQ.md | 4 +- .../02. App Release Process/01. App Card.md | 0 .../02. App Detail Page.md | 0 .../03.Terms&Conditions.md | 0 .../04.Technical Integration.md | 0 .../05.Verify & Submit.md | 0 .../App-Design_guidelines.md | 0 .../App-Release_guidelines.md | 0 .../02. App Release Process/index.md | 0 .../01. App Approval Board.md | 0 .../02. App Details.md | 0 .../03. Approve App Release.md | 0 .../04. Decline App Release.md | 0 .../01. App Board.md | 0 .../01. Subscription Request (Customer).md | 0 ...verview Company Subscription (Customer).md | 0 ...3. Subscription Overview (App Provider).md | 0 ... Subscription Activation (App Provider).md | 0 .../05. App Unsubscribe.md | 0 .../05. App Subscription/05. FAQ.md | 0 .../06. App Change Process/01. Summary.md | 0 .../02. Change App Lead Image.md | 0 .../03. Change App Description.md | 0 .../04. App Deactivation.md | 0 .../05. Change App Tenant URL.md | 0 .../06. Change App RolesL.md | 0 .../07. Document Change.md | 0 .../01. Open API.md | 2 +- docs/{ => user}/04. App(s)/index.md | 0 .../01. Service Marketplace.md | 0 .../02. Service Details.md | 0 .../01. Service Marketplace/03. FAQ.md | 0 .../01. Service Card.md | 0 .../02. Service Detail Page.md | 0 .../03.Terms&Conditions.md | 0 .../04.Technical Integration.md | 0 .../05.Verify & Submit.md | 0 .../02. Service Release Process/06. FAQ.md | 0 .../02. Service Release Process/index.md | 0 .../01. Service Approval Board.md | 0 .../02. Service Details.md | 0 .../03. Approve Service Release.md | 0 .../04. Decline Service Release.md | 0 .../01. Service Subscription.md | 0 .../03. Subscription Overview (Provider).md | 0 ...vice Subscription Activation (Provider).md | 0 .../04. Service Unsubscribe.md | 2 +- .../03. Service Subscription/05. FAQ.md | 0 .../05. Service Change Process/01. Summary.md | 0 .../02. Service Deactivation.md | 0 docs/{ => user}/05. Service(s)/index.md | 0 .../01. UseCase Participation.md | 0 .../02. Other Certificates.md | 0 .../03. Credential Admin Board.md | 0 docs/{ => user}/06. Certificates/03. FAQ.md | 0 docs/{ => user}/06. Certificates/index.md | 0 .../01. Notifications/01. Overview.md | 0 docs/{ => user}/09. Others/01. Login.md | 0 .../12. Offer Authentication Flow.md | 4 +- .../Style-Guide/Static_Page_Template.md | 0 .../Style-Guide/button load more.md | 0 docs/{ => user}/Style-Guide/button.md | 0 docs/{ => user}/Style-Guide/date picker.md | 0 docs/{ => user}/Style-Guide/drop down.md | 0 docs/{ => user}/Style-Guide/dropzone.md | 0 docs/{ => user}/Style-Guide/input field.md | 0 docs/{ => user}/Style-Guide/loading.md | 0 docs/{ => user}/Style-Guide/scrollbar.md | 0 docs/{ => user}/Style-Guide/searchbar.md | 0 docs/{ => user}/Style-Guide/toast message.md | 0 public/documentation/data/1.0.0-RC1/docs.json | 5 - public/documentation/data/1.0.0-RC2/docs.json | 476 ------ public/documentation/data/1.0.0-RC3/docs.json | 504 ------ public/documentation/data/1.0.0-RC4/docs.json | 926 ----------- public/documentation/data/1.0.0-RC5/docs.json | 926 ----------- .../data/1.0.0-RC6/developer.json | 1117 ------------- public/documentation/data/1.0.0-RC6/docs.json | 740 --------- .../data/1.0.0-RC7/developer.json | 1169 -------------- public/documentation/data/1.0.0-RC7/docs.json | 713 --------- .../data/1.0.0-RC8/developer.json | 1317 ---------------- public/documentation/data/1.0.0-RC8/docs.json | 785 ---------- .../documentation/data/1.0.0/developer.json | 1335 ---------------- public/documentation/data/1.0.0/docs.json | 790 ---------- .../documentation/data/1.1.0/developer.json | 1376 ----------------- public/documentation/data/1.1.0/docs.json | 803 ---------- public/documentation/data/main/developer.json | 1317 +++++++++++----- public/documentation/data/main/docs.json | 841 ---------- public/documentation/data/main/user.json | 1312 ++++++++++++++++ public/documentation/js/Main.js | 14 +- public/documentation/js/Settings.js | 2 +- src/documentation/Release.js | 39 +- src/documentation/https-proxy-get.js | 120 -- 313 files changed, 2411 insertions(+), 14565 deletions(-) delete mode 100644 developer/Technical Documentation/Operations/Tests.md rename {developer => docs/developer}/01. Onboarding/01. Invite/01. Summary.md (100%) rename {developer => docs/developer}/01. Onboarding/01. Invite/02. Overview Invited Companies.md (100%) rename {developer => docs/developer}/01. Onboarding/01. Invite/03. Invite Company_Create Application.md (100%) rename {developer => docs/developer}/01. Onboarding/02. Registration/01. Login.md (100%) rename {developer => docs/developer}/01. Onboarding/02. Registration/02. Add Company Data.md (100%) rename {developer => docs/developer}/01. Onboarding/02. Registration/03. Add Additional Users.md (100%) rename {developer => docs/developer}/01. Onboarding/02. Registration/04. Company Role & Consent.md (100%) rename {developer => docs/developer}/01. Onboarding/02. Registration/05. Document Upload.md (100%) rename {developer => docs/developer}/01. Onboarding/02. Registration/06. Verify Registration Data.md (95%) rename {developer => docs/developer}/01. Onboarding/02. Registration/07. Error Scenarios.md (100%) rename {developer => docs/developer}/01. Onboarding/03. Registration Approval/02. View Company Application(s).md (100%) rename {developer => docs/developer}/01. Onboarding/03. Registration Approval/03. Registration Approval Process.md (100%) rename {developer => docs/developer}/01. Onboarding/03. Registration Approval/04. Decline Application.md (100%) rename {developer => docs/developer}/01. Onboarding/03. Registration Approval/index.md (100%) rename {developer => docs/developer}/02. Technical Integration/01. Connector Registration/01. Summary.md (100%) rename {developer => docs/developer}/02. Technical Integration/01. Connector Registration/02. View Connector.md (100%) rename {developer => docs/developer}/02. Technical Integration/01. Connector Registration/03. Create new Connector Registration.md (100%) rename {developer => docs/developer}/02. Technical Integration/01. Connector Registration/05. Self Description.md (100%) rename {developer => docs/developer}/02. Technical Integration/01. Connector Registration/06. Delete Connector.md (100%) rename {developer => docs/developer}/02. Technical Integration/01. Connector Registration/07. Error Handling.md (100%) rename {developer => docs/developer}/02. Technical Integration/02. Identity Provider Management/01. Summary.md (100%) rename {developer => docs/developer}/02. Technical Integration/02. Identity Provider Management/02. Company IdPs.md (85%) rename {developer => docs/developer}/02. Technical Integration/02. Identity Provider Management/02. Configure Company IdP.md (98%) rename {developer => docs/developer}/02. Technical Integration/02. Identity Provider Management/03. User Migration.md (93%) rename {developer => docs/developer}/02. Technical Integration/02. Identity Provider Management/04. Delete Identity Provider.md (93%) rename {developer => docs/developer}/02. Technical Integration/02. Identity Provider Management/04. FAQ.md (100%) rename {developer => docs/developer}/02. Technical Integration/02. Identity Provider Management/05. Disable Identity Provider.md (92%) rename {developer => docs/developer}/02. Technical Integration/03. Company Configuration/01. Summary.md (100%) rename {developer => docs/developer}/02. Technical Integration/03. Company Configuration/02. View Preferred Use Cases.md (100%) rename {developer => docs/developer}/02. Technical Integration/03. Company Configuration/03. Add new Use Case.md (100%) rename {developer => docs/developer}/02. Technical Integration/03. Company Configuration/04. Delete Preferred Use Case.md (100%) rename {developer => docs/developer}/02. Technical Integration/03. Company Configuration/05. Change Company Role.md (95%) rename {developer => docs/developer}/02. Technical Integration/04. Credentials/00. Wallet Creation.md (100%) rename {developer => docs/developer}/02. Technical Integration/04. Credentials/01. Get UseCase Credential.md (96%) rename {developer => docs/developer}/02. Technical Integration/04. Credentials/02. Other Certificates.md (97%) rename {developer => docs/developer}/02. Technical Integration/04. Credentials/03. Credential Admin Board.md (97%) rename {developer => docs/developer}/03. User Management/01. User Account/01. Summary.md (100%) rename {developer => docs/developer}/03. User Management/01. User Account/02. My User Account.md (100%) rename {developer => docs/developer}/03. User Management/01. User Account/02. User Account.md (100%) rename {developer => docs/developer}/03. User Management/01. User Account/03. Create new user account (single) - UPDATE NEEDED.md (100%) rename {developer => docs/developer}/03. User Management/01. User Account/04. Create new user account (bulk) - UPDATE NEEDED.md (100%) rename {developer => docs/developer}/03. User Management/02. Edit User Account/01. Summary.md (100%) rename {developer => docs/developer}/03. User Management/02. Edit User Account/02. Password Reset.md (100%) rename {developer => docs/developer}/03. User Management/02. Edit User Account/03. User Permissions.md (100%) rename {developer => docs/developer}/03. User Management/02. Edit User Account/04. Manage user assigned BPN.md (100%) rename {developer => docs/developer}/03. User Management/02. Edit User Account/05. Suspend User.md (100%) rename {developer => docs/developer}/03. User Management/02. Edit User Account/06. Delete User.md (97%) rename {developer => docs/developer}/03. User Management/02. Edit User Account/index.md (100%) rename {developer => docs/developer}/03. User Management/03. Technical User/01. Summary.md (100%) rename {developer => docs/developer}/03. User Management/03. Technical User/02. View Technical Users.md (100%) rename {developer => docs/developer}/03. User Management/03. Technical User/03. Create Technical User.md (100%) rename {developer => docs/developer}/03. User Management/03. Technical User/04. Delete Technical User.md (100%) rename {developer => docs/developer}/03. User Management/03. Technical User/04. Reset Credentials.md (89%) rename {developer => docs/developer}/03. User Management/03. Technical User/05. FAQ.md (100%) rename {developer => docs/developer}/03. User Management/04. App Access Management/01. Summary.md (100%) rename {developer => docs/developer}/03. User Management/04. App Access Management/02. Assign App Role Page Overview.md (100%) rename {developer => docs/developer}/03. User Management/04. App Access Management/03. Assign App Role.md (100%) rename {developer => docs/developer}/03. User Management/index.md (100%) rename {developer => docs/developer}/04. Apps/01. Marketplace/01. App Overview.md (85%) rename {developer => docs/developer}/04. Apps/01. Marketplace/02. App Details.md (96%) rename {developer => docs/developer}/04. Apps/01. Marketplace/03. App Favorites.md (88%) rename {developer => docs/developer}/04. Apps/01. Marketplace/04. My Business Apps.md (90%) rename {developer => docs/developer}/04. Apps/02. App Release Process/04. Delete App.md (100%) rename {developer => docs/developer}/04. Apps/02. App Release Process/App Release Process.md (100%) rename {developer => docs/developer}/04. Apps/03. App Release Approval/01. App Approval Board Overview.md (100%) rename {developer => docs/developer}/04. Apps/03. App Release Approval/02. App Details.md (100%) rename {developer => docs/developer}/04. Apps/03. App Release Approval/03. Approve App Release.md (100%) rename {developer => docs/developer}/04. Apps/03. App Release Approval/04. Decline App Release.md (100%) rename {developer => docs/developer}/04. Apps/04. App Provider Management Board(s)/01. App Board.md (100%) rename {developer => docs/developer}/04. Apps/05. App Subscription/01. Subscription Flow.md (100%) rename {developer => docs/developer}/04. Apps/05. App Subscription/01.App Subscription Request Management.md (95%) rename {developer => docs/developer}/04. Apps/05. App Subscription/02. App Subscription Activation (Provider).md (91%) rename {developer => docs/developer}/04. Apps/05. App Subscription/03. Unsubscribe.md (97%) rename {developer => docs/developer}/04. Apps/06. App Change Process/01. Summary.md (89%) rename {developer => docs/developer}/04. Apps/06. App Change Process/02. Change App Lead Image.md (91%) rename {developer => docs/developer}/04. Apps/06. App Change Process/03. App Instance Url.md (87%) rename {developer => docs/developer}/04. Apps/06. App Change Process/03. Change App Description.md (90%) rename {developer => docs/developer}/04. Apps/06. App Change Process/04. App Deactivation.md (100%) rename {developer => docs/developer}/04. Apps/06. App Change Process/05. App Instance Url.md (87%) rename {developer => docs/developer}/04. Apps/06. App Change Process/06. App Role Change.md (87%) rename {developer => docs/developer}/05. Service(s)/01. Service Change.md (100%) rename {developer => docs/developer}/05. Service(s)/01. Service Marketplace/01. Service Marketplace.md (94%) rename {developer => docs/developer}/05. Service(s)/01. Service Marketplace/02. Service Details.md (94%) rename {developer => docs/developer}/05. Service(s)/02. Service Release Process/01. Service Card.md (100%) rename {developer => docs/developer}/05. Service(s)/02. Service Release Process/02. Service Detail Page.md (100%) rename {developer => docs/developer}/05. Service(s)/02. Service Release Process/02. Service Publish Approval.md (97%) rename {developer => docs/developer}/05. Service(s)/02. Service Release Process/03.Terms&Conditions.md (100%) rename {developer => docs/developer}/05. Service(s)/02. Service Release Process/04.Technical Integration.md (100%) rename {developer => docs/developer}/05. Service(s)/02. Service Release Process/05.Verify & Submit.md (100%) rename {developer => docs/developer}/05. Service(s)/02. Service Release Process/index.md (100%) rename {developer => docs/developer}/05. Service(s)/03. Service Release Approval/01. Service Approval Board Overview.md (100%) rename {developer => docs/developer}/05. Service(s)/03. Service Release Approval/02. Service Details.md (100%) rename {developer => docs/developer}/05. Service(s)/03. Service Release Approval/03. Approve Service Release.md (100%) rename {developer => docs/developer}/05. Service(s)/03. Service Release Approval/04. Decline Service Release.md (100%) rename {developer => docs/developer}/05. Service(s)/03. Service Subscription/01. Service Subscription.md (92%) rename {developer => docs/developer}/05. Service(s)/03. Service Subscription/01.Service Subscription Request Management.md (95%) rename {developer => docs/developer}/05. Service(s)/03. Service Subscription/02. Service Subscription Activation (Provider).md (92%) rename {developer => docs/developer}/05. Service(s)/03. Service Subscription/03. Unsubscribe.md (91%) rename {developer => docs/developer}/05. Service(s)/04. Service Provider Management Board(s)/01. App Board.md (100%) rename {developer => docs/developer}/05. Service(s)/06. Service Change Process/01. Summary.md (100%) rename {developer => docs/developer}/05. Service(s)/06. Service Change Process/02. Service Deactivation.md (95%) rename {developer => docs/developer}/Technical Documentation/Architecture/Architecture Constraints.md (100%) rename {developer => docs/developer}/Technical Documentation/Architecture/Building block view.md (100%) rename {developer => docs/developer}/Technical Documentation/Architecture/Context and scope.md (100%) rename {developer => docs/developer}/Technical Documentation/Architecture/Development Concept.md (99%) rename {developer => docs/developer}/Technical Documentation/Architecture/Requirements.md (100%) rename {developer => docs/developer}/Technical Documentation/Architecture/Security-Assessment.md (92%) rename {developer => docs/developer}/Technical Documentation/Architecture/Solution strategy.md (100%) rename {developer => docs/developer}/Technical Documentation/Architecture/Whitebox Overall System.md (100%) rename {developer => docs/developer}/Technical Documentation/Architecture/operational-concept.md (96%) rename {developer => docs/developer}/Technical Documentation/DB Views and Details/App - DB - View.md (100%) rename {developer => docs/developer}/Technical Documentation/DB Views and Details/Connector - DB - View.md (100%) rename {developer => docs/developer}/Technical Documentation/DB Views and Details/Data Management.md (100%) rename {developer => docs/developer}/Technical Documentation/DB Views and Details/Documents - DB - View.md (89%) rename {developer => docs/developer}/Technical Documentation/DB Views and Details/Subscription - DB - View.md (100%) rename {developer => docs/developer}/Technical Documentation/Dev Process/Dev-flow_deploy-dev-env.md (100%) rename {developer => docs/developer}/Technical Documentation/Dev Process/Dev-flow_git-diagram.md (100%) rename {developer => docs/developer}/Technical Documentation/Dev Process/Enumeration Handling.md (100%) rename {developer => docs/developer}/Technical Documentation/Dev Process/How to contribute.md (100%) rename {developer => docs/developer}/Technical Documentation/Dev Process/Multi Language.md (100%) rename {developer => docs/developer}/Technical Documentation/Dev Process/Run frontend on localhost.md (98%) rename {developer => docs/developer}/Technical Documentation/Dev Process/Shared Components.md (100%) rename {developer => docs/developer}/Technical Documentation/Interface Contracts/BPDM (2).md (100%) rename {developer => docs/developer}/Technical Documentation/Interface Contracts/BPDM.md (94%) rename {developer => docs/developer}/Technical Documentation/Interface Contracts/CX-Membership.md (88%) rename {developer => docs/developer}/Technical Documentation/Interface Contracts/Clearinghouse.md (89%) rename {developer => docs/developer}/Technical Documentation/Interface Contracts/Dataspace-Discovery.md (92%) rename {developer => docs/developer}/Technical Documentation/Interface Contracts/Managed Wallets.md (86%) rename {developer => docs/developer}/Technical Documentation/Interface Contracts/Offer-Autosetup.md (100%) rename {developer => docs/developer}/Technical Documentation/Interface Contracts/Self Description.md (100%) rename {developer => docs/developer}/Technical Documentation/Operations/Auditing.md (100%) rename {developer => docs/developer}/Technical Documentation/Operations/Release-Process.md (100%) rename {developer => docs/developer}/Technical Documentation/Others/Document Management.md (100%) rename {developer => docs/developer}/Technical Documentation/Others/Email Templates.md (100%) rename {developer => docs/developer}/Technical Documentation/Others/Images, Graphics and Diagrams.md (70%) rename {developer => docs/developer}/Technical Documentation/Others/Notifications.md (100%) rename {developer/Technical Documentation/TestAutomation => docs/developer/Technical Documentation/Tests/Automation}/01. Summary.md (100%) rename {developer/Technical Documentation/TestAutomation => docs/developer/Technical Documentation/Tests/Automation}/02. Access Token Retrieval.md (100%) rename {developer/Technical Documentation/TestAutomation => docs/developer/Technical Documentation/Tests/Automation}/03. InterfacePartnerHealthCheck.md (100%) rename {developer/Technical Documentation/TestAutomation => docs/developer/Technical Documentation/Tests/Automation}/04. PortalHealthCheck.md (100%) rename {developer/Technical Documentation/TestAutomation => docs/developer/Technical Documentation/Tests/Automation}/05. RegistrationScenarios.md (100%) rename {developer/Technical Documentation/TestAutomation => docs/developer/Technical Documentation/Tests/Automation}/06. NotificiationInitScenario.md (100%) rename {developer/Technical Documentation/TestAutomation => docs/developer/Technical Documentation/Tests/Automation}/07. ServiceAccountCUDScenarios.md (100%) rename {developer/Technical Documentation/TestAutomation => docs/developer/Technical Documentation/Tests/Automation}/08. TestDataFileSetup.md (100%) rename {developer/Technical Documentation/TestAutomation => docs/developer/Technical Documentation/Tests/Automation}/09. CreateAppScenario.md (100%) rename {developer/Technical Documentation/TestAutomation => docs/developer/Technical Documentation/Tests/Automation}/10. ReportPortal.md (96%) create mode 100644 docs/developer/Technical Documentation/Tests/Tests.md rename {developer => docs/developer}/Technical Documentation/Version Upgrade/portal-upgrade-details.md (99%) rename docs/{ => user}/01. Onboarding/01. Registration Invite/01. Summary.md (100%) rename docs/{ => user}/01. Onboarding/01. Registration Invite/02. FAQ.md (100%) rename docs/{ => user}/01. Onboarding/01. Registration Invite/index.md (100%) rename docs/{ => user}/01. Onboarding/02. Registration/01. Login.md (100%) rename docs/{ => user}/01. Onboarding/02. Registration/02. Add Company Data.md (100%) rename docs/{ => user}/01. Onboarding/02. Registration/03. Add Additional User(s).md (100%) rename docs/{ => user}/01. Onboarding/02. Registration/04. Company Role & Consent.md (100%) rename docs/{ => user}/01. Onboarding/02. Registration/05. Document Upload.md (100%) rename docs/{ => user}/01. Onboarding/02. Registration/06. Verify Registration Data.md (100%) rename docs/{ => user}/01. Onboarding/02. Registration/07. FAQ.md (100%) rename docs/{ => user}/01. Onboarding/02. Registration/index.md (100%) rename docs/{ => user}/01. Onboarding/03. Registration Approval/02. View Company Application(s).md (100%) rename docs/{ => user}/01. Onboarding/03. Registration Approval/03. Registration Approval Process.md (100%) rename docs/{ => user}/01. Onboarding/03. Registration Approval/04. Decline Application.md (100%) rename docs/{ => user}/01. Onboarding/03. Registration Approval/05. FAQ.md (100%) rename docs/{ => user}/01. Onboarding/03. Registration Approval/index.md (100%) rename docs/{ => user}/01. Onboarding/index.md (100%) rename docs/{ => user}/02. Technical Integration/01. Connector Registration/00. Summary.md (100%) rename docs/{ => user}/02. Technical Integration/01. Connector Registration/01. Connector Overview.md (100%) rename docs/{ => user}/02. Technical Integration/01. Connector Registration/02. Connector Registration.md (100%) rename docs/{ => user}/02. Technical Integration/01. Connector Registration/04. SelfDescription Retrigger.md (100%) rename docs/{ => user}/02. Technical Integration/01. Connector Registration/05. Delete Connector.md (100%) rename docs/{ => user}/02. Technical Integration/01. Connector Registration/06. OpenAPI.md (93%) rename docs/{ => user}/02. Technical Integration/01. Connector Registration/07. FAQ.md (100%) rename docs/{ => user}/02. Technical Integration/01. Connector Registration/08. Policy Management.md (99%) rename docs/{ => user}/02. Technical Integration/01. Connector Registration/index.md (100%) rename docs/{ => user}/02. Technical Integration/02. Identity Provider Management/01. Summary.md (100%) rename docs/{ => user}/02. Technical Integration/02. Identity Provider Management/02. Company IdPs.md (78%) rename docs/{ => user}/02. Technical Integration/02. Identity Provider Management/02. Configure Company IdP.md (96%) rename docs/{ => user}/02. Technical Integration/02. Identity Provider Management/03. User Migration.md (100%) rename docs/{ => user}/02. Technical Integration/02. Identity Provider Management/04. Identity Provider Deletion.md (100%) rename docs/{ => user}/02. Technical Integration/02. Identity Provider Management/05. Disable Identity Provider.md (100%) rename docs/{ => user}/02. Technical Integration/02. Identity Provider Management/06. FAQ.md (100%) rename docs/{ => user}/02. Technical Integration/02. Identity Provider Management/index.md (100%) rename docs/{ => user}/02. Technical Integration/03. CX Membership/01. Open API.md (88%) rename docs/{ => user}/02. Technical Integration/03. CX Membership/index.md (100%) rename docs/{ => user}/02. Technical Integration/04. Dataspace Discovery/01. Open API.md (92%) rename docs/{ => user}/02. Technical Integration/04. Dataspace Discovery/index.md (100%) rename docs/{ => user}/02. Technical Integration/05. Company Role/Change Company Role.md (100%) rename docs/{ => user}/02. Technical Integration/05. Company Role/index.md (100%) rename docs/{ => user}/02. Technical Integration/index.md (100%) rename docs/{ => user}/03. User Management/01. User Account/01. Summary.md (100%) rename docs/{ => user}/03. User Management/01. User Account/02. User Account.md (100%) rename docs/{ => user}/03. User Management/01. User Account/03. Create new user account (single).md (100%) rename docs/{ => user}/03. User Management/01. User Account/04. Create new user account (bulk).md (100%) rename docs/{ => user}/03. User Management/01. User Account/05. FAQ.md (100%) rename docs/{ => user}/03. User Management/01. User Account/index.md (100%) rename docs/{ => user}/03. User Management/02. Modify User Account/01. Summary.md (100%) rename docs/{ => user}/03. User Management/02. Modify User Account/02. Password Reset.md (100%) rename docs/{ => user}/03. User Management/02. Modify User Account/03. User Permissions.md (100%) rename docs/{ => user}/03. User Management/02. Modify User Account/04. Manage user assigned BPN.md (100%) rename docs/{ => user}/03. User Management/02. Modify User Account/05. Suspend User.md (100%) rename docs/{ => user}/03. User Management/02. Modify User Account/06. Delete User.md (94%) rename docs/{ => user}/03. User Management/02. Modify User Account/index.md (100%) rename docs/{ => user}/03. User Management/03. Technical User/01. Technical User Overview.md (100%) rename docs/{ => user}/03. User Management/03. Technical User/02. Create Technical User.md (95%) rename docs/{ => user}/03. User Management/03. Technical User/03. Delete Technical User.md (100%) rename docs/{ => user}/03. User Management/03. Technical User/04. FAQ.md (100%) rename docs/{ => user}/03. User Management/03. Technical User/04. Reset Credentials.md (100%) rename docs/{ => user}/03. User Management/03. Technical User/index.md (100%) rename docs/{ => user}/03. User Management/04. Assign App Roles/01. App Access Management Overview.md (100%) rename docs/{ => user}/03. User Management/04. Assign App Roles/02. Assign User App Role(s).md (100%) rename docs/{ => user}/03. User Management/04. Assign App Roles/03. Update Users Assigned App Role(s).md (100%) rename docs/{ => user}/03. User Management/04. Assign App Roles/04. FAQ.md (100%) rename docs/{ => user}/03. User Management/04. Assign App Roles/index.md (100%) rename docs/{ => user}/03. User Management/index.md (100%) rename docs/{ => user}/04. App(s)/01. Marketplace/01. App Overview.md (100%) rename docs/{ => user}/04. App(s)/01. Marketplace/02. App Details.md (100%) rename docs/{ => user}/04. App(s)/01. Marketplace/03. App Favorites.md (100%) rename docs/{ => user}/04. App(s)/01. Marketplace/04. My Business Apps.md (100%) rename docs/{ => user}/04. App(s)/01. Marketplace/05. FAQ.md (81%) rename docs/{ => user}/04. App(s)/02. App Release Process/01. App Card.md (100%) rename docs/{ => user}/04. App(s)/02. App Release Process/02. App Detail Page.md (100%) rename docs/{ => user}/04. App(s)/02. App Release Process/03.Terms&Conditions.md (100%) rename docs/{ => user}/04. App(s)/02. App Release Process/04.Technical Integration.md (100%) rename docs/{ => user}/04. App(s)/02. App Release Process/05.Verify & Submit.md (100%) rename docs/{ => user}/04. App(s)/02. App Release Process/App-Design_guidelines.md (100%) rename docs/{ => user}/04. App(s)/02. App Release Process/App-Release_guidelines.md (100%) rename docs/{ => user}/04. App(s)/02. App Release Process/index.md (100%) rename docs/{ => user}/04. App(s)/03. App Release Approval/01. App Approval Board.md (100%) rename docs/{ => user}/04. App(s)/03. App Release Approval/02. App Details.md (100%) rename docs/{ => user}/04. App(s)/03. App Release Approval/03. Approve App Release.md (100%) rename docs/{ => user}/04. App(s)/03. App Release Approval/04. Decline App Release.md (100%) rename docs/{ => user}/04. App(s)/04. App Provider Management Board(s)/01. App Board.md (100%) rename docs/{ => user}/04. App(s)/05. App Subscription/01. Subscription Request (Customer).md (100%) rename docs/{ => user}/04. App(s)/05. App Subscription/02. Overview Company Subscription (Customer).md (100%) rename docs/{ => user}/04. App(s)/05. App Subscription/03. Subscription Overview (App Provider).md (100%) rename docs/{ => user}/04. App(s)/05. App Subscription/04. Subscription Activation (App Provider).md (100%) rename docs/{ => user}/04. App(s)/05. App Subscription/05. App Unsubscribe.md (100%) rename docs/{ => user}/04. App(s)/05. App Subscription/05. FAQ.md (100%) rename docs/{ => user}/04. App(s)/06. App Change Process/01. Summary.md (100%) rename docs/{ => user}/04. App(s)/06. App Change Process/02. Change App Lead Image.md (100%) rename docs/{ => user}/04. App(s)/06. App Change Process/03. Change App Description.md (100%) rename docs/{ => user}/04. App(s)/06. App Change Process/04. App Deactivation.md (100%) rename docs/{ => user}/04. App(s)/06. App Change Process/05. Change App Tenant URL.md (100%) rename docs/{ => user}/04. App(s)/06. App Change Process/06. Change App RolesL.md (100%) rename docs/{ => user}/04. App(s)/06. App Change Process/07. Document Change.md (100%) rename docs/{ => user}/04. App(s)/07. App Provider Management/01. Open API.md (98%) rename docs/{ => user}/04. App(s)/index.md (100%) rename docs/{ => user}/05. Service(s)/01. Service Marketplace/01. Service Marketplace.md (100%) rename docs/{ => user}/05. Service(s)/01. Service Marketplace/02. Service Details.md (100%) rename docs/{ => user}/05. Service(s)/01. Service Marketplace/03. FAQ.md (100%) rename docs/{ => user}/05. Service(s)/02. Service Release Process/01. Service Card.md (100%) rename docs/{ => user}/05. Service(s)/02. Service Release Process/02. Service Detail Page.md (100%) rename docs/{ => user}/05. Service(s)/02. Service Release Process/03.Terms&Conditions.md (100%) rename docs/{ => user}/05. Service(s)/02. Service Release Process/04.Technical Integration.md (100%) rename docs/{ => user}/05. Service(s)/02. Service Release Process/05.Verify & Submit.md (100%) rename docs/{ => user}/05. Service(s)/02. Service Release Process/06. FAQ.md (100%) rename docs/{ => user}/05. Service(s)/02. Service Release Process/index.md (100%) rename docs/{ => user}/05. Service(s)/03. Service Release Approval/01. Service Approval Board.md (100%) rename docs/{ => user}/05. Service(s)/03. Service Release Approval/02. Service Details.md (100%) rename docs/{ => user}/05. Service(s)/03. Service Release Approval/03. Approve Service Release.md (100%) rename docs/{ => user}/05. Service(s)/03. Service Release Approval/04. Decline Service Release.md (100%) rename docs/{ => user}/05. Service(s)/03. Service Subscription/01. Service Subscription.md (100%) rename docs/{ => user}/05. Service(s)/03. Service Subscription/03. Subscription Overview (Provider).md (100%) rename docs/{ => user}/05. Service(s)/03. Service Subscription/04. Service Subscription Activation (Provider).md (100%) rename docs/{ => user}/05. Service(s)/03. Service Subscription/04. Service Unsubscribe.md (68%) rename docs/{ => user}/05. Service(s)/03. Service Subscription/05. FAQ.md (100%) rename docs/{ => user}/05. Service(s)/05. Service Change Process/01. Summary.md (100%) rename docs/{ => user}/05. Service(s)/05. Service Change Process/02. Service Deactivation.md (100%) rename docs/{ => user}/05. Service(s)/index.md (100%) rename docs/{ => user}/06. Certificates/01. UseCase Participation.md (100%) rename docs/{ => user}/06. Certificates/02. Other Certificates.md (100%) rename docs/{ => user}/06. Certificates/03. Credential Admin Board.md (100%) rename docs/{ => user}/06. Certificates/03. FAQ.md (100%) rename docs/{ => user}/06. Certificates/index.md (100%) rename docs/{ => user}/06. Notifications/01. Notifications/01. Overview.md (100%) rename docs/{ => user}/09. Others/01. Login.md (100%) rename docs/{ => user}/09. Others/12. Offer Authentication Flow.md (95%) rename docs/{ => user}/Style-Guide/Static_Page_Template.md (100%) rename docs/{ => user}/Style-Guide/button load more.md (100%) rename docs/{ => user}/Style-Guide/button.md (100%) rename docs/{ => user}/Style-Guide/date picker.md (100%) rename docs/{ => user}/Style-Guide/drop down.md (100%) rename docs/{ => user}/Style-Guide/dropzone.md (100%) rename docs/{ => user}/Style-Guide/input field.md (100%) rename docs/{ => user}/Style-Guide/loading.md (100%) rename docs/{ => user}/Style-Guide/scrollbar.md (100%) rename docs/{ => user}/Style-Guide/searchbar.md (100%) rename docs/{ => user}/Style-Guide/toast message.md (100%) delete mode 100644 public/documentation/data/1.0.0-RC1/docs.json delete mode 100644 public/documentation/data/1.0.0-RC2/docs.json delete mode 100644 public/documentation/data/1.0.0-RC3/docs.json delete mode 100644 public/documentation/data/1.0.0-RC4/docs.json delete mode 100644 public/documentation/data/1.0.0-RC5/docs.json delete mode 100644 public/documentation/data/1.0.0-RC6/developer.json delete mode 100644 public/documentation/data/1.0.0-RC6/docs.json delete mode 100644 public/documentation/data/1.0.0-RC7/developer.json delete mode 100644 public/documentation/data/1.0.0-RC7/docs.json delete mode 100644 public/documentation/data/1.0.0-RC8/developer.json delete mode 100644 public/documentation/data/1.0.0-RC8/docs.json delete mode 100644 public/documentation/data/1.0.0/developer.json delete mode 100644 public/documentation/data/1.0.0/docs.json delete mode 100644 public/documentation/data/1.1.0/developer.json delete mode 100644 public/documentation/data/1.1.0/docs.json delete mode 100644 public/documentation/data/main/docs.json create mode 100644 public/documentation/data/main/user.json delete mode 100644 src/documentation/https-proxy-get.js diff --git a/.eslintignore b/.eslintignore index 9d22c9cea..2711c841a 100644 --- a/.eslintignore +++ b/.eslintignore @@ -1,3 +1,2 @@ **/public/documentation/js/lib -**/developer **/docs \ No newline at end of file diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 7b68d5538..ed4b23ce2 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -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) diff --git a/developer/Technical Documentation/Operations/Tests.md b/developer/Technical Documentation/Operations/Tests.md deleted file mode 100644 index 084d85e9b..000000000 --- a/developer/Technical Documentation/Operations/Tests.md +++ /dev/null @@ -1,34 +0,0 @@ -## Summary - -
-
- -## Unit Tests - -Unit tests are available for backend and frontend components and getting automatically executed as part of the code commits inside the CX NG. - -
-
- -## Test Automation - -Test Automation as part of functional e2e tests are planned for upcoming releases. -Currently all tests are manually handled. - -
-
- -## Manual Tests - -Manual tests are executed and documented inside the Catena-X consortia. Currently, manual tests are not open source available. - -
-
- -## 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: 2021-2023 Contributors to the Eclipse Foundation -- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/01. Onboarding/01. Invite/01. Summary.md b/docs/developer/01. Onboarding/01. Invite/01. Summary.md similarity index 100% rename from developer/01. Onboarding/01. Invite/01. Summary.md rename to docs/developer/01. Onboarding/01. Invite/01. Summary.md diff --git a/developer/01. Onboarding/01. Invite/02. Overview Invited Companies.md b/docs/developer/01. Onboarding/01. Invite/02. Overview Invited Companies.md similarity index 100% rename from developer/01. Onboarding/01. Invite/02. Overview Invited Companies.md rename to docs/developer/01. Onboarding/01. Invite/02. Overview Invited Companies.md diff --git a/developer/01. Onboarding/01. Invite/03. Invite Company_Create Application.md b/docs/developer/01. Onboarding/01. Invite/03. Invite Company_Create Application.md similarity index 100% rename from developer/01. Onboarding/01. Invite/03. Invite Company_Create Application.md rename to docs/developer/01. Onboarding/01. Invite/03. Invite Company_Create Application.md diff --git a/developer/01. Onboarding/02. Registration/01. Login.md b/docs/developer/01. Onboarding/02. Registration/01. Login.md similarity index 100% rename from developer/01. Onboarding/02. Registration/01. Login.md rename to docs/developer/01. Onboarding/02. Registration/01. Login.md diff --git a/developer/01. Onboarding/02. Registration/02. Add Company Data.md b/docs/developer/01. Onboarding/02. Registration/02. Add Company Data.md similarity index 100% rename from developer/01. Onboarding/02. Registration/02. Add Company Data.md rename to docs/developer/01. Onboarding/02. Registration/02. Add Company Data.md diff --git a/developer/01. Onboarding/02. Registration/03. Add Additional Users.md b/docs/developer/01. Onboarding/02. Registration/03. Add Additional Users.md similarity index 100% rename from developer/01. Onboarding/02. Registration/03. Add Additional Users.md rename to docs/developer/01. Onboarding/02. Registration/03. Add Additional Users.md diff --git a/developer/01. Onboarding/02. Registration/04. Company Role & Consent.md b/docs/developer/01. Onboarding/02. Registration/04. Company Role & Consent.md similarity index 100% rename from developer/01. Onboarding/02. Registration/04. Company Role & Consent.md rename to docs/developer/01. Onboarding/02. Registration/04. Company Role & Consent.md diff --git a/developer/01. Onboarding/02. Registration/05. Document Upload.md b/docs/developer/01. Onboarding/02. Registration/05. Document Upload.md similarity index 100% rename from developer/01. Onboarding/02. Registration/05. Document Upload.md rename to docs/developer/01. Onboarding/02. Registration/05. Document Upload.md diff --git a/developer/01. Onboarding/02. Registration/06. Verify Registration Data.md b/docs/developer/01. Onboarding/02. Registration/06. Verify Registration Data.md similarity index 95% rename from developer/01. Onboarding/02. Registration/06. Verify Registration Data.md rename to docs/developer/01. Onboarding/02. Registration/06. Verify Registration Data.md index 97ddef297..84f192d87 100644 --- a/developer/01. Onboarding/02. Registration/06. Verify Registration Data.md +++ b/docs/developer/01. Onboarding/02. Registration/06. Verify Registration Data.md @@ -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.
-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)

diff --git a/developer/01. Onboarding/02. Registration/07. Error Scenarios.md b/docs/developer/01. Onboarding/02. Registration/07. Error Scenarios.md similarity index 100% rename from developer/01. Onboarding/02. Registration/07. Error Scenarios.md rename to docs/developer/01. Onboarding/02. Registration/07. Error Scenarios.md diff --git a/developer/01. Onboarding/03. Registration Approval/02. View Company Application(s).md b/docs/developer/01. Onboarding/03. Registration Approval/02. View Company Application(s).md similarity index 100% rename from developer/01. Onboarding/03. Registration Approval/02. View Company Application(s).md rename to docs/developer/01. Onboarding/03. Registration Approval/02. View Company Application(s).md diff --git a/developer/01. Onboarding/03. Registration Approval/03. Registration Approval Process.md b/docs/developer/01. Onboarding/03. Registration Approval/03. Registration Approval Process.md similarity index 100% rename from developer/01. Onboarding/03. Registration Approval/03. Registration Approval Process.md rename to docs/developer/01. Onboarding/03. Registration Approval/03. Registration Approval Process.md diff --git a/developer/01. Onboarding/03. Registration Approval/04. Decline Application.md b/docs/developer/01. Onboarding/03. Registration Approval/04. Decline Application.md similarity index 100% rename from developer/01. Onboarding/03. Registration Approval/04. Decline Application.md rename to docs/developer/01. Onboarding/03. Registration Approval/04. Decline Application.md diff --git a/developer/01. Onboarding/03. Registration Approval/index.md b/docs/developer/01. Onboarding/03. Registration Approval/index.md similarity index 100% rename from developer/01. Onboarding/03. Registration Approval/index.md rename to docs/developer/01. Onboarding/03. Registration Approval/index.md diff --git a/developer/02. Technical Integration/01. Connector Registration/01. Summary.md b/docs/developer/02. Technical Integration/01. Connector Registration/01. Summary.md similarity index 100% rename from developer/02. Technical Integration/01. Connector Registration/01. Summary.md rename to docs/developer/02. Technical Integration/01. Connector Registration/01. Summary.md diff --git a/developer/02. Technical Integration/01. Connector Registration/02. View Connector.md b/docs/developer/02. Technical Integration/01. Connector Registration/02. View Connector.md similarity index 100% rename from developer/02. Technical Integration/01. Connector Registration/02. View Connector.md rename to docs/developer/02. Technical Integration/01. Connector Registration/02. View Connector.md diff --git a/developer/02. Technical Integration/01. Connector Registration/03. Create new Connector Registration.md b/docs/developer/02. Technical Integration/01. Connector Registration/03. Create new Connector Registration.md similarity index 100% rename from developer/02. Technical Integration/01. Connector Registration/03. Create new Connector Registration.md rename to docs/developer/02. Technical Integration/01. Connector Registration/03. Create new Connector Registration.md diff --git a/developer/02. Technical Integration/01. Connector Registration/05. Self Description.md b/docs/developer/02. Technical Integration/01. Connector Registration/05. Self Description.md similarity index 100% rename from developer/02. Technical Integration/01. Connector Registration/05. Self Description.md rename to docs/developer/02. Technical Integration/01. Connector Registration/05. Self Description.md diff --git a/developer/02. Technical Integration/01. Connector Registration/06. Delete Connector.md b/docs/developer/02. Technical Integration/01. Connector Registration/06. Delete Connector.md similarity index 100% rename from developer/02. Technical Integration/01. Connector Registration/06. Delete Connector.md rename to docs/developer/02. Technical Integration/01. Connector Registration/06. Delete Connector.md diff --git a/developer/02. Technical Integration/01. Connector Registration/07. Error Handling.md b/docs/developer/02. Technical Integration/01. Connector Registration/07. Error Handling.md similarity index 100% rename from developer/02. Technical Integration/01. Connector Registration/07. Error Handling.md rename to docs/developer/02. Technical Integration/01. Connector Registration/07. Error Handling.md diff --git a/developer/02. Technical Integration/02. Identity Provider Management/01. Summary.md b/docs/developer/02. Technical Integration/02. Identity Provider Management/01. Summary.md similarity index 100% rename from developer/02. Technical Integration/02. Identity Provider Management/01. Summary.md rename to docs/developer/02. Technical Integration/02. Identity Provider Management/01. Summary.md diff --git a/developer/02. Technical Integration/02. Identity Provider Management/02. Company IdPs.md b/docs/developer/02. Technical Integration/02. Identity Provider Management/02. Company IdPs.md similarity index 85% rename from developer/02. Technical Integration/02. Identity Provider Management/02. Company IdPs.md rename to docs/developer/02. Technical Integration/02. Identity Provider Management/02. Company IdPs.md index 556ba7b6c..5e732ff08 100644 --- a/developer/02. Technical Integration/02. Identity Provider Management/02. Company IdPs.md +++ b/docs/developer/02. Technical Integration/02. Identity Provider Management/02. Company IdPs.md @@ -6,7 +6,7 @@ image

-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 @@ -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 diff --git a/developer/02. Technical Integration/02. Identity Provider Management/02. Configure Company IdP.md b/docs/developer/02. Technical Integration/02. Identity Provider Management/02. Configure Company IdP.md similarity index 98% rename from developer/02. Technical Integration/02. Identity Provider Management/02. Configure Company IdP.md rename to docs/developer/02. Technical Integration/02. Identity Provider Management/02. Configure Company IdP.md index 6fe01cfb3..58a6ff686 100644 --- a/developer/02. Technical Integration/02. Identity Provider Management/02. Configure Company IdP.md +++ b/docs/developer/02. Technical Integration/02. Identity Provider Management/02. Configure Company IdP.md @@ -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)
diff --git a/developer/02. Technical Integration/02. Identity Provider Management/03. User Migration.md b/docs/developer/02. Technical Integration/02. Identity Provider Management/03. User Migration.md similarity index 93% rename from developer/02. Technical Integration/02. Identity Provider Management/03. User Migration.md rename to docs/developer/02. Technical Integration/02. Identity Provider Management/03. User Migration.md index ac875300d..0fe15f448 100644 --- a/developer/02. Technical Integration/02. Identity Provider Management/03. User Migration.md +++ b/docs/developer/02. Technical Integration/02. Identity Provider Management/03. User Migration.md @@ -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.
-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)
diff --git a/developer/02. Technical Integration/02. Identity Provider Management/04. Delete Identity Provider.md b/docs/developer/02. Technical Integration/02. Identity Provider Management/04. Delete Identity Provider.md similarity index 93% rename from developer/02. Technical Integration/02. Identity Provider Management/04. Delete Identity Provider.md rename to docs/developer/02. Technical Integration/02. Identity Provider Management/04. Delete Identity Provider.md index 57fe59e85..0d13b5ae6 100644 --- a/developer/02. Technical Integration/02. Identity Provider Management/04. Delete Identity Provider.md +++ b/docs/developer/02. Technical Integration/02. Identity Provider Management/04. Delete Identity Provider.md @@ -6,7 +6,7 @@
-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)
diff --git a/developer/02. Technical Integration/02. Identity Provider Management/04. FAQ.md b/docs/developer/02. Technical Integration/02. Identity Provider Management/04. FAQ.md similarity index 100% rename from developer/02. Technical Integration/02. Identity Provider Management/04. FAQ.md rename to docs/developer/02. Technical Integration/02. Identity Provider Management/04. FAQ.md diff --git a/developer/02. Technical Integration/02. Identity Provider Management/05. Disable Identity Provider.md b/docs/developer/02. Technical Integration/02. Identity Provider Management/05. Disable Identity Provider.md similarity index 92% rename from developer/02. Technical Integration/02. Identity Provider Management/05. Disable Identity Provider.md rename to docs/developer/02. Technical Integration/02. Identity Provider Management/05. Disable Identity Provider.md index f220a31d2..7532a05a6 100644 --- a/developer/02. Technical Integration/02. Identity Provider Management/05. Disable Identity Provider.md +++ b/docs/developer/02. Technical Integration/02. Identity Provider Management/05. Disable Identity Provider.md @@ -6,7 +6,7 @@
-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)
diff --git a/developer/02. Technical Integration/03. Company Configuration/01. Summary.md b/docs/developer/02. Technical Integration/03. Company Configuration/01. Summary.md similarity index 100% rename from developer/02. Technical Integration/03. Company Configuration/01. Summary.md rename to docs/developer/02. Technical Integration/03. Company Configuration/01. Summary.md diff --git a/developer/02. Technical Integration/03. Company Configuration/02. View Preferred Use Cases.md b/docs/developer/02. Technical Integration/03. Company Configuration/02. View Preferred Use Cases.md similarity index 100% rename from developer/02. Technical Integration/03. Company Configuration/02. View Preferred Use Cases.md rename to docs/developer/02. Technical Integration/03. Company Configuration/02. View Preferred Use Cases.md diff --git a/developer/02. Technical Integration/03. Company Configuration/03. Add new Use Case.md b/docs/developer/02. Technical Integration/03. Company Configuration/03. Add new Use Case.md similarity index 100% rename from developer/02. Technical Integration/03. Company Configuration/03. Add new Use Case.md rename to docs/developer/02. Technical Integration/03. Company Configuration/03. Add new Use Case.md diff --git a/developer/02. Technical Integration/03. Company Configuration/04. Delete Preferred Use Case.md b/docs/developer/02. Technical Integration/03. Company Configuration/04. Delete Preferred Use Case.md similarity index 100% rename from developer/02. Technical Integration/03. Company Configuration/04. Delete Preferred Use Case.md rename to docs/developer/02. Technical Integration/03. Company Configuration/04. Delete Preferred Use Case.md diff --git a/developer/02. Technical Integration/03. Company Configuration/05. Change Company Role.md b/docs/developer/02. Technical Integration/03. Company Configuration/05. Change Company Role.md similarity index 95% rename from developer/02. Technical Integration/03. Company Configuration/05. Change Company Role.md rename to docs/developer/02. Technical Integration/03. Company Configuration/05. Change Company Role.md index 3ebf2e7f9..a6ee4f5af 100644 --- a/developer/02. Technical Integration/03. Company Configuration/05. Change Company Role.md +++ b/docs/developer/02. Technical Integration/03. Company Configuration/05. Change Company Role.md @@ -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)

diff --git a/developer/02. Technical Integration/04. Credentials/00. Wallet Creation.md b/docs/developer/02. Technical Integration/04. Credentials/00. Wallet Creation.md similarity index 100% rename from developer/02. Technical Integration/04. Credentials/00. Wallet Creation.md rename to docs/developer/02. Technical Integration/04. Credentials/00. Wallet Creation.md diff --git a/developer/02. Technical Integration/04. Credentials/01. Get UseCase Credential.md b/docs/developer/02. Technical Integration/04. Credentials/01. Get UseCase Credential.md similarity index 96% rename from developer/02. Technical Integration/04. Credentials/01. Get UseCase Credential.md rename to docs/developer/02. Technical Integration/04. Credentials/01. Get UseCase Credential.md index 223f81a0e..746555aaa 100644 --- a/developer/02. Technical Integration/04. Credentials/01. Get UseCase Credential.md +++ b/docs/developer/02. Technical Integration/04. Credentials/01. Get UseCase Credential.md @@ -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)
diff --git a/developer/02. Technical Integration/04. Credentials/02. Other Certificates.md b/docs/developer/02. Technical Integration/04. Credentials/02. Other Certificates.md similarity index 97% rename from developer/02. Technical Integration/04. Credentials/02. Other Certificates.md rename to docs/developer/02. Technical Integration/04. Credentials/02. Other Certificates.md index 1882c50d9..6968cac94 100644 --- a/developer/02. Technical Integration/04. Credentials/02. Other Certificates.md +++ b/docs/developer/02. Technical Integration/04. Credentials/02. Other Certificates.md @@ -8,7 +8,7 @@ Currently Supported:
-Functional Description: [here](/docs/06.%20Certificates/02.%20Other%20Certificates.md) +Functional Description: [here](/docs/user/06.%20Certificates/02.%20Other%20Certificates.md)
diff --git a/developer/02. Technical Integration/04. Credentials/03. Credential Admin Board.md b/docs/developer/02. Technical Integration/04. Credentials/03. Credential Admin Board.md similarity index 97% rename from developer/02. Technical Integration/04. Credentials/03. Credential Admin Board.md rename to docs/developer/02. Technical Integration/04. Credentials/03. Credential Admin Board.md index 9781d9e4a..6963feea7 100644 --- a/developer/02. Technical Integration/04. Credentials/03. Credential Admin Board.md +++ b/docs/developer/02. Technical Integration/04. Credentials/03. Credential Admin Board.md @@ -15,7 +15,7 @@ The administrator can:
-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)

diff --git a/developer/03. User Management/01. User Account/01. Summary.md b/docs/developer/03. User Management/01. User Account/01. Summary.md similarity index 100% rename from developer/03. User Management/01. User Account/01. Summary.md rename to docs/developer/03. User Management/01. User Account/01. Summary.md diff --git a/developer/03. User Management/01. User Account/02. My User Account.md b/docs/developer/03. User Management/01. User Account/02. My User Account.md similarity index 100% rename from developer/03. User Management/01. User Account/02. My User Account.md rename to docs/developer/03. User Management/01. User Account/02. My User Account.md diff --git a/developer/03. User Management/01. User Account/02. User Account.md b/docs/developer/03. User Management/01. User Account/02. User Account.md similarity index 100% rename from developer/03. User Management/01. User Account/02. User Account.md rename to docs/developer/03. User Management/01. User Account/02. User Account.md diff --git a/developer/03. User Management/01. User Account/03. Create new user account (single) - UPDATE NEEDED.md b/docs/developer/03. User Management/01. User Account/03. Create new user account (single) - UPDATE NEEDED.md similarity index 100% rename from developer/03. User Management/01. User Account/03. Create new user account (single) - UPDATE NEEDED.md rename to docs/developer/03. User Management/01. User Account/03. Create new user account (single) - UPDATE NEEDED.md diff --git a/developer/03. User Management/01. User Account/04. Create new user account (bulk) - UPDATE NEEDED.md b/docs/developer/03. User Management/01. User Account/04. Create new user account (bulk) - UPDATE NEEDED.md similarity index 100% rename from developer/03. User Management/01. User Account/04. Create new user account (bulk) - UPDATE NEEDED.md rename to docs/developer/03. User Management/01. User Account/04. Create new user account (bulk) - UPDATE NEEDED.md diff --git a/developer/03. User Management/02. Edit User Account/01. Summary.md b/docs/developer/03. User Management/02. Edit User Account/01. Summary.md similarity index 100% rename from developer/03. User Management/02. Edit User Account/01. Summary.md rename to docs/developer/03. User Management/02. Edit User Account/01. Summary.md diff --git a/developer/03. User Management/02. Edit User Account/02. Password Reset.md b/docs/developer/03. User Management/02. Edit User Account/02. Password Reset.md similarity index 100% rename from developer/03. User Management/02. Edit User Account/02. Password Reset.md rename to docs/developer/03. User Management/02. Edit User Account/02. Password Reset.md diff --git a/developer/03. User Management/02. Edit User Account/03. User Permissions.md b/docs/developer/03. User Management/02. Edit User Account/03. User Permissions.md similarity index 100% rename from developer/03. User Management/02. Edit User Account/03. User Permissions.md rename to docs/developer/03. User Management/02. Edit User Account/03. User Permissions.md diff --git a/developer/03. User Management/02. Edit User Account/04. Manage user assigned BPN.md b/docs/developer/03. User Management/02. Edit User Account/04. Manage user assigned BPN.md similarity index 100% rename from developer/03. User Management/02. Edit User Account/04. Manage user assigned BPN.md rename to docs/developer/03. User Management/02. Edit User Account/04. Manage user assigned BPN.md diff --git a/developer/03. User Management/02. Edit User Account/05. Suspend User.md b/docs/developer/03. User Management/02. Edit User Account/05. Suspend User.md similarity index 100% rename from developer/03. User Management/02. Edit User Account/05. Suspend User.md rename to docs/developer/03. User Management/02. Edit User Account/05. Suspend User.md diff --git a/developer/03. User Management/02. Edit User Account/06. Delete User.md b/docs/developer/03. User Management/02. Edit User Account/06. Delete User.md similarity index 97% rename from developer/03. User Management/02. Edit User Account/06. Delete User.md rename to docs/developer/03. User Management/02. Edit User Account/06. Delete User.md index 3a5d9a777..c43ad48ff 100644 --- a/developer/03. User Management/02. Edit User Account/06. Delete User.md +++ b/docs/developer/03. User Management/02. Edit User Account/06. Delete User.md @@ -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 diff --git a/developer/03. User Management/02. Edit User Account/index.md b/docs/developer/03. User Management/02. Edit User Account/index.md similarity index 100% rename from developer/03. User Management/02. Edit User Account/index.md rename to docs/developer/03. User Management/02. Edit User Account/index.md diff --git a/developer/03. User Management/03. Technical User/01. Summary.md b/docs/developer/03. User Management/03. Technical User/01. Summary.md similarity index 100% rename from developer/03. User Management/03. Technical User/01. Summary.md rename to docs/developer/03. User Management/03. Technical User/01. Summary.md diff --git a/developer/03. User Management/03. Technical User/02. View Technical Users.md b/docs/developer/03. User Management/03. Technical User/02. View Technical Users.md similarity index 100% rename from developer/03. User Management/03. Technical User/02. View Technical Users.md rename to docs/developer/03. User Management/03. Technical User/02. View Technical Users.md diff --git a/developer/03. User Management/03. Technical User/03. Create Technical User.md b/docs/developer/03. User Management/03. Technical User/03. Create Technical User.md similarity index 100% rename from developer/03. User Management/03. Technical User/03. Create Technical User.md rename to docs/developer/03. User Management/03. Technical User/03. Create Technical User.md diff --git a/developer/03. User Management/03. Technical User/04. Delete Technical User.md b/docs/developer/03. User Management/03. Technical User/04. Delete Technical User.md similarity index 100% rename from developer/03. User Management/03. Technical User/04. Delete Technical User.md rename to docs/developer/03. User Management/03. Technical User/04. Delete Technical User.md diff --git a/developer/03. User Management/03. Technical User/04. Reset Credentials.md b/docs/developer/03. User Management/03. Technical User/04. Reset Credentials.md similarity index 89% rename from developer/03. User Management/03. Technical User/04. Reset Credentials.md rename to docs/developer/03. User Management/03. Technical User/04. Reset Credentials.md index 497c402a9..c20aa549a 100644 --- a/developer/03. User Management/03. Technical User/04. Reset Credentials.md +++ b/docs/developer/03. User Management/03. Technical User/04. Reset Credentials.md @@ -5,7 +5,7 @@ This might be relevant if the credentials are getting old/long used already, due
-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)
diff --git a/developer/03. User Management/03. Technical User/05. FAQ.md b/docs/developer/03. User Management/03. Technical User/05. FAQ.md similarity index 100% rename from developer/03. User Management/03. Technical User/05. FAQ.md rename to docs/developer/03. User Management/03. Technical User/05. FAQ.md diff --git a/developer/03. User Management/04. App Access Management/01. Summary.md b/docs/developer/03. User Management/04. App Access Management/01. Summary.md similarity index 100% rename from developer/03. User Management/04. App Access Management/01. Summary.md rename to docs/developer/03. User Management/04. App Access Management/01. Summary.md diff --git a/developer/03. User Management/04. App Access Management/02. Assign App Role Page Overview.md b/docs/developer/03. User Management/04. App Access Management/02. Assign App Role Page Overview.md similarity index 100% rename from developer/03. User Management/04. App Access Management/02. Assign App Role Page Overview.md rename to docs/developer/03. User Management/04. App Access Management/02. Assign App Role Page Overview.md diff --git a/developer/03. User Management/04. App Access Management/03. Assign App Role.md b/docs/developer/03. User Management/04. App Access Management/03. Assign App Role.md similarity index 100% rename from developer/03. User Management/04. App Access Management/03. Assign App Role.md rename to docs/developer/03. User Management/04. App Access Management/03. Assign App Role.md diff --git a/developer/03. User Management/index.md b/docs/developer/03. User Management/index.md similarity index 100% rename from developer/03. User Management/index.md rename to docs/developer/03. User Management/index.md diff --git a/developer/04. Apps/01. Marketplace/01. App Overview.md b/docs/developer/04. Apps/01. Marketplace/01. App Overview.md similarity index 85% rename from developer/04. Apps/01. Marketplace/01. App Overview.md rename to docs/developer/04. Apps/01. Marketplace/01. App Overview.md index d06c40a66..c0cbb6c2c 100644 --- a/developer/04. Apps/01. Marketplace/01. App Overview.md +++ b/docs/developer/04. Apps/01. Marketplace/01. App Overview.md @@ -7,8 +7,8 @@ Links: -[Design]() -[FAQ]() +[Design]() +[FAQ]()

diff --git a/developer/04. Apps/01. Marketplace/02. App Details.md b/docs/developer/04. Apps/01. Marketplace/02. App Details.md similarity index 96% rename from developer/04. Apps/01. Marketplace/02. App Details.md rename to docs/developer/04. Apps/01. Marketplace/02. App Details.md index 3df05e39f..020dd9cad 100644 --- a/developer/04. Apps/01. Marketplace/02. App Details.md +++ b/docs/developer/04. Apps/01. Marketplace/02. App Details.md @@ -6,8 +6,8 @@ Links: -[Design]() -[FAQ]() +[Design]() +[FAQ]()

diff --git a/developer/04. Apps/01. Marketplace/03. App Favorites.md b/docs/developer/04. Apps/01. Marketplace/03. App Favorites.md similarity index 88% rename from developer/04. Apps/01. Marketplace/03. App Favorites.md rename to docs/developer/04. Apps/01. Marketplace/03. App Favorites.md index 289fe2f18..acc9d2166 100644 --- a/developer/04. Apps/01. Marketplace/03. App Favorites.md +++ b/docs/developer/04. Apps/01. Marketplace/03. App Favorites.md @@ -6,8 +6,8 @@ Links: -[Design]() -[FAQ]() +[Design]() +[FAQ]()

diff --git a/developer/04. Apps/01. Marketplace/04. My Business Apps.md b/docs/developer/04. Apps/01. Marketplace/04. My Business Apps.md similarity index 90% rename from developer/04. Apps/01. Marketplace/04. My Business Apps.md rename to docs/developer/04. Apps/01. Marketplace/04. My Business Apps.md index d71c95ef6..4a772ea2c 100644 --- a/developer/04. Apps/01. Marketplace/04. My Business Apps.md +++ b/docs/developer/04. Apps/01. Marketplace/04. My Business Apps.md @@ -7,8 +7,8 @@ Links: -[Design]() -[FAQ]() +[Design]() +[FAQ]()

diff --git a/developer/04. Apps/02. App Release Process/04. Delete App.md b/docs/developer/04. Apps/02. App Release Process/04. Delete App.md similarity index 100% rename from developer/04. Apps/02. App Release Process/04. Delete App.md rename to docs/developer/04. Apps/02. App Release Process/04. Delete App.md diff --git a/developer/04. Apps/02. App Release Process/App Release Process.md b/docs/developer/04. Apps/02. App Release Process/App Release Process.md similarity index 100% rename from developer/04. Apps/02. App Release Process/App Release Process.md rename to docs/developer/04. Apps/02. App Release Process/App Release Process.md diff --git a/developer/04. Apps/03. App Release Approval/01. App Approval Board Overview.md b/docs/developer/04. Apps/03. App Release Approval/01. App Approval Board Overview.md similarity index 100% rename from developer/04. Apps/03. App Release Approval/01. App Approval Board Overview.md rename to docs/developer/04. Apps/03. App Release Approval/01. App Approval Board Overview.md diff --git a/developer/04. Apps/03. App Release Approval/02. App Details.md b/docs/developer/04. Apps/03. App Release Approval/02. App Details.md similarity index 100% rename from developer/04. Apps/03. App Release Approval/02. App Details.md rename to docs/developer/04. Apps/03. App Release Approval/02. App Details.md diff --git a/developer/04. Apps/03. App Release Approval/03. Approve App Release.md b/docs/developer/04. Apps/03. App Release Approval/03. Approve App Release.md similarity index 100% rename from developer/04. Apps/03. App Release Approval/03. Approve App Release.md rename to docs/developer/04. Apps/03. App Release Approval/03. Approve App Release.md diff --git a/developer/04. Apps/03. App Release Approval/04. Decline App Release.md b/docs/developer/04. Apps/03. App Release Approval/04. Decline App Release.md similarity index 100% rename from developer/04. Apps/03. App Release Approval/04. Decline App Release.md rename to docs/developer/04. Apps/03. App Release Approval/04. Decline App Release.md diff --git a/developer/04. Apps/04. App Provider Management Board(s)/01. App Board.md b/docs/developer/04. Apps/04. App Provider Management Board(s)/01. App Board.md similarity index 100% rename from developer/04. Apps/04. App Provider Management Board(s)/01. App Board.md rename to docs/developer/04. Apps/04. App Provider Management Board(s)/01. App Board.md diff --git a/developer/04. Apps/05. App Subscription/01. Subscription Flow.md b/docs/developer/04. Apps/05. App Subscription/01. Subscription Flow.md similarity index 100% rename from developer/04. Apps/05. App Subscription/01. Subscription Flow.md rename to docs/developer/04. Apps/05. App Subscription/01. Subscription Flow.md diff --git a/developer/04. Apps/05. App Subscription/01.App Subscription Request Management.md b/docs/developer/04. Apps/05. App Subscription/01.App Subscription Request Management.md similarity index 95% rename from developer/04. Apps/05. App Subscription/01.App Subscription Request Management.md rename to docs/developer/04. Apps/05. App Subscription/01.App Subscription Request Management.md index e8005013e..8f38a9443 100644 --- a/developer/04. Apps/05. App Subscription/01.App Subscription Request Management.md +++ b/docs/developer/04. Apps/05. App Subscription/01.App Subscription Request Management.md @@ -16,8 +16,8 @@ The page includes following functions Links: -[Design]() -[FAQ]() +[Design]() +[FAQ]()

diff --git a/developer/04. Apps/05. App Subscription/02. App Subscription Activation (Provider).md b/docs/developer/04. Apps/05. App Subscription/02. App Subscription Activation (Provider).md similarity index 91% rename from developer/04. Apps/05. App Subscription/02. App Subscription Activation (Provider).md rename to docs/developer/04. Apps/05. App Subscription/02. App Subscription Activation (Provider).md index 3a3184fa3..00c53fca2 100644 --- a/developer/04. Apps/05. App Subscription/02. App Subscription Activation (Provider).md +++ b/docs/developer/04. Apps/05. App Subscription/02. App Subscription Activation (Provider).md @@ -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.
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]() +=> details to "My Business Apps" can be found [here]()

Links: -[EndUser Docu]() -[FAQ]() +[EndUser Docu]() +[FAQ]()

diff --git a/developer/04. Apps/05. App Subscription/03. Unsubscribe.md b/docs/developer/04. Apps/05. App Subscription/03. Unsubscribe.md similarity index 97% rename from developer/04. Apps/05. App Subscription/03. Unsubscribe.md rename to docs/developer/04. Apps/05. App Subscription/03. Unsubscribe.md index dae474699..2fa1694b9 100644 --- a/developer/04. Apps/05. App Subscription/03. Unsubscribe.md +++ b/docs/developer/04. Apps/05. App Subscription/03. Unsubscribe.md @@ -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]() +[Functional Description]()
diff --git a/developer/04. Apps/06. App Change Process/01. Summary.md b/docs/developer/04. Apps/06. App Change Process/01. Summary.md similarity index 89% rename from developer/04. Apps/06. App Change Process/01. Summary.md rename to docs/developer/04. Apps/06. App Change Process/01. Summary.md index 87c8edc2d..ff40f6762 100644 --- a/developer/04. Apps/06. App Change Process/01. Summary.md +++ b/docs/developer/04. Apps/06. App Change Process/01. Summary.md @@ -19,7 +19,7 @@ On purpose, the change scenarios are kept limited for the first release of "app

-Functional Details: [click here]() +Functional Details: [click here]()

diff --git a/developer/04. Apps/06. App Change Process/02. Change App Lead Image.md b/docs/developer/04. Apps/06. App Change Process/02. Change App Lead Image.md similarity index 91% rename from developer/04. Apps/06. App Change Process/02. Change App Lead Image.md rename to docs/developer/04. Apps/06. App Change Process/02. Change App Lead Image.md index 4631812b1..3091c0d5c 100644 --- a/developer/04. Apps/06. App Change Process/02. Change App Lead Image.md +++ b/docs/developer/04. Apps/06. App Change Process/02. Change App Lead Image.md @@ -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]() +Functional Description: [click]()
diff --git a/developer/04. Apps/06. App Change Process/03. App Instance Url.md b/docs/developer/04. Apps/06. App Change Process/03. App Instance Url.md similarity index 87% rename from developer/04. Apps/06. App Change Process/03. App Instance Url.md rename to docs/developer/04. Apps/06. App Change Process/03. App Instance Url.md index cf7032800..3e5974d47 100644 --- a/developer/04. Apps/06. App Change Process/03. App Instance Url.md +++ b/docs/developer/04. Apps/06. App Change Process/03. App Instance Url.md @@ -6,7 +6,7 @@ Inside the board all active subscriptions can get viewed and filtered. Select th
-Functional Description: [Link]() +Functional Description: [Link]()

diff --git a/developer/04. Apps/06. App Change Process/03. Change App Description.md b/docs/developer/04. Apps/06. App Change Process/03. Change App Description.md similarity index 90% rename from developer/04. Apps/06. App Change Process/03. Change App Description.md rename to docs/developer/04. Apps/06. App Change Process/03. Change App Description.md index 9fbba5b96..896b17d8a 100644 --- a/developer/04. Apps/06. App Change Process/03. Change App Description.md +++ b/docs/developer/04. Apps/06. App Change Process/03. Change App Description.md @@ -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>)
diff --git a/developer/04. Apps/06. App Change Process/04. App Deactivation.md b/docs/developer/04. Apps/06. App Change Process/04. App Deactivation.md similarity index 100% rename from developer/04. Apps/06. App Change Process/04. App Deactivation.md rename to docs/developer/04. Apps/06. App Change Process/04. App Deactivation.md diff --git a/developer/04. Apps/06. App Change Process/05. App Instance Url.md b/docs/developer/04. Apps/06. App Change Process/05. App Instance Url.md similarity index 87% rename from developer/04. Apps/06. App Change Process/05. App Instance Url.md rename to docs/developer/04. Apps/06. App Change Process/05. App Instance Url.md index cf7032800..3e5974d47 100644 --- a/developer/04. Apps/06. App Change Process/05. App Instance Url.md +++ b/docs/developer/04. Apps/06. App Change Process/05. App Instance Url.md @@ -6,7 +6,7 @@ Inside the board all active subscriptions can get viewed and filtered. Select th
-Functional Description: [Link]() +Functional Description: [Link]()

diff --git a/developer/04. Apps/06. App Change Process/06. App Role Change.md b/docs/developer/04. Apps/06. App Change Process/06. App Role Change.md similarity index 87% rename from developer/04. Apps/06. App Change Process/06. App Role Change.md rename to docs/developer/04. Apps/06. App Change Process/06. App Role Change.md index 26fcad0d2..3825ce3a1 100644 --- a/developer/04. Apps/06. App Change Process/06. App Role Change.md +++ b/docs/developer/04. Apps/06. App Change Process/06. App Role Change.md @@ -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]() +Functional Description: [click]()
@@ -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)

diff --git a/developer/05. Service(s)/01. Service Change.md b/docs/developer/05. Service(s)/01. Service Change.md similarity index 100% rename from developer/05. Service(s)/01. Service Change.md rename to docs/developer/05. Service(s)/01. Service Change.md diff --git a/developer/05. Service(s)/01. Service Marketplace/01. Service Marketplace.md b/docs/developer/05. Service(s)/01. Service Marketplace/01. Service Marketplace.md similarity index 94% rename from developer/05. Service(s)/01. Service Marketplace/01. Service Marketplace.md rename to docs/developer/05. Service(s)/01. Service Marketplace/01. Service Marketplace.md index 7f0ef3839..a17076624 100644 --- a/developer/05. Service(s)/01. Service Marketplace/01. Service Marketplace.md +++ b/docs/developer/05. Service(s)/01. Service Marketplace/01. Service Marketplace.md @@ -9,8 +9,8 @@ Beside the generic list, services can get viewed in specific pre-configured view Links: -- [Functional Description]() -- [FAQ]() +- [Functional Description]() +- [FAQ]()

diff --git a/developer/05. Service(s)/01. Service Marketplace/02. Service Details.md b/docs/developer/05. Service(s)/01. Service Marketplace/02. Service Details.md similarity index 94% rename from developer/05. Service(s)/01. Service Marketplace/02. Service Details.md rename to docs/developer/05. Service(s)/01. Service Marketplace/02. Service Details.md index a00cfa863..4b72e8d79 100644 --- a/developer/05. Service(s)/01. Service Marketplace/02. Service Details.md +++ b/docs/developer/05. Service(s)/01. Service Marketplace/02. Service Details.md @@ -10,8 +10,8 @@ Beside the generic list, services can get viewed in specific pre-configured view Links: -- [Functional Description]() -- [FAQ]() +- [Functional Description]() +- [FAQ]()

diff --git a/developer/05. Service(s)/02. Service Release Process/01. Service Card.md b/docs/developer/05. Service(s)/02. Service Release Process/01. Service Card.md similarity index 100% rename from developer/05. Service(s)/02. Service Release Process/01. Service Card.md rename to docs/developer/05. Service(s)/02. Service Release Process/01. Service Card.md diff --git a/developer/05. Service(s)/02. Service Release Process/02. Service Detail Page.md b/docs/developer/05. Service(s)/02. Service Release Process/02. Service Detail Page.md similarity index 100% rename from developer/05. Service(s)/02. Service Release Process/02. Service Detail Page.md rename to docs/developer/05. Service(s)/02. Service Release Process/02. Service Detail Page.md diff --git a/developer/05. Service(s)/02. Service Release Process/02. Service Publish Approval.md b/docs/developer/05. Service(s)/02. Service Release Process/02. Service Publish Approval.md similarity index 97% rename from developer/05. Service(s)/02. Service Release Process/02. Service Publish Approval.md rename to docs/developer/05. Service(s)/02. Service Release Process/02. Service Publish Approval.md index 4f2ff42d1..8abbf172e 100644 --- a/developer/05. Service(s)/02. Service Release Process/02. Service Publish Approval.md +++ b/docs/developer/05. Service(s)/02. Service Release Process/02. Service Publish Approval.md @@ -10,7 +10,7 @@ Till that, the service publication is only available via api endpoints. Users ca Links: - [Functional Description]() -- [FAQ]() +- [FAQ]()

diff --git a/developer/05. Service(s)/02. Service Release Process/03.Terms&Conditions.md b/docs/developer/05. Service(s)/02. Service Release Process/03.Terms&Conditions.md similarity index 100% rename from developer/05. Service(s)/02. Service Release Process/03.Terms&Conditions.md rename to docs/developer/05. Service(s)/02. Service Release Process/03.Terms&Conditions.md diff --git a/developer/05. Service(s)/02. Service Release Process/04.Technical Integration.md b/docs/developer/05. Service(s)/02. Service Release Process/04.Technical Integration.md similarity index 100% rename from developer/05. Service(s)/02. Service Release Process/04.Technical Integration.md rename to docs/developer/05. Service(s)/02. Service Release Process/04.Technical Integration.md diff --git a/developer/05. Service(s)/02. Service Release Process/05.Verify & Submit.md b/docs/developer/05. Service(s)/02. Service Release Process/05.Verify & Submit.md similarity index 100% rename from developer/05. Service(s)/02. Service Release Process/05.Verify & Submit.md rename to docs/developer/05. Service(s)/02. Service Release Process/05.Verify & Submit.md diff --git a/developer/05. Service(s)/02. Service Release Process/index.md b/docs/developer/05. Service(s)/02. Service Release Process/index.md similarity index 100% rename from developer/05. Service(s)/02. Service Release Process/index.md rename to docs/developer/05. Service(s)/02. Service Release Process/index.md diff --git a/developer/05. Service(s)/03. Service Release Approval/01. Service Approval Board Overview.md b/docs/developer/05. Service(s)/03. Service Release Approval/01. Service Approval Board Overview.md similarity index 100% rename from developer/05. Service(s)/03. Service Release Approval/01. Service Approval Board Overview.md rename to docs/developer/05. Service(s)/03. Service Release Approval/01. Service Approval Board Overview.md diff --git a/developer/05. Service(s)/03. Service Release Approval/02. Service Details.md b/docs/developer/05. Service(s)/03. Service Release Approval/02. Service Details.md similarity index 100% rename from developer/05. Service(s)/03. Service Release Approval/02. Service Details.md rename to docs/developer/05. Service(s)/03. Service Release Approval/02. Service Details.md diff --git a/developer/05. Service(s)/03. Service Release Approval/03. Approve Service Release.md b/docs/developer/05. Service(s)/03. Service Release Approval/03. Approve Service Release.md similarity index 100% rename from developer/05. Service(s)/03. Service Release Approval/03. Approve Service Release.md rename to docs/developer/05. Service(s)/03. Service Release Approval/03. Approve Service Release.md diff --git a/developer/05. Service(s)/03. Service Release Approval/04. Decline Service Release.md b/docs/developer/05. Service(s)/03. Service Release Approval/04. Decline Service Release.md similarity index 100% rename from developer/05. Service(s)/03. Service Release Approval/04. Decline Service Release.md rename to docs/developer/05. Service(s)/03. Service Release Approval/04. Decline Service Release.md diff --git a/developer/05. Service(s)/03. Service Subscription/01. Service Subscription.md b/docs/developer/05. Service(s)/03. Service Subscription/01. Service Subscription.md similarity index 92% rename from developer/05. Service(s)/03. Service Subscription/01. Service Subscription.md rename to docs/developer/05. Service(s)/03. Service Subscription/01. Service Subscription.md index 06024277f..e30b2d0f4 100644 --- a/developer/05. Service(s)/03. Service Subscription/01. Service Subscription.md +++ b/docs/developer/05. Service(s)/03. Service Subscription/01. Service Subscription.md @@ -7,8 +7,8 @@ Service purchasing is describing the subscribe/purchase process of an service in Links: -[EndUser Docu]() -[FAQ]() +[EndUser Docu]() +[FAQ]()

diff --git a/developer/05. Service(s)/03. Service Subscription/01.Service Subscription Request Management.md b/docs/developer/05. Service(s)/03. Service Subscription/01.Service Subscription Request Management.md similarity index 95% rename from developer/05. Service(s)/03. Service Subscription/01.Service Subscription Request Management.md rename to docs/developer/05. Service(s)/03. Service Subscription/01.Service Subscription Request Management.md index 807d7c4b0..e4e73ff83 100644 --- a/developer/05. Service(s)/03. Service Subscription/01.Service Subscription Request Management.md +++ b/docs/developer/05. Service(s)/03. Service Subscription/01.Service Subscription Request Management.md @@ -16,8 +16,8 @@ The page includes following functions Links: -[Design]() -[FAQ]() +[Design]() +[FAQ]()

diff --git a/developer/05. Service(s)/03. Service Subscription/02. Service Subscription Activation (Provider).md b/docs/developer/05. Service(s)/03. Service Subscription/02. Service Subscription Activation (Provider).md similarity index 92% rename from developer/05. Service(s)/03. Service Subscription/02. Service Subscription Activation (Provider).md rename to docs/developer/05. Service(s)/03. Service Subscription/02. Service Subscription Activation (Provider).md index 374582f74..0b4d56d06 100644 --- a/developer/05. Service(s)/03. Service Subscription/02. Service Subscription Activation (Provider).md +++ b/docs/developer/05. Service(s)/03. Service Subscription/02. Service Subscription Activation (Provider).md @@ -5,8 +5,8 @@ Links: -[EndUser Docu]() -[FAQ]() +[EndUser Docu]() +[FAQ]()

diff --git a/developer/05. Service(s)/03. Service Subscription/03. Unsubscribe.md b/docs/developer/05. Service(s)/03. Service Subscription/03. Unsubscribe.md similarity index 91% rename from developer/05. Service(s)/03. Service Subscription/03. Unsubscribe.md rename to docs/developer/05. Service(s)/03. Service Subscription/03. Unsubscribe.md index d434d143e..7af117069 100644 --- a/developer/05. Service(s)/03. Service Subscription/03. Unsubscribe.md +++ b/docs/developer/05. Service(s)/03. Service Subscription/03. Unsubscribe.md @@ -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]() +[Functional Description]()

diff --git a/developer/05. Service(s)/04. Service Provider Management Board(s)/01. App Board.md b/docs/developer/05. Service(s)/04. Service Provider Management Board(s)/01. App Board.md similarity index 100% rename from developer/05. Service(s)/04. Service Provider Management Board(s)/01. App Board.md rename to docs/developer/05. Service(s)/04. Service Provider Management Board(s)/01. App Board.md diff --git a/developer/05. Service(s)/06. Service Change Process/01. Summary.md b/docs/developer/05. Service(s)/06. Service Change Process/01. Summary.md similarity index 100% rename from developer/05. Service(s)/06. Service Change Process/01. Summary.md rename to docs/developer/05. Service(s)/06. Service Change Process/01. Summary.md diff --git a/developer/05. Service(s)/06. Service Change Process/02. Service Deactivation.md b/docs/developer/05. Service(s)/06. Service Change Process/02. Service Deactivation.md similarity index 95% rename from developer/05. Service(s)/06. Service Change Process/02. Service Deactivation.md rename to docs/developer/05. Service(s)/06. Service Change Process/02. Service Deactivation.md index 4f73e70aa..3bad97920 100644 --- a/developer/05. Service(s)/06. Service Change Process/02. Service Deactivation.md +++ b/docs/developer/05. Service(s)/06. Service Change Process/02. Service Deactivation.md @@ -5,7 +5,7 @@ This feature gives users the power to control their own offers and allows them t
-Functional Details: [click here]() +Functional Details: [click here]()
diff --git a/developer/Technical Documentation/Architecture/Architecture Constraints.md b/docs/developer/Technical Documentation/Architecture/Architecture Constraints.md similarity index 100% rename from developer/Technical Documentation/Architecture/Architecture Constraints.md rename to docs/developer/Technical Documentation/Architecture/Architecture Constraints.md diff --git a/developer/Technical Documentation/Architecture/Building block view.md b/docs/developer/Technical Documentation/Architecture/Building block view.md similarity index 100% rename from developer/Technical Documentation/Architecture/Building block view.md rename to docs/developer/Technical Documentation/Architecture/Building block view.md diff --git a/developer/Technical Documentation/Architecture/Context and scope.md b/docs/developer/Technical Documentation/Architecture/Context and scope.md similarity index 100% rename from developer/Technical Documentation/Architecture/Context and scope.md rename to docs/developer/Technical Documentation/Architecture/Context and scope.md diff --git a/developer/Technical Documentation/Architecture/Development Concept.md b/docs/developer/Technical Documentation/Architecture/Development Concept.md similarity index 99% rename from developer/Technical Documentation/Architecture/Development Concept.md rename to docs/developer/Technical Documentation/Architecture/Development Concept.md index 50b367b6f..4d451ad46 100644 --- a/developer/Technical Documentation/Architecture/Development Concept.md +++ b/docs/developer/Technical Documentation/Architecture/Development Concept.md @@ -3,7 +3,7 @@ ## Build, test, deploy Details to the build, test and deploy process can get found under following link/md file: -https://github.com/catenax-ng/tx-portal-assets/blob/945546d91065b8870aa8f69ce94b48eac7a5ade2/docs/Release-Process.md +https://github.com/catenax-ng/tx-portal-assets/blob/945546d91065b8870aa8f69ce94b48eac7a5ade2/docs/user/Release-Process.md

diff --git a/developer/Technical Documentation/Architecture/Requirements.md b/docs/developer/Technical Documentation/Architecture/Requirements.md similarity index 100% rename from developer/Technical Documentation/Architecture/Requirements.md rename to docs/developer/Technical Documentation/Architecture/Requirements.md diff --git a/developer/Technical Documentation/Architecture/Security-Assessment.md b/docs/developer/Technical Documentation/Architecture/Security-Assessment.md similarity index 92% rename from developer/Technical Documentation/Architecture/Security-Assessment.md rename to docs/developer/Technical Documentation/Architecture/Security-Assessment.md index b3426b580..090d49aa0 100644 --- a/developer/Technical Documentation/Architecture/Security-Assessment.md +++ b/docs/developer/Technical Documentation/Architecture/Security-Assessment.md @@ -209,47 +209,7 @@ All threats identified are mitigated. - Container Scan conducted - Trivy - Infrastructure as Code - KICS -### Penetration Testing - -The lasted Penetration Test by an external security testing company was performed on version 1.6.0-RC1 and took place during the period of July-August 2023. - -The following overview shows the open findings at the time of the release of version 1.7.0: - -```mermaid -gantt - title Findings Portal Backend - dateFormat X - axisFormat %s - - section Critical - 0 : 0, 0 - section High - 0 : 0, 0 - section Medium - 2 : 0, 2 - section Low - 5 : 0, 5 - -``` - -```mermaid -gantt - title Findings Portal Frontend - dateFormat X - axisFormat %s - - section Critical - 0 : 0, 0 - section High - 0 : 0, 0 - section Medium - 2 : 0, 2 - section Low - 5 : 0, 5 - -``` - -As outlined in the [Security Policy](../../../SECURITY.md), the findings will be documented as security advisories. +Also see [Penetrations Tests](../Tests/Tests.md#penetration-tests). ## NOTICE diff --git a/developer/Technical Documentation/Architecture/Solution strategy.md b/docs/developer/Technical Documentation/Architecture/Solution strategy.md similarity index 100% rename from developer/Technical Documentation/Architecture/Solution strategy.md rename to docs/developer/Technical Documentation/Architecture/Solution strategy.md diff --git a/developer/Technical Documentation/Architecture/Whitebox Overall System.md b/docs/developer/Technical Documentation/Architecture/Whitebox Overall System.md similarity index 100% rename from developer/Technical Documentation/Architecture/Whitebox Overall System.md rename to docs/developer/Technical Documentation/Architecture/Whitebox Overall System.md diff --git a/developer/Technical Documentation/Architecture/operational-concept.md b/docs/developer/Technical Documentation/Architecture/operational-concept.md similarity index 96% rename from developer/Technical Documentation/Architecture/operational-concept.md rename to docs/developer/Technical Documentation/Architecture/operational-concept.md index 3333c3615..24679e50a 100644 --- a/developer/Technical Documentation/Architecture/operational-concept.md +++ b/docs/developer/Technical Documentation/Architecture/operational-concept.md @@ -32,7 +32,7 @@ Note: will be added soon ## Logging -The portal supports application and db logging. Details are stored here: https://github.com/catenax-ng/tx-portal-assets/blob/945546d91065b8870aa8f69ce94b48eac7a5ade2/docs/Technical%20Details/Auditing.md +The portal supports application and db logging. Details are stored here: https://github.com/catenax-ng/tx-portal-assets/blob/945546d91065b8870aa8f69ce94b48eac7a5ade2/docs/user/Technical%20Details/Auditing.md ## Monitoring diff --git a/developer/Technical Documentation/DB Views and Details/App - DB - View.md b/docs/developer/Technical Documentation/DB Views and Details/App - DB - View.md similarity index 100% rename from developer/Technical Documentation/DB Views and Details/App - DB - View.md rename to docs/developer/Technical Documentation/DB Views and Details/App - DB - View.md diff --git a/developer/Technical Documentation/DB Views and Details/Connector - DB - View.md b/docs/developer/Technical Documentation/DB Views and Details/Connector - DB - View.md similarity index 100% rename from developer/Technical Documentation/DB Views and Details/Connector - DB - View.md rename to docs/developer/Technical Documentation/DB Views and Details/Connector - DB - View.md diff --git a/developer/Technical Documentation/DB Views and Details/Data Management.md b/docs/developer/Technical Documentation/DB Views and Details/Data Management.md similarity index 100% rename from developer/Technical Documentation/DB Views and Details/Data Management.md rename to docs/developer/Technical Documentation/DB Views and Details/Data Management.md diff --git a/developer/Technical Documentation/DB Views and Details/Documents - DB - View.md b/docs/developer/Technical Documentation/DB Views and Details/Documents - DB - View.md similarity index 89% rename from developer/Technical Documentation/DB Views and Details/Documents - DB - View.md rename to docs/developer/Technical Documentation/DB Views and Details/Documents - DB - View.md index 13dba9b0b..f80299c67 100644 --- a/developer/Technical Documentation/DB Views and Details/Documents - DB - View.md +++ b/docs/developer/Technical Documentation/DB Views and Details/Documents - DB - View.md @@ -19,7 +19,7 @@ Mainly 4 tables are used for the documents itself

-Details to the documents service implementation can get found [here](/developer/Technical%20Documentation/Services/Document_Management.md#summary) +Details to the documents service implementation can get found [here](/docs/developer/Technical%20Documentation/Services/Document_Management.md#summary) ## NOTICE diff --git a/developer/Technical Documentation/DB Views and Details/Subscription - DB - View.md b/docs/developer/Technical Documentation/DB Views and Details/Subscription - DB - View.md similarity index 100% rename from developer/Technical Documentation/DB Views and Details/Subscription - DB - View.md rename to docs/developer/Technical Documentation/DB Views and Details/Subscription - DB - View.md diff --git a/developer/Technical Documentation/Dev Process/Dev-flow_deploy-dev-env.md b/docs/developer/Technical Documentation/Dev Process/Dev-flow_deploy-dev-env.md similarity index 100% rename from developer/Technical Documentation/Dev Process/Dev-flow_deploy-dev-env.md rename to docs/developer/Technical Documentation/Dev Process/Dev-flow_deploy-dev-env.md diff --git a/developer/Technical Documentation/Dev Process/Dev-flow_git-diagram.md b/docs/developer/Technical Documentation/Dev Process/Dev-flow_git-diagram.md similarity index 100% rename from developer/Technical Documentation/Dev Process/Dev-flow_git-diagram.md rename to docs/developer/Technical Documentation/Dev Process/Dev-flow_git-diagram.md diff --git a/developer/Technical Documentation/Dev Process/Enumeration Handling.md b/docs/developer/Technical Documentation/Dev Process/Enumeration Handling.md similarity index 100% rename from developer/Technical Documentation/Dev Process/Enumeration Handling.md rename to docs/developer/Technical Documentation/Dev Process/Enumeration Handling.md diff --git a/developer/Technical Documentation/Dev Process/How to contribute.md b/docs/developer/Technical Documentation/Dev Process/How to contribute.md similarity index 100% rename from developer/Technical Documentation/Dev Process/How to contribute.md rename to docs/developer/Technical Documentation/Dev Process/How to contribute.md diff --git a/developer/Technical Documentation/Dev Process/Multi Language.md b/docs/developer/Technical Documentation/Dev Process/Multi Language.md similarity index 100% rename from developer/Technical Documentation/Dev Process/Multi Language.md rename to docs/developer/Technical Documentation/Dev Process/Multi Language.md diff --git a/developer/Technical Documentation/Dev Process/Run frontend on localhost.md b/docs/developer/Technical Documentation/Dev Process/Run frontend on localhost.md similarity index 98% rename from developer/Technical Documentation/Dev Process/Run frontend on localhost.md rename to docs/developer/Technical Documentation/Dev Process/Run frontend on localhost.md index ab0b00735..61a31afb3 100644 --- a/developer/Technical Documentation/Dev Process/Run frontend on localhost.md +++ b/docs/developer/Technical Documentation/Dev Process/Run frontend on localhost.md @@ -8,7 +8,7 @@ The portal frontend is divided into three parts - Registration -> (/registration) - Assets -> (/assets, /documentation) -![Schema of a local frontend environment](https://raw.githubusercontent.com/catenax-ng/tx-portal-assets/main/public/assets/images/docs/frontend-localhost.svg) +![Schema of a local frontend environment](https://raw.githubusercontent.com/catenax-ng/tx-portal-assets/main/public/assets/images/docs/user/frontend-localhost.svg) Each of these is running as a separate web server process. In the final deployment the Kubernetes ingress controllers redirect requests to the according servers based on URL paths. To the client the application appears as one origin, so no CORS problems arise. To run the entire frontend on your local machine follow these steps. diff --git a/developer/Technical Documentation/Dev Process/Shared Components.md b/docs/developer/Technical Documentation/Dev Process/Shared Components.md similarity index 100% rename from developer/Technical Documentation/Dev Process/Shared Components.md rename to docs/developer/Technical Documentation/Dev Process/Shared Components.md diff --git a/developer/Technical Documentation/Interface Contracts/BPDM (2).md b/docs/developer/Technical Documentation/Interface Contracts/BPDM (2).md similarity index 100% rename from developer/Technical Documentation/Interface Contracts/BPDM (2).md rename to docs/developer/Technical Documentation/Interface Contracts/BPDM (2).md diff --git a/developer/Technical Documentation/Interface Contracts/BPDM.md b/docs/developer/Technical Documentation/Interface Contracts/BPDM.md similarity index 94% rename from developer/Technical Documentation/Interface Contracts/BPDM.md rename to docs/developer/Technical Documentation/Interface Contracts/BPDM.md index 5d3c5337f..5cc070077 100644 --- a/developer/Technical Documentation/Interface Contracts/BPDM.md +++ b/docs/developer/Technical Documentation/Interface Contracts/BPDM.md @@ -4,10 +4,10 @@ Business Partner Data Management as a product as well as the portal have three different interfaces: -- [Search Existing Business Partners](/developer/Technical%20Documentation/Interface%20Contracts/BPDM.md#search-existing-business-partners) -- [Push New Business Partners](/developer/Technical%20Documentation/Interface%20Contracts/BPDM.md#push-new-business-partners) -- [Pull New Business Partner BPNL](/developer/Technical%20Documentation/Interface%20Contracts/BPDM.md#pull-new-business-partners) -- [Partner Network Connect](/developer/Technical%20Documentation/Interface%20Contracts/BPDM.md#partner-network-connect) +- [Search Existing Business Partners](/docs/developer/Technical%20Documentation/Interface%20Contracts/BPDM.md#search-existing-business-partners) +- [Push New Business Partners](/docs/developer/Technical%20Documentation/Interface%20Contracts/BPDM.md#push-new-business-partners) +- [Pull New Business Partner BPNL](/docs/developer/Technical%20Documentation/Interface%20Contracts/BPDM.md#pull-new-business-partners) +- [Partner Network Connect](/docs/developer/Technical%20Documentation/Interface%20Contracts/BPDM.md#partner-network-connect)

diff --git a/developer/Technical Documentation/Interface Contracts/CX-Membership.md b/docs/developer/Technical Documentation/Interface Contracts/CX-Membership.md similarity index 88% rename from developer/Technical Documentation/Interface Contracts/CX-Membership.md rename to docs/developer/Technical Documentation/Interface Contracts/CX-Membership.md index 53d6452d9..585ccf381 100644 --- a/developer/Technical Documentation/Interface Contracts/CX-Membership.md +++ b/docs/developer/Technical Documentation/Interface Contracts/CX-Membership.md @@ -21,7 +21,7 @@ n/a The cx membership discovery endpoint can get triggered via technical as well as real users, if relevant roles are available. For technical user, a company can request the user creation via the link to technical user creation. For details, click following link: -[Technical User Management](/docs/03.%20User%20Management/03.%20Technical%20User/02.%20Create%20Technical%20User.md#create-a-new-technical-user) +[Technical User Management](/docs/user/03.%20User%20Management/03.%20Technical%20User/02.%20Create%20Technical%20User.md#create-a-new-technical-user)
```diff diff --git a/developer/Technical Documentation/Interface Contracts/Clearinghouse.md b/docs/developer/Technical Documentation/Interface Contracts/Clearinghouse.md similarity index 89% rename from developer/Technical Documentation/Interface Contracts/Clearinghouse.md rename to docs/developer/Technical Documentation/Interface Contracts/Clearinghouse.md index c3a53e8d9..cfe079cbf 100644 --- a/developer/Technical Documentation/Interface Contracts/Clearinghouse.md +++ b/docs/developer/Technical Documentation/Interface Contracts/Clearinghouse.md @@ -2,8 +2,8 @@
-- [Legal Participant Self Description Creation](/developer/Technical%20Documentation/Interface%20Contracts/Clearinghouse.md#1-notarization-check) -- [Connector/Service Self Description Creation](/developer/Technical%20Documentation/Interface%20Contracts/Clearinghouse.md#2-compliance-check) +- [Legal Participant Self Description Creation](/docs/developer/Technical%20Documentation/Interface%20Contracts/Clearinghouse.md#1-notarization-check) +- [Connector/Service Self Description Creation](/docs/developer/Technical%20Documentation/Interface%20Contracts/Clearinghouse.md#2-compliance-check)

diff --git a/developer/Technical Documentation/Interface Contracts/Dataspace-Discovery.md b/docs/developer/Technical Documentation/Interface Contracts/Dataspace-Discovery.md similarity index 92% rename from developer/Technical Documentation/Interface Contracts/Dataspace-Discovery.md rename to docs/developer/Technical Documentation/Interface Contracts/Dataspace-Discovery.md index 4caafc234..9fbd9cb70 100644 --- a/developer/Technical Documentation/Interface Contracts/Dataspace-Discovery.md +++ b/docs/developer/Technical Documentation/Interface Contracts/Dataspace-Discovery.md @@ -20,7 +20,7 @@ n/a The edc discovery endpoint can get triggered via technical as well as real users, if relevant roles are available. For technical user, a company can request the user creation with the technical user creation feature inside the portal. -For details, click following link: [Technical User Management](/docs/03.%20User%20Management/03.%20Technical%20User/02.%20Create%20Technical%20User.md#create-a-new-technical-user) +For details, click following link: [Technical User Management](/docs/user/03.%20User%20Management/03.%20Technical%20User/02.%20Create%20Technical%20User.md#create-a-new-technical-user)
```diff diff --git a/developer/Technical Documentation/Interface Contracts/Managed Wallets.md b/docs/developer/Technical Documentation/Interface Contracts/Managed Wallets.md similarity index 86% rename from developer/Technical Documentation/Interface Contracts/Managed Wallets.md rename to docs/developer/Technical Documentation/Interface Contracts/Managed Wallets.md index e23dffe0e..3547c42a0 100644 --- a/developer/Technical Documentation/Interface Contracts/Managed Wallets.md +++ b/docs/developer/Technical Documentation/Interface Contracts/Managed Wallets.md @@ -65,7 +65,7 @@ Relevant endpoints from MIW side:
-Additional Details: [Click here](/developer/02.%20Technical%20Integration/04.%20Credentials/00.%20Wallet%20Creation.md) +Additional Details: [Click here](/docs/developer/02.%20Technical%20Integration/04.%20Credentials/00.%20Wallet%20Creation.md)

@@ -76,7 +76,7 @@ Additional Details: [Click here](/developer/02.%20Technical%20Integration/04.%20
-Additional Details: [Click here](/developer/02.%20Technical%20Integration/04.%20Credentials/01.%20Get%20UseCase%20Credential.md) +Additional Details: [Click here](/docs/developer/02.%20Technical%20Integration/04.%20Credentials/01.%20Get%20UseCase%20Credential.md)

@@ -87,7 +87,7 @@ Additional Details: [Click here](/developer/02.%20Technical%20Integration/04.%20
-Additional Details: [Click here](/developer/02.%20Technical%20Integration/04.%20Credentials/02.%20Other%20Certificates.md) +Additional Details: [Click here](/docs/developer/02.%20Technical%20Integration/04.%20Credentials/02.%20Other%20Certificates.md)

diff --git a/developer/Technical Documentation/Interface Contracts/Offer-Autosetup.md b/docs/developer/Technical Documentation/Interface Contracts/Offer-Autosetup.md similarity index 100% rename from developer/Technical Documentation/Interface Contracts/Offer-Autosetup.md rename to docs/developer/Technical Documentation/Interface Contracts/Offer-Autosetup.md diff --git a/developer/Technical Documentation/Interface Contracts/Self Description.md b/docs/developer/Technical Documentation/Interface Contracts/Self Description.md similarity index 100% rename from developer/Technical Documentation/Interface Contracts/Self Description.md rename to docs/developer/Technical Documentation/Interface Contracts/Self Description.md diff --git a/developer/Technical Documentation/Operations/Auditing.md b/docs/developer/Technical Documentation/Operations/Auditing.md similarity index 100% rename from developer/Technical Documentation/Operations/Auditing.md rename to docs/developer/Technical Documentation/Operations/Auditing.md diff --git a/developer/Technical Documentation/Operations/Release-Process.md b/docs/developer/Technical Documentation/Operations/Release-Process.md similarity index 100% rename from developer/Technical Documentation/Operations/Release-Process.md rename to docs/developer/Technical Documentation/Operations/Release-Process.md diff --git a/developer/Technical Documentation/Others/Document Management.md b/docs/developer/Technical Documentation/Others/Document Management.md similarity index 100% rename from developer/Technical Documentation/Others/Document Management.md rename to docs/developer/Technical Documentation/Others/Document Management.md diff --git a/developer/Technical Documentation/Others/Email Templates.md b/docs/developer/Technical Documentation/Others/Email Templates.md similarity index 100% rename from developer/Technical Documentation/Others/Email Templates.md rename to docs/developer/Technical Documentation/Others/Email Templates.md diff --git a/developer/Technical Documentation/Others/Images, Graphics and Diagrams.md b/docs/developer/Technical Documentation/Others/Images, Graphics and Diagrams.md similarity index 70% rename from developer/Technical Documentation/Others/Images, Graphics and Diagrams.md rename to docs/developer/Technical Documentation/Others/Images, Graphics and Diagrams.md index 117188015..c2b650ad5 100644 --- a/developer/Technical Documentation/Others/Images, Graphics and Diagrams.md +++ b/docs/developer/Technical Documentation/Others/Images, Graphics and Diagrams.md @@ -69,12 +69,12 @@ And obviously there is no way to represent unstructured image content like photo Some examples of different image types in different file formats and encodings: -| Example | SVG | PNG (RGB) | PNG (Indexed Color) | JPEG (95% Quality) | JPEG (30% Quality) | -| ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Icons, Logos |
1,361 bytes |
10,564 bytes |
1,831 bytes (8 colors) |
12,259 bytes |
4,383 bytes | -| Diagrams |
1,831 bytes |
34,920 bytes |
7,077 bytes (16 colors) |
21,696 bytes |
5,954 bytes | -| Documents | āŒ |
28,603 bytes |
4,138 bytes (12 colors) |
19,497 bytes |
5,884 bytes | -| Photographs | āŒ |
118,325 bytes |
24,973 bytes (128 colors) |
38,278 bytes |
9,102 bytes | +| Example | SVG | PNG (RGB) | PNG (Indexed Color) | JPEG (95% Quality) | JPEG (30% Quality) | +| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| Icons, Logos |
1,361 bytes |
10,564 bytes |
1,831 bytes (8 colors) |
12,259 bytes |
4,383 bytes | +| Diagrams |
1,831 bytes |
34,920 bytes |
7,077 bytes (16 colors) |
21,696 bytes |
5,954 bytes | +| Documents | āŒ |
28,603 bytes |
4,138 bytes (12 colors) |
19,497 bytes |
5,884 bytes | +| Photographs | āŒ |
118,325 bytes |
24,973 bytes (128 colors) |
38,278 bytes |
9,102 bytes |
@@ -88,23 +88,23 @@ Vector images like SVG will look sharp at any resolution because the image is "d JPEG Bitmap, 30% Quality, 4x size
Extreme lossy compression results in a small file size but poor image quality with heavy artifacts.
- + JPEG Bitmap, 95% Quality, 4x size
A few compression artifacts especially around letters.
- + PNG Bitmap, indexed 16 colors, 4x size
Reducing the image to 16 colors also reduces the file size but gradients and fonts look weird.
- + PNG Bitmap, RGB, 4x size
The best bitmap quality but comes with a large file size.
- + SVG Vector, 4x size
Smallest file size and best quality.
- +
@@ -127,7 +127,7 @@ Images are large and often we don't want to send them over the network every tim Follow this (SVG) decision diagram to find the optimal image encoding. - + Choosing an image for use on a web page is a trade-off between file size and quality of display. The file format has the biggest impact on the result. High quality, high resolution bitmap images look very beautiful on the screen but often come as big files that takes very long to load. Always try to keep the file size as small as possible while preserving an acceptable quality for the user. As a rule of thumb, the file size of any image should not exceed 100kB. Whenever the image type allows to use SVG, then use SVG as it usually is the best choice combining the smallest file size together with best image quality. diff --git a/developer/Technical Documentation/Others/Notifications.md b/docs/developer/Technical Documentation/Others/Notifications.md similarity index 100% rename from developer/Technical Documentation/Others/Notifications.md rename to docs/developer/Technical Documentation/Others/Notifications.md diff --git a/developer/Technical Documentation/TestAutomation/01. Summary.md b/docs/developer/Technical Documentation/Tests/Automation/01. Summary.md similarity index 100% rename from developer/Technical Documentation/TestAutomation/01. Summary.md rename to docs/developer/Technical Documentation/Tests/Automation/01. Summary.md diff --git a/developer/Technical Documentation/TestAutomation/02. Access Token Retrieval.md b/docs/developer/Technical Documentation/Tests/Automation/02. Access Token Retrieval.md similarity index 100% rename from developer/Technical Documentation/TestAutomation/02. Access Token Retrieval.md rename to docs/developer/Technical Documentation/Tests/Automation/02. Access Token Retrieval.md diff --git a/developer/Technical Documentation/TestAutomation/03. InterfacePartnerHealthCheck.md b/docs/developer/Technical Documentation/Tests/Automation/03. InterfacePartnerHealthCheck.md similarity index 100% rename from developer/Technical Documentation/TestAutomation/03. InterfacePartnerHealthCheck.md rename to docs/developer/Technical Documentation/Tests/Automation/03. InterfacePartnerHealthCheck.md diff --git a/developer/Technical Documentation/TestAutomation/04. PortalHealthCheck.md b/docs/developer/Technical Documentation/Tests/Automation/04. PortalHealthCheck.md similarity index 100% rename from developer/Technical Documentation/TestAutomation/04. PortalHealthCheck.md rename to docs/developer/Technical Documentation/Tests/Automation/04. PortalHealthCheck.md diff --git a/developer/Technical Documentation/TestAutomation/05. RegistrationScenarios.md b/docs/developer/Technical Documentation/Tests/Automation/05. RegistrationScenarios.md similarity index 100% rename from developer/Technical Documentation/TestAutomation/05. RegistrationScenarios.md rename to docs/developer/Technical Documentation/Tests/Automation/05. RegistrationScenarios.md diff --git a/developer/Technical Documentation/TestAutomation/06. NotificiationInitScenario.md b/docs/developer/Technical Documentation/Tests/Automation/06. NotificiationInitScenario.md similarity index 100% rename from developer/Technical Documentation/TestAutomation/06. NotificiationInitScenario.md rename to docs/developer/Technical Documentation/Tests/Automation/06. NotificiationInitScenario.md diff --git a/developer/Technical Documentation/TestAutomation/07. ServiceAccountCUDScenarios.md b/docs/developer/Technical Documentation/Tests/Automation/07. ServiceAccountCUDScenarios.md similarity index 100% rename from developer/Technical Documentation/TestAutomation/07. ServiceAccountCUDScenarios.md rename to docs/developer/Technical Documentation/Tests/Automation/07. ServiceAccountCUDScenarios.md diff --git a/developer/Technical Documentation/TestAutomation/08. TestDataFileSetup.md b/docs/developer/Technical Documentation/Tests/Automation/08. TestDataFileSetup.md similarity index 100% rename from developer/Technical Documentation/TestAutomation/08. TestDataFileSetup.md rename to docs/developer/Technical Documentation/Tests/Automation/08. TestDataFileSetup.md diff --git a/developer/Technical Documentation/TestAutomation/09. CreateAppScenario.md b/docs/developer/Technical Documentation/Tests/Automation/09. CreateAppScenario.md similarity index 100% rename from developer/Technical Documentation/TestAutomation/09. CreateAppScenario.md rename to docs/developer/Technical Documentation/Tests/Automation/09. CreateAppScenario.md diff --git a/developer/Technical Documentation/TestAutomation/10. ReportPortal.md b/docs/developer/Technical Documentation/Tests/Automation/10. ReportPortal.md similarity index 96% rename from developer/Technical Documentation/TestAutomation/10. ReportPortal.md rename to docs/developer/Technical Documentation/Tests/Automation/10. ReportPortal.md index e7550081c..a3cb48e4d 100644 --- a/developer/Technical Documentation/TestAutomation/10. ReportPortal.md +++ b/docs/developer/Technical Documentation/Tests/Automation/10. ReportPortal.md @@ -1,6 +1,6 @@ # ReportPortal -The documentation for the tool can be found [here](https://reportportal.io/docs/). +The documentation for the tool can be found [here](https://reportportal.io/docs/user/). The implementation of - [How to deploy ReportPortal](#how-to-deploy-reportportal) @@ -18,7 +18,7 @@ steps for local deployment are documented [here](https://github.com/reportportal ## Widget configuration -The following widgets should be configured according to the [docs](https://reportportal.io/docs/): +The following widgets should be configured according to the [docs](https://reportportal.io/docs/user/): - Passing rate per launch - Most popular pattern table diff --git a/docs/developer/Technical Documentation/Tests/Tests.md b/docs/developer/Technical Documentation/Tests/Tests.md new file mode 100644 index 000000000..93bf456fe --- /dev/null +++ b/docs/developer/Technical Documentation/Tests/Tests.md @@ -0,0 +1,78 @@ +## Summary + +
+
+ +## Unit Tests + +Unit tests are available for backend and frontend components and getting automatically executed as part of the code commits inside the CX NG. + +
+
+ +## Test Automation + +Information about the automation of functional e2e tests can be found under [Automation](./Automation). + +
+
+ +## Manual Tests + +Manual tests are executed and documented inside the Catena-X consortia. Currently, manual tests are not openly available. + +
+
+ +## Penetration Tests + +The lasted Penetration Test was performed on version 1.6.0-RC1 by an external security testing company and took place during the period of July-August 2023. + +The following overview shows the open findings at the time of the release of version 1.7.0: + +```mermaid +gantt + title Findings Portal Backend + dateFormat X + axisFormat %s + + section Critical + 0 : 0, 0 + section High + 0 : 0, 0 + section Medium + 2 : 0, 2 + section Low + 5 : 0, 5 + +``` + +```mermaid +gantt + title Findings Portal Frontend + dateFormat X + axisFormat %s + + section Critical + 0 : 0, 0 + section High + 0 : 0, 0 + section Medium + 2 : 0, 2 + section Low + 5 : 0, 5 + +``` + +As outlined in the [Security Policy](../../../SECURITY.md), the findings are documented as security advisories. + +
+
+ +## 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: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/Technical Documentation/Version Upgrade/portal-upgrade-details.md b/docs/developer/Technical Documentation/Version Upgrade/portal-upgrade-details.md similarity index 99% rename from developer/Technical Documentation/Version Upgrade/portal-upgrade-details.md rename to docs/developer/Technical Documentation/Version Upgrade/portal-upgrade-details.md index 91bcd3aec..1770b78ed 100644 --- a/developer/Technical Documentation/Version Upgrade/portal-upgrade-details.md +++ b/docs/developer/Technical Documentation/Version Upgrade/portal-upgrade-details.md @@ -34,7 +34,7 @@ Each section includes the respective change details, impact on existing data and Please be aware that the PostgreSQL version of the subchart by Bitnami of the [portal helm chart](https://github.com/eclipse-tractusx/portal-cd) is upgraded from 14.5.0 to 15.4.x (dependency updated from version 11.9.13 to 12.12.x). -In case you are using an external PostgreSQL instance and would like to upgrade to 15.x, please follow the [official instructions](https://www.postgresql.org/docs/15/upgrading.html). +In case you are using an external PostgreSQL instance and would like to upgrade to 15.x, please follow the [official instructions](https://www.postgresql.org/docs/user/15/upgrading.html). In case you would like to upgrade the PostgreSQL subchart from Bitnami, we recommend a blue-green deployment approach. In the following, you find a rough outline of the necessary steps: @@ -46,7 +46,7 @@ In case you would like to upgrade the PostgreSQL subchart from Bitnami, we recom 6. Make sure that the database migrations jobs which are defined as post-upgrade hooks are completed successfully 7. Once the new/green instance is validated, switch the user traffic to it -For restoring the data of the blue instance to the green instance (step 4), execute the following statement using [pg-dumpall](https://www.postgresql.org/docs/current/app-pg-dumpall.html): +For restoring the data of the blue instance to the green instance (step 4), execute the following statement using [pg-dumpall](https://www.postgresql.org/docs/user/current/app-pg-dumpall.html): On the cluster: diff --git a/docs/01. Onboarding/01. Registration Invite/01. Summary.md b/docs/user/01. Onboarding/01. Registration Invite/01. Summary.md similarity index 100% rename from docs/01. Onboarding/01. Registration Invite/01. Summary.md rename to docs/user/01. Onboarding/01. Registration Invite/01. Summary.md diff --git a/docs/01. Onboarding/01. Registration Invite/02. FAQ.md b/docs/user/01. Onboarding/01. Registration Invite/02. FAQ.md similarity index 100% rename from docs/01. Onboarding/01. Registration Invite/02. FAQ.md rename to docs/user/01. Onboarding/01. Registration Invite/02. FAQ.md diff --git a/docs/01. Onboarding/01. Registration Invite/index.md b/docs/user/01. Onboarding/01. Registration Invite/index.md similarity index 100% rename from docs/01. Onboarding/01. Registration Invite/index.md rename to docs/user/01. Onboarding/01. Registration Invite/index.md diff --git a/docs/01. Onboarding/02. Registration/01. Login.md b/docs/user/01. Onboarding/02. Registration/01. Login.md similarity index 100% rename from docs/01. Onboarding/02. Registration/01. Login.md rename to docs/user/01. Onboarding/02. Registration/01. Login.md diff --git a/docs/01. Onboarding/02. Registration/02. Add Company Data.md b/docs/user/01. Onboarding/02. Registration/02. Add Company Data.md similarity index 100% rename from docs/01. Onboarding/02. Registration/02. Add Company Data.md rename to docs/user/01. Onboarding/02. Registration/02. Add Company Data.md diff --git a/docs/01. Onboarding/02. Registration/03. Add Additional User(s).md b/docs/user/01. Onboarding/02. Registration/03. Add Additional User(s).md similarity index 100% rename from docs/01. Onboarding/02. Registration/03. Add Additional User(s).md rename to docs/user/01. Onboarding/02. Registration/03. Add Additional User(s).md diff --git a/docs/01. Onboarding/02. Registration/04. Company Role & Consent.md b/docs/user/01. Onboarding/02. Registration/04. Company Role & Consent.md similarity index 100% rename from docs/01. Onboarding/02. Registration/04. Company Role & Consent.md rename to docs/user/01. Onboarding/02. Registration/04. Company Role & Consent.md diff --git a/docs/01. Onboarding/02. Registration/05. Document Upload.md b/docs/user/01. Onboarding/02. Registration/05. Document Upload.md similarity index 100% rename from docs/01. Onboarding/02. Registration/05. Document Upload.md rename to docs/user/01. Onboarding/02. Registration/05. Document Upload.md diff --git a/docs/01. Onboarding/02. Registration/06. Verify Registration Data.md b/docs/user/01. Onboarding/02. Registration/06. Verify Registration Data.md similarity index 100% rename from docs/01. Onboarding/02. Registration/06. Verify Registration Data.md rename to docs/user/01. Onboarding/02. Registration/06. Verify Registration Data.md diff --git a/docs/01. Onboarding/02. Registration/07. FAQ.md b/docs/user/01. Onboarding/02. Registration/07. FAQ.md similarity index 100% rename from docs/01. Onboarding/02. Registration/07. FAQ.md rename to docs/user/01. Onboarding/02. Registration/07. FAQ.md diff --git a/docs/01. Onboarding/02. Registration/index.md b/docs/user/01. Onboarding/02. Registration/index.md similarity index 100% rename from docs/01. Onboarding/02. Registration/index.md rename to docs/user/01. Onboarding/02. Registration/index.md diff --git a/docs/01. Onboarding/03. Registration Approval/02. View Company Application(s).md b/docs/user/01. Onboarding/03. Registration Approval/02. View Company Application(s).md similarity index 100% rename from docs/01. Onboarding/03. Registration Approval/02. View Company Application(s).md rename to docs/user/01. Onboarding/03. Registration Approval/02. View Company Application(s).md diff --git a/docs/01. Onboarding/03. Registration Approval/03. Registration Approval Process.md b/docs/user/01. Onboarding/03. Registration Approval/03. Registration Approval Process.md similarity index 100% rename from docs/01. Onboarding/03. Registration Approval/03. Registration Approval Process.md rename to docs/user/01. Onboarding/03. Registration Approval/03. Registration Approval Process.md diff --git a/docs/01. Onboarding/03. Registration Approval/04. Decline Application.md b/docs/user/01. Onboarding/03. Registration Approval/04. Decline Application.md similarity index 100% rename from docs/01. Onboarding/03. Registration Approval/04. Decline Application.md rename to docs/user/01. Onboarding/03. Registration Approval/04. Decline Application.md diff --git a/docs/01. Onboarding/03. Registration Approval/05. FAQ.md b/docs/user/01. Onboarding/03. Registration Approval/05. FAQ.md similarity index 100% rename from docs/01. Onboarding/03. Registration Approval/05. FAQ.md rename to docs/user/01. Onboarding/03. Registration Approval/05. FAQ.md diff --git a/docs/01. Onboarding/03. Registration Approval/index.md b/docs/user/01. Onboarding/03. Registration Approval/index.md similarity index 100% rename from docs/01. Onboarding/03. Registration Approval/index.md rename to docs/user/01. Onboarding/03. Registration Approval/index.md diff --git a/docs/01. Onboarding/index.md b/docs/user/01. Onboarding/index.md similarity index 100% rename from docs/01. Onboarding/index.md rename to docs/user/01. Onboarding/index.md diff --git a/docs/02. Technical Integration/01. Connector Registration/00. Summary.md b/docs/user/02. Technical Integration/01. Connector Registration/00. Summary.md similarity index 100% rename from docs/02. Technical Integration/01. Connector Registration/00. Summary.md rename to docs/user/02. Technical Integration/01. Connector Registration/00. Summary.md diff --git a/docs/02. Technical Integration/01. Connector Registration/01. Connector Overview.md b/docs/user/02. Technical Integration/01. Connector Registration/01. Connector Overview.md similarity index 100% rename from docs/02. Technical Integration/01. Connector Registration/01. Connector Overview.md rename to docs/user/02. Technical Integration/01. Connector Registration/01. Connector Overview.md diff --git a/docs/02. Technical Integration/01. Connector Registration/02. Connector Registration.md b/docs/user/02. Technical Integration/01. Connector Registration/02. Connector Registration.md similarity index 100% rename from docs/02. Technical Integration/01. Connector Registration/02. Connector Registration.md rename to docs/user/02. Technical Integration/01. Connector Registration/02. Connector Registration.md diff --git a/docs/02. Technical Integration/01. Connector Registration/04. SelfDescription Retrigger.md b/docs/user/02. Technical Integration/01. Connector Registration/04. SelfDescription Retrigger.md similarity index 100% rename from docs/02. Technical Integration/01. Connector Registration/04. SelfDescription Retrigger.md rename to docs/user/02. Technical Integration/01. Connector Registration/04. SelfDescription Retrigger.md diff --git a/docs/02. Technical Integration/01. Connector Registration/05. Delete Connector.md b/docs/user/02. Technical Integration/01. Connector Registration/05. Delete Connector.md similarity index 100% rename from docs/02. Technical Integration/01. Connector Registration/05. Delete Connector.md rename to docs/user/02. Technical Integration/01. Connector Registration/05. Delete Connector.md diff --git a/docs/02. Technical Integration/01. Connector Registration/06. OpenAPI.md b/docs/user/02. Technical Integration/01. Connector Registration/06. OpenAPI.md similarity index 93% rename from docs/02. Technical Integration/01. Connector Registration/06. OpenAPI.md rename to docs/user/02. Technical Integration/01. Connector Registration/06. OpenAPI.md index fb14ce0ce..256c9fa62 100644 --- a/docs/02. Technical Integration/01. Connector Registration/06. OpenAPI.md +++ b/docs/user/02. Technical Integration/01. Connector Registration/06. OpenAPI.md @@ -3,7 +3,7 @@ In the connector registration scenario OpenAPIs are offered for managed connector registration. To be able to run the interface, a technical user is needed which can get generated easily via the user management.
-[How to create a technical user](/docs/03.%20User%20Management/03.%20Technical%20User/02.%20Create%20Technical%20User.md) +[How to create a technical user](/docs/user/03.%20User%20Management/03.%20Technical%20User/02.%20Create%20Technical%20User.md)

diff --git a/docs/02. Technical Integration/01. Connector Registration/07. FAQ.md b/docs/user/02. Technical Integration/01. Connector Registration/07. FAQ.md similarity index 100% rename from docs/02. Technical Integration/01. Connector Registration/07. FAQ.md rename to docs/user/02. Technical Integration/01. Connector Registration/07. FAQ.md diff --git a/docs/02. Technical Integration/01. Connector Registration/08. Policy Management.md b/docs/user/02. Technical Integration/01. Connector Registration/08. Policy Management.md similarity index 99% rename from docs/02. Technical Integration/01. Connector Registration/08. Policy Management.md rename to docs/user/02. Technical Integration/01. Connector Registration/08. Policy Management.md index 3cb25a824..f3894665f 100644 --- a/docs/02. Technical Integration/01. Connector Registration/08. Policy Management.md +++ b/docs/user/02. Technical Integration/01. Connector Registration/08. Policy Management.md @@ -260,7 +260,7 @@ Partner 1 wants to create an Access Policy, that Partner 2 can only receive the Be aware, the credential within the Summary Credential is called "TraceabilityCredential", but as the EDC does a mapping, the EDC Access Policy Entry needs to be named "FrameworkAgreement.traceability"! -All the possible mappings can be found here: https://github.com/eclipse-tractusx/ssi-docu/blob/main/docs/architecture/cx-3-2/edc/policy.definitions.md#0-introduction +All the possible mappings can be found here: https://github.com/eclipse-tractusx/ssi-docu/blob/main/docs/user/architecture/cx-3-2/edc/policy.definitions.md#0-introduction ##### Desired Outcome diff --git a/docs/02. Technical Integration/01. Connector Registration/index.md b/docs/user/02. Technical Integration/01. Connector Registration/index.md similarity index 100% rename from docs/02. Technical Integration/01. Connector Registration/index.md rename to docs/user/02. Technical Integration/01. Connector Registration/index.md diff --git a/docs/02. Technical Integration/02. Identity Provider Management/01. Summary.md b/docs/user/02. Technical Integration/02. Identity Provider Management/01. Summary.md similarity index 100% rename from docs/02. Technical Integration/02. Identity Provider Management/01. Summary.md rename to docs/user/02. Technical Integration/02. Identity Provider Management/01. Summary.md diff --git a/docs/02. Technical Integration/02. Identity Provider Management/02. Company IdPs.md b/docs/user/02. Technical Integration/02. Identity Provider Management/02. Company IdPs.md similarity index 78% rename from docs/02. Technical Integration/02. Identity Provider Management/02. Company IdPs.md rename to docs/user/02. Technical Integration/02. Identity Provider Management/02. Company IdPs.md index 61da41638..cedd3f669 100644 --- a/docs/02. Technical Integration/02. Identity Provider Management/02. Company IdPs.md +++ b/docs/user/02. Technical Integration/02. Identity Provider Management/02. Company IdPs.md @@ -52,9 +52,9 @@ IdP active. Means => the IdP is enabled (enabled=true) Connected Functions: -- [Configure Company](/docs/02.%20Technical%20Integration/02.%20Identity%20Provider%20Management/02.%20Configure%20Company%20IdP.md) -- [User Migration New IdP](/docs/02.%20Technical%20Integration/02.%20Identity%20Provider%20Management/03.%20User%20Migration.md) -- [User Migration New IdP](/docs/02.%20Technical%20Integration/02.%20Identity%20Provider%20Management/04.%20Identity%20Provider%20Deletion.md) +- [Configure Company](/docs/user/02.%20Technical%20Integration/02.%20Identity%20Provider%20Management/02.%20Configure%20Company%20IdP.md) +- [User Migration New IdP](/docs/user/02.%20Technical%20Integration/02.%20Identity%20Provider%20Management/03.%20User%20Migration.md) +- [User Migration New IdP](/docs/user/02.%20Technical%20Integration/02.%20Identity%20Provider%20Management/04.%20Identity%20Provider%20Deletion.md)

diff --git a/docs/02. Technical Integration/02. Identity Provider Management/02. Configure Company IdP.md b/docs/user/02. Technical Integration/02. Identity Provider Management/02. Configure Company IdP.md similarity index 96% rename from docs/02. Technical Integration/02. Identity Provider Management/02. Configure Company IdP.md rename to docs/user/02. Technical Integration/02. Identity Provider Management/02. Configure Company IdP.md index 0219cac18..4846a9de2 100644 --- a/docs/02. Technical Integration/02. Identity Provider Management/02. Configure Company IdP.md +++ b/docs/user/02. Technical Integration/02. Identity Provider Management/02. Configure Company IdP.md @@ -99,7 +99,7 @@ Please note: in this moment, your user is connected with the Catena-X Shared IdP

-Connected Content: [User Migration New IdP](/docs/02.%20Technical%20Integration/02.%20Identity%20Provider%20Management/03.%20User%20Migration.md) +Connected Content: [User Migration New IdP](/docs/user/02.%20Technical%20Integration/02.%20Identity%20Provider%20Management/03.%20User%20Migration.md) ## NOTICE diff --git a/docs/02. Technical Integration/02. Identity Provider Management/03. User Migration.md b/docs/user/02. Technical Integration/02. Identity Provider Management/03. User Migration.md similarity index 100% rename from docs/02. Technical Integration/02. Identity Provider Management/03. User Migration.md rename to docs/user/02. Technical Integration/02. Identity Provider Management/03. User Migration.md diff --git a/docs/02. Technical Integration/02. Identity Provider Management/04. Identity Provider Deletion.md b/docs/user/02. Technical Integration/02. Identity Provider Management/04. Identity Provider Deletion.md similarity index 100% rename from docs/02. Technical Integration/02. Identity Provider Management/04. Identity Provider Deletion.md rename to docs/user/02. Technical Integration/02. Identity Provider Management/04. Identity Provider Deletion.md diff --git a/docs/02. Technical Integration/02. Identity Provider Management/05. Disable Identity Provider.md b/docs/user/02. Technical Integration/02. Identity Provider Management/05. Disable Identity Provider.md similarity index 100% rename from docs/02. Technical Integration/02. Identity Provider Management/05. Disable Identity Provider.md rename to docs/user/02. Technical Integration/02. Identity Provider Management/05. Disable Identity Provider.md diff --git a/docs/02. Technical Integration/02. Identity Provider Management/06. FAQ.md b/docs/user/02. Technical Integration/02. Identity Provider Management/06. FAQ.md similarity index 100% rename from docs/02. Technical Integration/02. Identity Provider Management/06. FAQ.md rename to docs/user/02. Technical Integration/02. Identity Provider Management/06. FAQ.md diff --git a/docs/02. Technical Integration/02. Identity Provider Management/index.md b/docs/user/02. Technical Integration/02. Identity Provider Management/index.md similarity index 100% rename from docs/02. Technical Integration/02. Identity Provider Management/index.md rename to docs/user/02. Technical Integration/02. Identity Provider Management/index.md diff --git a/docs/02. Technical Integration/03. CX Membership/01. Open API.md b/docs/user/02. Technical Integration/03. CX Membership/01. Open API.md similarity index 88% rename from docs/02. Technical Integration/03. CX Membership/01. Open API.md rename to docs/user/02. Technical Integration/03. CX Membership/01. Open API.md index 0bbe95eef..7ead52da2 100644 --- a/docs/02. Technical Integration/03. CX Membership/01. Open API.md +++ b/docs/user/02. Technical Integration/03. CX Membership/01. Open API.md @@ -4,7 +4,7 @@ The membership discovery endpoint is used to display/retrieve all cx network mem The cx membership discovery endpoint can get triggered via technical as well as real users, if relevant roles are available. Technical users can get generated easily via the user management:
-[How to create a technical user](/docs/03.%20User%20Management/03.%20Technical%20User/02.%20Create%20Technical%20User.md) +[How to create a technical user](/docs/user/03.%20User%20Management/03.%20Technical%20User/02.%20Create%20Technical%20User.md)

diff --git a/docs/02. Technical Integration/03. CX Membership/index.md b/docs/user/02. Technical Integration/03. CX Membership/index.md similarity index 100% rename from docs/02. Technical Integration/03. CX Membership/index.md rename to docs/user/02. Technical Integration/03. CX Membership/index.md diff --git a/docs/02. Technical Integration/04. Dataspace Discovery/01. Open API.md b/docs/user/02. Technical Integration/04. Dataspace Discovery/01. Open API.md similarity index 92% rename from docs/02. Technical Integration/04. Dataspace Discovery/01. Open API.md rename to docs/user/02. Technical Integration/04. Dataspace Discovery/01. Open API.md index a5ff5be2f..602b51148 100644 --- a/docs/02. Technical Integration/04. Dataspace Discovery/01. Open API.md +++ b/docs/user/02. Technical Integration/04. Dataspace Discovery/01. Open API.md @@ -4,7 +4,7 @@ The connector discovery endpoint can get triggered via technical as well as real For technical user, a company can request the user creation with the technical user creation feature inside the portal. For details, click following link:
-[How to create a technical user](/docs/03.%20User%20Management/03.%20Technical%20User/02.%20Create%20Technical%20User.md) +[How to create a technical user](/docs/user/03.%20User%20Management/03.%20Technical%20User/02.%20Create%20Technical%20User.md)

diff --git a/docs/02. Technical Integration/04. Dataspace Discovery/index.md b/docs/user/02. Technical Integration/04. Dataspace Discovery/index.md similarity index 100% rename from docs/02. Technical Integration/04. Dataspace Discovery/index.md rename to docs/user/02. Technical Integration/04. Dataspace Discovery/index.md diff --git a/docs/02. Technical Integration/05. Company Role/Change Company Role.md b/docs/user/02. Technical Integration/05. Company Role/Change Company Role.md similarity index 100% rename from docs/02. Technical Integration/05. Company Role/Change Company Role.md rename to docs/user/02. Technical Integration/05. Company Role/Change Company Role.md diff --git a/docs/02. Technical Integration/05. Company Role/index.md b/docs/user/02. Technical Integration/05. Company Role/index.md similarity index 100% rename from docs/02. Technical Integration/05. Company Role/index.md rename to docs/user/02. Technical Integration/05. Company Role/index.md diff --git a/docs/02. Technical Integration/index.md b/docs/user/02. Technical Integration/index.md similarity index 100% rename from docs/02. Technical Integration/index.md rename to docs/user/02. Technical Integration/index.md diff --git a/docs/03. User Management/01. User Account/01. Summary.md b/docs/user/03. User Management/01. User Account/01. Summary.md similarity index 100% rename from docs/03. User Management/01. User Account/01. Summary.md rename to docs/user/03. User Management/01. User Account/01. Summary.md diff --git a/docs/03. User Management/01. User Account/02. User Account.md b/docs/user/03. User Management/01. User Account/02. User Account.md similarity index 100% rename from docs/03. User Management/01. User Account/02. User Account.md rename to docs/user/03. User Management/01. User Account/02. User Account.md diff --git a/docs/03. User Management/01. User Account/03. Create new user account (single).md b/docs/user/03. User Management/01. User Account/03. Create new user account (single).md similarity index 100% rename from docs/03. User Management/01. User Account/03. Create new user account (single).md rename to docs/user/03. User Management/01. User Account/03. Create new user account (single).md diff --git a/docs/03. User Management/01. User Account/04. Create new user account (bulk).md b/docs/user/03. User Management/01. User Account/04. Create new user account (bulk).md similarity index 100% rename from docs/03. User Management/01. User Account/04. Create new user account (bulk).md rename to docs/user/03. User Management/01. User Account/04. Create new user account (bulk).md diff --git a/docs/03. User Management/01. User Account/05. FAQ.md b/docs/user/03. User Management/01. User Account/05. FAQ.md similarity index 100% rename from docs/03. User Management/01. User Account/05. FAQ.md rename to docs/user/03. User Management/01. User Account/05. FAQ.md diff --git a/docs/03. User Management/01. User Account/index.md b/docs/user/03. User Management/01. User Account/index.md similarity index 100% rename from docs/03. User Management/01. User Account/index.md rename to docs/user/03. User Management/01. User Account/index.md diff --git a/docs/03. User Management/02. Modify User Account/01. Summary.md b/docs/user/03. User Management/02. Modify User Account/01. Summary.md similarity index 100% rename from docs/03. User Management/02. Modify User Account/01. Summary.md rename to docs/user/03. User Management/02. Modify User Account/01. Summary.md diff --git a/docs/03. User Management/02. Modify User Account/02. Password Reset.md b/docs/user/03. User Management/02. Modify User Account/02. Password Reset.md similarity index 100% rename from docs/03. User Management/02. Modify User Account/02. Password Reset.md rename to docs/user/03. User Management/02. Modify User Account/02. Password Reset.md diff --git a/docs/03. User Management/02. Modify User Account/03. User Permissions.md b/docs/user/03. User Management/02. Modify User Account/03. User Permissions.md similarity index 100% rename from docs/03. User Management/02. Modify User Account/03. User Permissions.md rename to docs/user/03. User Management/02. Modify User Account/03. User Permissions.md diff --git a/docs/03. User Management/02. Modify User Account/04. Manage user assigned BPN.md b/docs/user/03. User Management/02. Modify User Account/04. Manage user assigned BPN.md similarity index 100% rename from docs/03. User Management/02. Modify User Account/04. Manage user assigned BPN.md rename to docs/user/03. User Management/02. Modify User Account/04. Manage user assigned BPN.md diff --git a/docs/03. User Management/02. Modify User Account/05. Suspend User.md b/docs/user/03. User Management/02. Modify User Account/05. Suspend User.md similarity index 100% rename from docs/03. User Management/02. Modify User Account/05. Suspend User.md rename to docs/user/03. User Management/02. Modify User Account/05. Suspend User.md diff --git a/docs/03. User Management/02. Modify User Account/06. Delete User.md b/docs/user/03. User Management/02. Modify User Account/06. Delete User.md similarity index 94% rename from docs/03. User Management/02. Modify User Account/06. Delete User.md rename to docs/user/03. User Management/02. Modify User Account/06. Delete User.md index 0a7c18a63..98cba1850 100644 --- a/docs/03. User Management/02. Modify User Account/06. Delete User.md +++ b/docs/user/03. User Management/02. Modify User Account/06. Delete User.md @@ -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](/developer/Technical%20Documentation/Operations/Auditing.md) +More details to the audit logging can get found here: [Audit Log Details](/docs/developer/Technical%20Documentation/Operations/Auditing.md)

diff --git a/docs/03. User Management/02. Modify User Account/index.md b/docs/user/03. User Management/02. Modify User Account/index.md similarity index 100% rename from docs/03. User Management/02. Modify User Account/index.md rename to docs/user/03. User Management/02. Modify User Account/index.md diff --git a/docs/03. User Management/03. Technical User/01. Technical User Overview.md b/docs/user/03. User Management/03. Technical User/01. Technical User Overview.md similarity index 100% rename from docs/03. User Management/03. Technical User/01. Technical User Overview.md rename to docs/user/03. User Management/03. Technical User/01. Technical User Overview.md diff --git a/docs/03. User Management/03. Technical User/02. Create Technical User.md b/docs/user/03. User Management/03. Technical User/02. Create Technical User.md similarity index 95% rename from docs/03. User Management/03. Technical User/02. Create Technical User.md rename to docs/user/03. User Management/03. Technical User/02. Create Technical User.md index f74642e81..96886b5b5 100644 --- a/docs/03. User Management/03. Technical User/02. Create Technical User.md +++ b/docs/user/03. User Management/03. Technical User/02. Create Technical User.md @@ -77,7 +77,7 @@ With the shared user_id and secret, the technical user can get used to authentic ## Further information -[Technical User Creation in the name of a customer](/docs/03.%20User%20Management/03.%20Technical%20User/04.%20FAQ.md#as-a-service-or-app-provider-am-i-able-to-create-a-technical-user-in-the-name-of-my-appservice-customer) +[Technical User Creation in the name of a customer](/docs/user/03.%20User%20Management/03.%20Technical%20User/04.%20FAQ.md#as-a-service-or-app-provider-am-i-able-to-create-a-technical-user-in-the-name-of-my-appservice-customer) ## NOTICE diff --git a/docs/03. User Management/03. Technical User/03. Delete Technical User.md b/docs/user/03. User Management/03. Technical User/03. Delete Technical User.md similarity index 100% rename from docs/03. User Management/03. Technical User/03. Delete Technical User.md rename to docs/user/03. User Management/03. Technical User/03. Delete Technical User.md diff --git a/docs/03. User Management/03. Technical User/04. FAQ.md b/docs/user/03. User Management/03. Technical User/04. FAQ.md similarity index 100% rename from docs/03. User Management/03. Technical User/04. FAQ.md rename to docs/user/03. User Management/03. Technical User/04. FAQ.md diff --git a/docs/03. User Management/03. Technical User/04. Reset Credentials.md b/docs/user/03. User Management/03. Technical User/04. Reset Credentials.md similarity index 100% rename from docs/03. User Management/03. Technical User/04. Reset Credentials.md rename to docs/user/03. User Management/03. Technical User/04. Reset Credentials.md diff --git a/docs/03. User Management/03. Technical User/index.md b/docs/user/03. User Management/03. Technical User/index.md similarity index 100% rename from docs/03. User Management/03. Technical User/index.md rename to docs/user/03. User Management/03. Technical User/index.md diff --git a/docs/03. User Management/04. Assign App Roles/01. App Access Management Overview.md b/docs/user/03. User Management/04. Assign App Roles/01. App Access Management Overview.md similarity index 100% rename from docs/03. User Management/04. Assign App Roles/01. App Access Management Overview.md rename to docs/user/03. User Management/04. Assign App Roles/01. App Access Management Overview.md diff --git a/docs/03. User Management/04. Assign App Roles/02. Assign User App Role(s).md b/docs/user/03. User Management/04. Assign App Roles/02. Assign User App Role(s).md similarity index 100% rename from docs/03. User Management/04. Assign App Roles/02. Assign User App Role(s).md rename to docs/user/03. User Management/04. Assign App Roles/02. Assign User App Role(s).md diff --git a/docs/03. User Management/04. Assign App Roles/03. Update Users Assigned App Role(s).md b/docs/user/03. User Management/04. Assign App Roles/03. Update Users Assigned App Role(s).md similarity index 100% rename from docs/03. User Management/04. Assign App Roles/03. Update Users Assigned App Role(s).md rename to docs/user/03. User Management/04. Assign App Roles/03. Update Users Assigned App Role(s).md diff --git a/docs/03. User Management/04. Assign App Roles/04. FAQ.md b/docs/user/03. User Management/04. Assign App Roles/04. FAQ.md similarity index 100% rename from docs/03. User Management/04. Assign App Roles/04. FAQ.md rename to docs/user/03. User Management/04. Assign App Roles/04. FAQ.md diff --git a/docs/03. User Management/04. Assign App Roles/index.md b/docs/user/03. User Management/04. Assign App Roles/index.md similarity index 100% rename from docs/03. User Management/04. Assign App Roles/index.md rename to docs/user/03. User Management/04. Assign App Roles/index.md diff --git a/docs/03. User Management/index.md b/docs/user/03. User Management/index.md similarity index 100% rename from docs/03. User Management/index.md rename to docs/user/03. User Management/index.md diff --git a/docs/04. App(s)/01. Marketplace/01. App Overview.md b/docs/user/04. App(s)/01. Marketplace/01. App Overview.md similarity index 100% rename from docs/04. App(s)/01. Marketplace/01. App Overview.md rename to docs/user/04. App(s)/01. Marketplace/01. App Overview.md diff --git a/docs/04. App(s)/01. Marketplace/02. App Details.md b/docs/user/04. App(s)/01. Marketplace/02. App Details.md similarity index 100% rename from docs/04. App(s)/01. Marketplace/02. App Details.md rename to docs/user/04. App(s)/01. Marketplace/02. App Details.md diff --git a/docs/04. App(s)/01. Marketplace/03. App Favorites.md b/docs/user/04. App(s)/01. Marketplace/03. App Favorites.md similarity index 100% rename from docs/04. App(s)/01. Marketplace/03. App Favorites.md rename to docs/user/04. App(s)/01. Marketplace/03. App Favorites.md diff --git a/docs/04. App(s)/01. Marketplace/04. My Business Apps.md b/docs/user/04. App(s)/01. Marketplace/04. My Business Apps.md similarity index 100% rename from docs/04. App(s)/01. Marketplace/04. My Business Apps.md rename to docs/user/04. App(s)/01. Marketplace/04. My Business Apps.md diff --git a/docs/04. App(s)/01. Marketplace/05. FAQ.md b/docs/user/04. App(s)/01. Marketplace/05. FAQ.md similarity index 81% rename from docs/04. App(s)/01. Marketplace/05. FAQ.md rename to docs/user/04. App(s)/01. Marketplace/05. FAQ.md index bee71d881..8ef5b96f5 100644 --- a/docs/04. App(s)/01. Marketplace/05. FAQ.md +++ b/docs/user/04. App(s)/01. Marketplace/05. FAQ.md @@ -4,14 +4,14 @@ #### How can I release my app on the app marketplace. -To release your app on the app marketplace, you just need to have the company role "App Provider" assigned as well as the user role "App Manager". If thats the case - just follow the description under following link [App Release Process]() +To release your app on the app marketplace, you just need to have the company role "App Provider" assigned as well as the user role "App Manager". If thats the case - just follow the description under following link [App Release Process]()

#### Is it possible to deactivate an app from the marketplace? Yes, apps can get deactivated. Active subscriptions are not impacted by the deactivation. App deactivation will ensure that no new subscription requests can get triggered. Furthermore customers can not view the app inside the marketplace anymore. -[Additional Details]() +[Additional Details]()

diff --git a/docs/04. App(s)/02. App Release Process/01. App Card.md b/docs/user/04. App(s)/02. App Release Process/01. App Card.md similarity index 100% rename from docs/04. App(s)/02. App Release Process/01. App Card.md rename to docs/user/04. App(s)/02. App Release Process/01. App Card.md diff --git a/docs/04. App(s)/02. App Release Process/02. App Detail Page.md b/docs/user/04. App(s)/02. App Release Process/02. App Detail Page.md similarity index 100% rename from docs/04. App(s)/02. App Release Process/02. App Detail Page.md rename to docs/user/04. App(s)/02. App Release Process/02. App Detail Page.md diff --git a/docs/04. App(s)/02. App Release Process/03.Terms&Conditions.md b/docs/user/04. App(s)/02. App Release Process/03.Terms&Conditions.md similarity index 100% rename from docs/04. App(s)/02. App Release Process/03.Terms&Conditions.md rename to docs/user/04. App(s)/02. App Release Process/03.Terms&Conditions.md diff --git a/docs/04. App(s)/02. App Release Process/04.Technical Integration.md b/docs/user/04. App(s)/02. App Release Process/04.Technical Integration.md similarity index 100% rename from docs/04. App(s)/02. App Release Process/04.Technical Integration.md rename to docs/user/04. App(s)/02. App Release Process/04.Technical Integration.md diff --git a/docs/04. App(s)/02. App Release Process/05.Verify & Submit.md b/docs/user/04. App(s)/02. App Release Process/05.Verify & Submit.md similarity index 100% rename from docs/04. App(s)/02. App Release Process/05.Verify & Submit.md rename to docs/user/04. App(s)/02. App Release Process/05.Verify & Submit.md diff --git a/docs/04. App(s)/02. App Release Process/App-Design_guidelines.md b/docs/user/04. App(s)/02. App Release Process/App-Design_guidelines.md similarity index 100% rename from docs/04. App(s)/02. App Release Process/App-Design_guidelines.md rename to docs/user/04. App(s)/02. App Release Process/App-Design_guidelines.md diff --git a/docs/04. App(s)/02. App Release Process/App-Release_guidelines.md b/docs/user/04. App(s)/02. App Release Process/App-Release_guidelines.md similarity index 100% rename from docs/04. App(s)/02. App Release Process/App-Release_guidelines.md rename to docs/user/04. App(s)/02. App Release Process/App-Release_guidelines.md diff --git a/docs/04. App(s)/02. App Release Process/index.md b/docs/user/04. App(s)/02. App Release Process/index.md similarity index 100% rename from docs/04. App(s)/02. App Release Process/index.md rename to docs/user/04. App(s)/02. App Release Process/index.md diff --git a/docs/04. App(s)/03. App Release Approval/01. App Approval Board.md b/docs/user/04. App(s)/03. App Release Approval/01. App Approval Board.md similarity index 100% rename from docs/04. App(s)/03. App Release Approval/01. App Approval Board.md rename to docs/user/04. App(s)/03. App Release Approval/01. App Approval Board.md diff --git a/docs/04. App(s)/03. App Release Approval/02. App Details.md b/docs/user/04. App(s)/03. App Release Approval/02. App Details.md similarity index 100% rename from docs/04. App(s)/03. App Release Approval/02. App Details.md rename to docs/user/04. App(s)/03. App Release Approval/02. App Details.md diff --git a/docs/04. App(s)/03. App Release Approval/03. Approve App Release.md b/docs/user/04. App(s)/03. App Release Approval/03. Approve App Release.md similarity index 100% rename from docs/04. App(s)/03. App Release Approval/03. Approve App Release.md rename to docs/user/04. App(s)/03. App Release Approval/03. Approve App Release.md diff --git a/docs/04. App(s)/03. App Release Approval/04. Decline App Release.md b/docs/user/04. App(s)/03. App Release Approval/04. Decline App Release.md similarity index 100% rename from docs/04. App(s)/03. App Release Approval/04. Decline App Release.md rename to docs/user/04. App(s)/03. App Release Approval/04. Decline App Release.md diff --git a/docs/04. App(s)/04. App Provider Management Board(s)/01. App Board.md b/docs/user/04. App(s)/04. App Provider Management Board(s)/01. App Board.md similarity index 100% rename from docs/04. App(s)/04. App Provider Management Board(s)/01. App Board.md rename to docs/user/04. App(s)/04. App Provider Management Board(s)/01. App Board.md diff --git a/docs/04. App(s)/05. App Subscription/01. Subscription Request (Customer).md b/docs/user/04. App(s)/05. App Subscription/01. Subscription Request (Customer).md similarity index 100% rename from docs/04. App(s)/05. App Subscription/01. Subscription Request (Customer).md rename to docs/user/04. App(s)/05. App Subscription/01. Subscription Request (Customer).md diff --git a/docs/04. App(s)/05. App Subscription/02. Overview Company Subscription (Customer).md b/docs/user/04. App(s)/05. App Subscription/02. Overview Company Subscription (Customer).md similarity index 100% rename from docs/04. App(s)/05. App Subscription/02. Overview Company Subscription (Customer).md rename to docs/user/04. App(s)/05. App Subscription/02. Overview Company Subscription (Customer).md diff --git a/docs/04. App(s)/05. App Subscription/03. Subscription Overview (App Provider).md b/docs/user/04. App(s)/05. App Subscription/03. Subscription Overview (App Provider).md similarity index 100% rename from docs/04. App(s)/05. App Subscription/03. Subscription Overview (App Provider).md rename to docs/user/04. App(s)/05. App Subscription/03. Subscription Overview (App Provider).md diff --git a/docs/04. App(s)/05. App Subscription/04. Subscription Activation (App Provider).md b/docs/user/04. App(s)/05. App Subscription/04. Subscription Activation (App Provider).md similarity index 100% rename from docs/04. App(s)/05. App Subscription/04. Subscription Activation (App Provider).md rename to docs/user/04. App(s)/05. App Subscription/04. Subscription Activation (App Provider).md diff --git a/docs/04. App(s)/05. App Subscription/05. App Unsubscribe.md b/docs/user/04. App(s)/05. App Subscription/05. App Unsubscribe.md similarity index 100% rename from docs/04. App(s)/05. App Subscription/05. App Unsubscribe.md rename to docs/user/04. App(s)/05. App Subscription/05. App Unsubscribe.md diff --git a/docs/04. App(s)/05. App Subscription/05. FAQ.md b/docs/user/04. App(s)/05. App Subscription/05. FAQ.md similarity index 100% rename from docs/04. App(s)/05. App Subscription/05. FAQ.md rename to docs/user/04. App(s)/05. App Subscription/05. FAQ.md diff --git a/docs/04. App(s)/06. App Change Process/01. Summary.md b/docs/user/04. App(s)/06. App Change Process/01. Summary.md similarity index 100% rename from docs/04. App(s)/06. App Change Process/01. Summary.md rename to docs/user/04. App(s)/06. App Change Process/01. Summary.md diff --git a/docs/04. App(s)/06. App Change Process/02. Change App Lead Image.md b/docs/user/04. App(s)/06. App Change Process/02. Change App Lead Image.md similarity index 100% rename from docs/04. App(s)/06. App Change Process/02. Change App Lead Image.md rename to docs/user/04. App(s)/06. App Change Process/02. Change App Lead Image.md diff --git a/docs/04. App(s)/06. App Change Process/03. Change App Description.md b/docs/user/04. App(s)/06. App Change Process/03. Change App Description.md similarity index 100% rename from docs/04. App(s)/06. App Change Process/03. Change App Description.md rename to docs/user/04. App(s)/06. App Change Process/03. Change App Description.md diff --git a/docs/04. App(s)/06. App Change Process/04. App Deactivation.md b/docs/user/04. App(s)/06. App Change Process/04. App Deactivation.md similarity index 100% rename from docs/04. App(s)/06. App Change Process/04. App Deactivation.md rename to docs/user/04. App(s)/06. App Change Process/04. App Deactivation.md diff --git a/docs/04. App(s)/06. App Change Process/05. Change App Tenant URL.md b/docs/user/04. App(s)/06. App Change Process/05. Change App Tenant URL.md similarity index 100% rename from docs/04. App(s)/06. App Change Process/05. Change App Tenant URL.md rename to docs/user/04. App(s)/06. App Change Process/05. Change App Tenant URL.md diff --git a/docs/04. App(s)/06. App Change Process/06. Change App RolesL.md b/docs/user/04. App(s)/06. App Change Process/06. Change App RolesL.md similarity index 100% rename from docs/04. App(s)/06. App Change Process/06. Change App RolesL.md rename to docs/user/04. App(s)/06. App Change Process/06. Change App RolesL.md diff --git a/docs/04. App(s)/06. App Change Process/07. Document Change.md b/docs/user/04. App(s)/06. App Change Process/07. Document Change.md similarity index 100% rename from docs/04. App(s)/06. App Change Process/07. Document Change.md rename to docs/user/04. App(s)/06. App Change Process/07. Document Change.md diff --git a/docs/04. App(s)/07. App Provider Management/01. Open API.md b/docs/user/04. App(s)/07. App Provider Management/01. Open API.md similarity index 98% rename from docs/04. App(s)/07. App Provider Management/01. Open API.md rename to docs/user/04. App(s)/07. App Provider Management/01. Open API.md index e7f904750..23059e928 100644 --- a/docs/04. App(s)/07. App Provider Management/01. Open API.md +++ b/docs/user/04. App(s)/07. App Provider Management/01. Open API.md @@ -3,7 +3,7 @@ In the app/service setup scenarios OpenAPIs are offered to support the provider with automatization scenarios. To be able to run the interface, a technical user is needed which can get generated easily via the user management.
-[How to create a technical user](/docs/03.%20User%20Management/03.%20Technical%20User/02.%20Create%20Technical%20User.md) +[How to create a technical user](/docs/user/03.%20User%20Management/03.%20Technical%20User/02.%20Create%20Technical%20User.md) ## Interface / API / Service Summary diff --git a/docs/04. App(s)/index.md b/docs/user/04. App(s)/index.md similarity index 100% rename from docs/04. App(s)/index.md rename to docs/user/04. App(s)/index.md diff --git a/docs/05. Service(s)/01. Service Marketplace/01. Service Marketplace.md b/docs/user/05. Service(s)/01. Service Marketplace/01. Service Marketplace.md similarity index 100% rename from docs/05. Service(s)/01. Service Marketplace/01. Service Marketplace.md rename to docs/user/05. Service(s)/01. Service Marketplace/01. Service Marketplace.md diff --git a/docs/05. Service(s)/01. Service Marketplace/02. Service Details.md b/docs/user/05. Service(s)/01. Service Marketplace/02. Service Details.md similarity index 100% rename from docs/05. Service(s)/01. Service Marketplace/02. Service Details.md rename to docs/user/05. Service(s)/01. Service Marketplace/02. Service Details.md diff --git a/docs/05. Service(s)/01. Service Marketplace/03. FAQ.md b/docs/user/05. Service(s)/01. Service Marketplace/03. FAQ.md similarity index 100% rename from docs/05. Service(s)/01. Service Marketplace/03. FAQ.md rename to docs/user/05. Service(s)/01. Service Marketplace/03. FAQ.md diff --git a/docs/05. Service(s)/02. Service Release Process/01. Service Card.md b/docs/user/05. Service(s)/02. Service Release Process/01. Service Card.md similarity index 100% rename from docs/05. Service(s)/02. Service Release Process/01. Service Card.md rename to docs/user/05. Service(s)/02. Service Release Process/01. Service Card.md diff --git a/docs/05. Service(s)/02. Service Release Process/02. Service Detail Page.md b/docs/user/05. Service(s)/02. Service Release Process/02. Service Detail Page.md similarity index 100% rename from docs/05. Service(s)/02. Service Release Process/02. Service Detail Page.md rename to docs/user/05. Service(s)/02. Service Release Process/02. Service Detail Page.md diff --git a/docs/05. Service(s)/02. Service Release Process/03.Terms&Conditions.md b/docs/user/05. Service(s)/02. Service Release Process/03.Terms&Conditions.md similarity index 100% rename from docs/05. Service(s)/02. Service Release Process/03.Terms&Conditions.md rename to docs/user/05. Service(s)/02. Service Release Process/03.Terms&Conditions.md diff --git a/docs/05. Service(s)/02. Service Release Process/04.Technical Integration.md b/docs/user/05. Service(s)/02. Service Release Process/04.Technical Integration.md similarity index 100% rename from docs/05. Service(s)/02. Service Release Process/04.Technical Integration.md rename to docs/user/05. Service(s)/02. Service Release Process/04.Technical Integration.md diff --git a/docs/05. Service(s)/02. Service Release Process/05.Verify & Submit.md b/docs/user/05. Service(s)/02. Service Release Process/05.Verify & Submit.md similarity index 100% rename from docs/05. Service(s)/02. Service Release Process/05.Verify & Submit.md rename to docs/user/05. Service(s)/02. Service Release Process/05.Verify & Submit.md diff --git a/docs/05. Service(s)/02. Service Release Process/06. FAQ.md b/docs/user/05. Service(s)/02. Service Release Process/06. FAQ.md similarity index 100% rename from docs/05. Service(s)/02. Service Release Process/06. FAQ.md rename to docs/user/05. Service(s)/02. Service Release Process/06. FAQ.md diff --git a/docs/05. Service(s)/02. Service Release Process/index.md b/docs/user/05. Service(s)/02. Service Release Process/index.md similarity index 100% rename from docs/05. Service(s)/02. Service Release Process/index.md rename to docs/user/05. Service(s)/02. Service Release Process/index.md diff --git a/docs/05. Service(s)/03. Service Release Approval/01. Service Approval Board.md b/docs/user/05. Service(s)/03. Service Release Approval/01. Service Approval Board.md similarity index 100% rename from docs/05. Service(s)/03. Service Release Approval/01. Service Approval Board.md rename to docs/user/05. Service(s)/03. Service Release Approval/01. Service Approval Board.md diff --git a/docs/05. Service(s)/03. Service Release Approval/02. Service Details.md b/docs/user/05. Service(s)/03. Service Release Approval/02. Service Details.md similarity index 100% rename from docs/05. Service(s)/03. Service Release Approval/02. Service Details.md rename to docs/user/05. Service(s)/03. Service Release Approval/02. Service Details.md diff --git a/docs/05. Service(s)/03. Service Release Approval/03. Approve Service Release.md b/docs/user/05. Service(s)/03. Service Release Approval/03. Approve Service Release.md similarity index 100% rename from docs/05. Service(s)/03. Service Release Approval/03. Approve Service Release.md rename to docs/user/05. Service(s)/03. Service Release Approval/03. Approve Service Release.md diff --git a/docs/05. Service(s)/03. Service Release Approval/04. Decline Service Release.md b/docs/user/05. Service(s)/03. Service Release Approval/04. Decline Service Release.md similarity index 100% rename from docs/05. Service(s)/03. Service Release Approval/04. Decline Service Release.md rename to docs/user/05. Service(s)/03. Service Release Approval/04. Decline Service Release.md diff --git a/docs/05. Service(s)/03. Service Subscription/01. Service Subscription.md b/docs/user/05. Service(s)/03. Service Subscription/01. Service Subscription.md similarity index 100% rename from docs/05. Service(s)/03. Service Subscription/01. Service Subscription.md rename to docs/user/05. Service(s)/03. Service Subscription/01. Service Subscription.md diff --git a/docs/05. Service(s)/03. Service Subscription/03. Subscription Overview (Provider).md b/docs/user/05. Service(s)/03. Service Subscription/03. Subscription Overview (Provider).md similarity index 100% rename from docs/05. Service(s)/03. Service Subscription/03. Subscription Overview (Provider).md rename to docs/user/05. Service(s)/03. Service Subscription/03. Subscription Overview (Provider).md diff --git a/docs/05. Service(s)/03. Service Subscription/04. Service Subscription Activation (Provider).md b/docs/user/05. Service(s)/03. Service Subscription/04. Service Subscription Activation (Provider).md similarity index 100% rename from docs/05. Service(s)/03. Service Subscription/04. Service Subscription Activation (Provider).md rename to docs/user/05. Service(s)/03. Service Subscription/04. Service Subscription Activation (Provider).md diff --git a/docs/05. Service(s)/03. Service Subscription/04. Service Unsubscribe.md b/docs/user/05. Service(s)/03. Service Subscription/04. Service Unsubscribe.md similarity index 68% rename from docs/05. Service(s)/03. Service Subscription/04. Service Unsubscribe.md rename to docs/user/05. Service(s)/03. Service Subscription/04. Service Unsubscribe.md index b4365ac2a..1ef8128bc 100644 --- a/docs/05. Service(s)/03. Service Subscription/04. Service Unsubscribe.md +++ b/docs/user/05. Service(s)/03. Service Subscription/04. Service Unsubscribe.md @@ -1,4 +1,4 @@ -will follow soon - technical docu: [click]() +will follow soon - technical docu: [click]() ## NOTICE diff --git a/docs/05. Service(s)/03. Service Subscription/05. FAQ.md b/docs/user/05. Service(s)/03. Service Subscription/05. FAQ.md similarity index 100% rename from docs/05. Service(s)/03. Service Subscription/05. FAQ.md rename to docs/user/05. Service(s)/03. Service Subscription/05. FAQ.md diff --git a/docs/05. Service(s)/05. Service Change Process/01. Summary.md b/docs/user/05. Service(s)/05. Service Change Process/01. Summary.md similarity index 100% rename from docs/05. Service(s)/05. Service Change Process/01. Summary.md rename to docs/user/05. Service(s)/05. Service Change Process/01. Summary.md diff --git a/docs/05. Service(s)/05. Service Change Process/02. Service Deactivation.md b/docs/user/05. Service(s)/05. Service Change Process/02. Service Deactivation.md similarity index 100% rename from docs/05. Service(s)/05. Service Change Process/02. Service Deactivation.md rename to docs/user/05. Service(s)/05. Service Change Process/02. Service Deactivation.md diff --git a/docs/05. Service(s)/index.md b/docs/user/05. Service(s)/index.md similarity index 100% rename from docs/05. Service(s)/index.md rename to docs/user/05. Service(s)/index.md diff --git a/docs/06. Certificates/01. UseCase Participation.md b/docs/user/06. Certificates/01. UseCase Participation.md similarity index 100% rename from docs/06. Certificates/01. UseCase Participation.md rename to docs/user/06. Certificates/01. UseCase Participation.md diff --git a/docs/06. Certificates/02. Other Certificates.md b/docs/user/06. Certificates/02. Other Certificates.md similarity index 100% rename from docs/06. Certificates/02. Other Certificates.md rename to docs/user/06. Certificates/02. Other Certificates.md diff --git a/docs/06. Certificates/03. Credential Admin Board.md b/docs/user/06. Certificates/03. Credential Admin Board.md similarity index 100% rename from docs/06. Certificates/03. Credential Admin Board.md rename to docs/user/06. Certificates/03. Credential Admin Board.md diff --git a/docs/06. Certificates/03. FAQ.md b/docs/user/06. Certificates/03. FAQ.md similarity index 100% rename from docs/06. Certificates/03. FAQ.md rename to docs/user/06. Certificates/03. FAQ.md diff --git a/docs/06. Certificates/index.md b/docs/user/06. Certificates/index.md similarity index 100% rename from docs/06. Certificates/index.md rename to docs/user/06. Certificates/index.md diff --git a/docs/06. Notifications/01. Notifications/01. Overview.md b/docs/user/06. Notifications/01. Notifications/01. Overview.md similarity index 100% rename from docs/06. Notifications/01. Notifications/01. Overview.md rename to docs/user/06. Notifications/01. Notifications/01. Overview.md diff --git a/docs/09. Others/01. Login.md b/docs/user/09. Others/01. Login.md similarity index 100% rename from docs/09. Others/01. Login.md rename to docs/user/09. Others/01. Login.md diff --git a/docs/09. Others/12. Offer Authentication Flow.md b/docs/user/09. Others/12. Offer Authentication Flow.md similarity index 95% rename from docs/09. Others/12. Offer Authentication Flow.md rename to docs/user/09. Others/12. Offer Authentication Flow.md index 0c0a698f7..98a1ee1b6 100644 --- a/docs/09. Others/12. Offer Authentication Flow.md +++ b/docs/user/09. Others/12. Offer Authentication Flow.md @@ -73,14 +73,14 @@ Overall, identity provider client separation is a best practice in identity and The catena-x marketplace is hosted/operated by an CX operator. As dataspace member (companies which have successfully registered for CX dataspace with one or several operators) app provider or service provider roles can get selected. The company role "App Provider" or "Service Provider" enables the participant to use the app/service release process to request app/service listing on the operator marketplace. -To view the app registration process and the single steps - follow the link [App Registration Process]() +To view the app registration process and the single steps - follow the link [App Registration Process]() The app registration is relevant to list your offer inside the CX marketplace. Clients/Technical user accounts get created with subscription activation. (see details below)
### #2 App Subscription and activation -Customers are able to subscribe app/services offered inside the marketplace. [Create a subscription request]() +Customers are able to subscribe app/services offered inside the marketplace. [Create a subscription request]() The subscription triggers the request on the app/service provider side. The app/service provider gets informed via email and can look up the request inside the portal => app/service subscription management board. As soon as all data are reviewed, the app/service provider will ramp up the app/service in its domain and configure the app/service for the customer. In most of the cases the app/service needs access to a certain core applications provided by the operator. Via the technical user the connection is supposed to get established. If the app/service provider is ready for app/service configuration, the app/service provider can generate the necessary technical user by using the app/service subscription board and select for the specific customer "configuration". The configuration requests a app/service tenant url (depending on the offer type) - the endpoint url is the url with which the customer can access the app. The url is used to create the IdP app client and to configure allowed user roles (as per the defined roles by the app provider). At the end of the process, the technical user (as configured previously in the release process) is getting created and technical user client id as well as the secret is getting shared with the offer provider. diff --git a/docs/Style-Guide/Static_Page_Template.md b/docs/user/Style-Guide/Static_Page_Template.md similarity index 100% rename from docs/Style-Guide/Static_Page_Template.md rename to docs/user/Style-Guide/Static_Page_Template.md diff --git a/docs/Style-Guide/button load more.md b/docs/user/Style-Guide/button load more.md similarity index 100% rename from docs/Style-Guide/button load more.md rename to docs/user/Style-Guide/button load more.md diff --git a/docs/Style-Guide/button.md b/docs/user/Style-Guide/button.md similarity index 100% rename from docs/Style-Guide/button.md rename to docs/user/Style-Guide/button.md diff --git a/docs/Style-Guide/date picker.md b/docs/user/Style-Guide/date picker.md similarity index 100% rename from docs/Style-Guide/date picker.md rename to docs/user/Style-Guide/date picker.md diff --git a/docs/Style-Guide/drop down.md b/docs/user/Style-Guide/drop down.md similarity index 100% rename from docs/Style-Guide/drop down.md rename to docs/user/Style-Guide/drop down.md diff --git a/docs/Style-Guide/dropzone.md b/docs/user/Style-Guide/dropzone.md similarity index 100% rename from docs/Style-Guide/dropzone.md rename to docs/user/Style-Guide/dropzone.md diff --git a/docs/Style-Guide/input field.md b/docs/user/Style-Guide/input field.md similarity index 100% rename from docs/Style-Guide/input field.md rename to docs/user/Style-Guide/input field.md diff --git a/docs/Style-Guide/loading.md b/docs/user/Style-Guide/loading.md similarity index 100% rename from docs/Style-Guide/loading.md rename to docs/user/Style-Guide/loading.md diff --git a/docs/Style-Guide/scrollbar.md b/docs/user/Style-Guide/scrollbar.md similarity index 100% rename from docs/Style-Guide/scrollbar.md rename to docs/user/Style-Guide/scrollbar.md diff --git a/docs/Style-Guide/searchbar.md b/docs/user/Style-Guide/searchbar.md similarity index 100% rename from docs/Style-Guide/searchbar.md rename to docs/user/Style-Guide/searchbar.md diff --git a/docs/Style-Guide/toast message.md b/docs/user/Style-Guide/toast message.md similarity index 100% rename from docs/Style-Guide/toast message.md rename to docs/user/Style-Guide/toast message.md diff --git a/public/documentation/data/1.0.0-RC1/docs.json b/public/documentation/data/1.0.0-RC1/docs.json deleted file mode 100644 index 895cb0c13..000000000 --- a/public/documentation/data/1.0.0-RC1/docs.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "path": "docs", - "name": "Catena-X Help Desk", - "children": [{ "path": "docs/sample", "name": "Sample" }] -} diff --git a/public/documentation/data/1.0.0-RC2/docs.json b/public/documentation/data/1.0.0-RC2/docs.json deleted file mode 100644 index a40d96e80..000000000 --- a/public/documentation/data/1.0.0-RC2/docs.json +++ /dev/null @@ -1,476 +0,0 @@ -{ - "path": "docs", - "name": "Catena-X Help Desk", - "children": [ - { - "path": "docs/App(s)", - "name": "App(s)", - "children": [ - { - "path": "docs/App(s)/App-Change-Process.md", - "name": "App-Change-Process.md" - }, - { - "path": "docs/App(s)/App-Management", - "name": "App-Management", - "children": [ - { - "path": "docs/App(s)/App-Management/App Management Board - App Provider.md", - "name": "App Management Board - App Provider.md" - }, - { - "path": "docs/App(s)/App-Management/App Management Board - Operator.md", - "name": "App Management Board - Operator.md" - } - ] - }, - { - "path": "docs/App(s)/App-Subscription", - "name": "App-Subscription", - "children": [ - { - "path": "docs/App(s)/App-Subscription/App_Subscription_Management_Board.md", - "name": "App_Subscription_Management_Board.md" - }, - { - "path": "docs/App(s)/App-Subscription/Company_App_Subscription.md", - "name": "Company_App_Subscription.md" - }, - { "path": "docs/App(s)/App-Subscription/FAQ.md", "name": "FAQ.md" } - ] - }, - { - "path": "docs/App(s)/Marketplace", - "name": "Marketplace", - "children": [ - { - "path": "docs/App(s)/Marketplace/Design.md", - "name": "Design.md" - }, - { "path": "docs/App(s)/Marketplace/FAQ.md", "name": "FAQ.md" }, - { - "path": "docs/App(s)/Marketplace/Implementation.md", - "name": "Implementation.md" - }, - { - "path": "docs/App(s)/Marketplace/User_Description.md", - "name": "User_Description.md" - } - ] - }, - { - "path": "docs/App(s)/Release-Process", - "name": "Release-Process", - "children": [ - { - "path": "docs/App(s)/Release-Process/App Release Details (process screen).md", - "name": "App Release Details (process screen).md" - }, - { - "path": "docs/App(s)/Release-Process/App Release Workflow.md", - "name": "App Release Workflow.md" - }, - { - "path": "docs/App(s)/Release-Process/App-Design_guidelines.md", - "name": "App-Design_guidelines.md" - }, - { - "path": "docs/App(s)/Release-Process/App-Release_guidelines.md", - "name": "App-Release_guidelines.md" - } - ] - }, - { - "path": "docs/App(s)/Subscription-Management", - "name": "Subscription-Management", - "children": [ - { - "path": "docs/App(s)/Subscription-Management/Design.md", - "name": "Design.md" - }, - { - "path": "docs/App(s)/Subscription-Management/FAQ.md", - "name": "FAQ.md" - }, - { - "path": "docs/App(s)/Subscription-Management/Implementation.md", - "name": "Implementation.md" - }, - { - "path": "docs/App(s)/Subscription-Management/User_Description.md", - "name": "User_Description.md" - } - ] - }, - { "path": "docs/App(s)/Summary.md", "name": "Summary.md" } - ] - }, - { - "path": "docs/Architecture", - "name": "Architecture", - "children": [ - { - "path": "docs/Architecture/Architecture Constraints.md", - "name": "Architecture Constraints.md" - }, - { - "path": "docs/Architecture/Building block view.md", - "name": "Building block view.md" - }, - { - "path": "docs/Architecture/Context and scope.md", - "name": "Context and scope.md" - }, - { - "path": "docs/Architecture/Development Concept.md", - "name": "Development Concept.md" - }, - { - "path": "docs/Architecture/Requirements.md", - "name": "Requirements.md" - }, - { - "path": "docs/Architecture/Solution strategy.md", - "name": "Solution strategy.md" - }, - { - "path": "docs/Architecture/Whitebox Overall System.md", - "name": "Whitebox Overall System.md" - }, - { - "path": "docs/Architecture/operational-concept.md", - "name": "operational-concept.md" - } - ] - }, - { - "path": "docs/Developer_Documentation", - "name": "Developer_Documentation", - "children": [ - { - "path": "docs/Developer_Documentation/Auditing.md", - "name": "Auditing.md" - }, - { - "path": "docs/Developer_Documentation/Document_Management.md", - "name": "Document_Management.md" - }, - { - "path": "docs/Developer_Documentation/Email Templates.md", - "name": "Email Templates.md" - }, - { - "path": "docs/Developer_Documentation/Multi Language.md", - "name": "Multi Language.md" - }, - { - "path": "docs/Developer_Documentation/Notifications.md", - "name": "Notifications.md" - }, - { "path": "docs/Developer_Documentation/test.md", "name": "test.md" } - ] - }, - { - "path": "docs/Interface Contracts", - "name": "Interface Contracts", - "children": [ - { - "path": "docs/Interface Contracts/BPDM (2).md", - "name": "BPDM (2).md" - }, - { "path": "docs/Interface Contracts/BPDM.md", "name": "BPDM.md" }, - { - "path": "docs/Interface Contracts/CX-Membership.md", - "name": "CX-Membership.md" - }, - { - "path": "docs/Interface Contracts/Dataspace-Discovery.md", - "name": "Dataspace-Discovery.md" - }, - { - "path": "docs/Interface Contracts/Managed Wallets.md", - "name": "Managed Wallets.md" - }, - { - "path": "docs/Interface Contracts/Offer-Autosetup.md", - "name": "Offer-Autosetup.md" - }, - { - "path": "docs/Interface Contracts/Self Description.md", - "name": "Self Description.md" - } - ] - }, - { - "path": "docs/Onboarding", - "name": "Onboarding", - "children": [ - { - "path": "docs/Onboarding/Connector Registration", - "name": "Connector Registration", - "children": [ - { - "path": "docs/Onboarding/Connector Registration/FAQ.md", - "name": "FAQ.md" - }, - { - "path": "docs/Onboarding/Connector Registration/Implementation.md", - "name": "Implementation.md" - }, - { - "path": "docs/Onboarding/Connector Registration/Summary.md", - "name": "Summary.md" - } - ] - }, - { - "path": "docs/Onboarding/Identity_Provider_Switch", - "name": "Identity_Provider_Switch", - "children": [ - { - "path": "docs/Onboarding/Identity_Provider_Switch/FAQ.md", - "name": "FAQ.md" - }, - { - "path": "docs/Onboarding/Identity_Provider_Switch/Implementation.md", - "name": "Implementation.md" - }, - { - "path": "docs/Onboarding/Identity_Provider_Switch/Summary.md", - "name": "Summary.md" - }, - { - "path": "docs/Onboarding/Identity_Provider_Switch/User Description.md", - "name": "User Description.md" - } - ] - }, - { - "path": "docs/Onboarding/Invite", - "name": "Invite", - "children": [ - { "path": "docs/Onboarding/Invite/FAQ.md", "name": "FAQ.md" }, - { - "path": "docs/Onboarding/Invite/Implementation.md", - "name": "Implementation.md" - }, - { - "path": "docs/Onboarding/Invite/Summary.md", - "name": "Summary.md" - } - ] - }, - { - "path": "docs/Onboarding/Registration", - "name": "Registration", - "children": [ - { "path": "docs/Onboarding/Registration/FAQ.md", "name": "FAQ.md" }, - { - "path": "docs/Onboarding/Registration/Implementation.md", - "name": "Implementation.md" - }, - { - "path": "docs/Onboarding/Registration/Summary.md", - "name": "Summary.md" - } - ] - }, - { - "path": "docs/Onboarding/Registration Approval", - "name": "Registration Approval", - "children": [ - { - "path": "docs/Onboarding/Registration Approval/FAQ.md", - "name": "FAQ.md" - }, - { - "path": "docs/Onboarding/Registration Approval/Functional Details.md", - "name": "Functional Details.md" - }, - { - "path": "docs/Onboarding/Registration Approval/Implementation.md", - "name": "Implementation.md" - }, - { - "path": "docs/Onboarding/Registration Approval/Summary.md", - "name": "Summary.md" - } - ] - } - ] - }, - { "path": "docs/Release-Process.md", "name": "Release-Process.md" }, - { - "path": "docs/Service(s)", - "name": "Service(s)", - "children": [ - { - "path": "docs/Service(s)/Marketplace", - "name": "Marketplace", - "children": [ - { - "path": "docs/Service(s)/Marketplace/Design.md", - "name": "Design.md" - }, - { "path": "docs/Service(s)/Marketplace/FAQ.md", "name": "FAQ.md" }, - { - "path": "docs/Service(s)/Marketplace/Implementation.md", - "name": "Implementation.md" - }, - { - "path": "docs/Service(s)/Marketplace/User_Description.md", - "name": "User_Description.md" - } - ] - }, - { - "path": "docs/Service(s)/Release-Process", - "name": "Release-Process", - "children": [ - { - "path": "docs/Service(s)/Release-Process/Design.md", - "name": "Design.md" - }, - { - "path": "docs/Service(s)/Release-Process/FAQ.md", - "name": "FAQ.md" - }, - { - "path": "docs/Service(s)/Release-Process/Implementation.md", - "name": "Implementation.md" - }, - { - "path": "docs/Service(s)/Release-Process/User_Description.md", - "name": "User_Description.md" - } - ] - }, - { - "path": "docs/Service(s)/Subscription", - "name": "Subscription", - "children": [ - { - "path": "docs/Service(s)/Subscription/Design.md", - "name": "Design.md" - }, - { "path": "docs/Service(s)/Subscription/FAQ.md", "name": "FAQ.md" }, - { - "path": "docs/Service(s)/Subscription/Implementation.md", - "name": "Implementation.md" - }, - { - "path": "docs/Service(s)/Subscription/User_Description.md", - "name": "User_Description.md" - } - ] - } - ] - }, - { - "path": "docs/User Management", - "name": "User Management", - "children": [ - { - "path": "docs/User Management/App_Access_Management", - "name": "App_Access_Management", - "children": [ - { - "path": "docs/User Management/App_Access_Management/Design.md", - "name": "Design.md" - }, - { - "path": "docs/User Management/App_Access_Management/Implementation.md", - "name": "Implementation.md" - }, - { - "path": "docs/User Management/App_Access_Management/Summary.md", - "name": "Summary.md" - } - ] - }, - { - "path": "docs/User Management/Edit_User_Account", - "name": "Edit_User_Account", - "children": [ - { - "path": "docs/User Management/Edit_User_Account/Add&Delete_BPN.md", - "name": "Add&Delete_BPN.md" - }, - { - "path": "docs/User Management/Edit_User_Account/Delete_User.md", - "name": "Delete_User.md" - }, - { - "path": "docs/User Management/Edit_User_Account/Design.md", - "name": "Design.md" - }, - { - "path": "docs/User Management/Edit_User_Account/Password_Reset.md", - "name": "Password_Reset.md" - }, - { - "path": "docs/User Management/Edit_User_Account/Summary.md", - "name": "Summary.md" - }, - { - "path": "docs/User Management/Edit_User_Account/Suspend_User.md", - "name": "Suspend_User.md" - }, - { - "path": "docs/User Management/Edit_User_Account/User_Permissions.md", - "name": "User_Permissions.md" - } - ] - }, - { - "path": "docs/User Management/Technical_User", - "name": "Technical_User", - "children": [ - { - "path": "docs/User Management/Technical_User/Design.md", - "name": "Design.md" - }, - { - "path": "docs/User Management/Technical_User/FAQ.md", - "name": "FAQ.md" - }, - { - "path": "docs/User Management/Technical_User/HowTo.md", - "name": "HowTo.md" - }, - { - "path": "docs/User Management/Technical_User/Implementation.md", - "name": "Implementation.md" - }, - { - "path": "docs/User Management/Technical_User/Summary.md", - "name": "Summary.md" - } - ] - }, - { - "path": "docs/User Management/User_Account", - "name": "User_Account", - "children": [ - { - "path": "docs/User Management/User_Account/FAQ.md", - "name": "FAQ.md" - }, - { - "path": "docs/User Management/User_Account/HowTo.md", - "name": "HowTo.md" - }, - { - "path": "docs/User Management/User_Account/Implementation.md", - "name": "Implementation.md" - }, - { - "path": "docs/User Management/User_Account/Summary.md", - "name": "Summary.md" - } - ] - } - ] - } - ] -} diff --git a/public/documentation/data/1.0.0-RC3/docs.json b/public/documentation/data/1.0.0-RC3/docs.json deleted file mode 100644 index 219f2474c..000000000 --- a/public/documentation/data/1.0.0-RC3/docs.json +++ /dev/null @@ -1,504 +0,0 @@ -{ - "path": "docs", - "name": "Catena-X Help Desk", - "children": [ - { - "path": "docs/App(s)", - "name": "App(s)", - "children": [ - { - "path": "docs/App(s)/App-Change-Process.md", - "name": "App-Change-Process.md" - }, - { - "path": "docs/App(s)/App-Management", - "name": "App-Management", - "children": [ - { - "path": "docs/App(s)/App-Management/App Management Board - App Provider.md", - "name": "App Management Board - App Provider.md" - }, - { - "path": "docs/App(s)/App-Management/App Management Board - Operator.md", - "name": "App Management Board - Operator.md" - } - ] - }, - { - "path": "docs/App(s)/App-Subscription", - "name": "App-Subscription", - "children": [ - { - "path": "docs/App(s)/App-Subscription/App_Subscription_Management_Board.md", - "name": "App_Subscription_Management_Board.md" - }, - { - "path": "docs/App(s)/App-Subscription/Company_App_Subscription.md", - "name": "Company_App_Subscription.md" - }, - { "path": "docs/App(s)/App-Subscription/FAQ.md", "name": "FAQ.md" } - ] - }, - { - "path": "docs/App(s)/Marketplace", - "name": "Marketplace", - "children": [ - { - "path": "docs/App(s)/Marketplace/Design.md", - "name": "Design.md" - }, - { "path": "docs/App(s)/Marketplace/FAQ.md", "name": "FAQ.md" }, - { - "path": "docs/App(s)/Marketplace/Implementation.md", - "name": "Implementation.md" - }, - { - "path": "docs/App(s)/Marketplace/User_Description.md", - "name": "User_Description.md" - } - ] - }, - { - "path": "docs/App(s)/Release-Process", - "name": "Release-Process", - "children": [ - { - "path": "docs/App(s)/Release-Process/App Release Details (process screen).md", - "name": "App Release Details (process screen).md" - }, - { - "path": "docs/App(s)/Release-Process/App Release Workflow.md", - "name": "App Release Workflow.md" - }, - { - "path": "docs/App(s)/Release-Process/App-Design_guidelines.md", - "name": "App-Design_guidelines.md" - }, - { - "path": "docs/App(s)/Release-Process/App-Release_guidelines.md", - "name": "App-Release_guidelines.md" - } - ] - }, - { - "path": "docs/App(s)/Subscription-Management", - "name": "Subscription-Management", - "children": [ - { - "path": "docs/App(s)/Subscription-Management/Design.md", - "name": "Design.md" - }, - { - "path": "docs/App(s)/Subscription-Management/FAQ.md", - "name": "FAQ.md" - }, - { - "path": "docs/App(s)/Subscription-Management/Implementation.md", - "name": "Implementation.md" - }, - { - "path": "docs/App(s)/Subscription-Management/User_Description.md", - "name": "User_Description.md" - } - ] - }, - { "path": "docs/App(s)/Summary.md", "name": "Summary.md" } - ] - }, - { - "path": "docs/Architecture", - "name": "Architecture", - "children": [ - { - "path": "docs/Architecture/Architecture Constraints.md", - "name": "Architecture Constraints.md" - }, - { - "path": "docs/Architecture/Building block view.md", - "name": "Building block view.md" - }, - { - "path": "docs/Architecture/Context and scope.md", - "name": "Context and scope.md" - }, - { - "path": "docs/Architecture/Development Concept.md", - "name": "Development Concept.md" - }, - { - "path": "docs/Architecture/Requirements.md", - "name": "Requirements.md" - }, - { - "path": "docs/Architecture/Solution strategy.md", - "name": "Solution strategy.md" - }, - { - "path": "docs/Architecture/Whitebox Overall System.md", - "name": "Whitebox Overall System.md" - }, - { - "path": "docs/Architecture/operational-concept.md", - "name": "operational-concept.md" - } - ] - }, - { - "path": "docs/Developer_Documentation", - "name": "Developer_Documentation", - "children": [ - { - "path": "docs/Developer_Documentation/Auditing.md", - "name": "Auditing.md" - }, - { - "path": "docs/Developer_Documentation/Document_Management.md", - "name": "Document_Management.md" - }, - { - "path": "docs/Developer_Documentation/Email Templates.md", - "name": "Email Templates.md" - }, - { - "path": "docs/Developer_Documentation/IdP", - "name": "IdP", - "children": [ - { - "path": "docs/Developer_Documentation/IdP/Email Configuration.md", - "name": "Email Configuration.md" - }, - { - "path": "docs/Developer_Documentation/IdP/Event Logging.md", - "name": "Event Logging.md" - }, - { - "path": "docs/Developer_Documentation/IdP/Password Policy.md", - "name": "Password Policy.md" - } - ] - }, - { - "path": "docs/Developer_Documentation/Multi Language.md", - "name": "Multi Language.md" - }, - { - "path": "docs/Developer_Documentation/Notifications.md", - "name": "Notifications.md" - }, - { "path": "docs/Developer_Documentation/test.md", "name": "test.md" } - ] - }, - { - "path": "docs/Interface Contracts", - "name": "Interface Contracts", - "children": [ - { - "path": "docs/Interface Contracts/BPDM (2).md", - "name": "BPDM (2).md" - }, - { "path": "docs/Interface Contracts/BPDM.md", "name": "BPDM.md" }, - { - "path": "docs/Interface Contracts/CX-Membership.md", - "name": "CX-Membership.md" - }, - { - "path": "docs/Interface Contracts/Dataspace-Discovery.md", - "name": "Dataspace-Discovery.md" - }, - { - "path": "docs/Interface Contracts/Managed Wallets.md", - "name": "Managed Wallets.md" - }, - { - "path": "docs/Interface Contracts/Offer-Autosetup.md", - "name": "Offer-Autosetup.md" - }, - { - "path": "docs/Interface Contracts/Self Description.md", - "name": "Self Description.md" - } - ] - }, - { - "path": "docs/Onboarding", - "name": "Onboarding", - "children": [ - { - "path": "docs/Onboarding/Connector Registration", - "name": "Connector Registration", - "children": [ - { - "path": "docs/Onboarding/Connector Registration/FAQ.md", - "name": "FAQ.md" - }, - { - "path": "docs/Onboarding/Connector Registration/Implementation.md", - "name": "Implementation.md" - }, - { - "path": "docs/Onboarding/Connector Registration/Summary.md", - "name": "Summary.md" - } - ] - }, - { - "path": "docs/Onboarding/Identity_Provider_Switch", - "name": "Identity_Provider_Switch", - "children": [ - { - "path": "docs/Onboarding/Identity_Provider_Switch/FAQ.md", - "name": "FAQ.md" - }, - { - "path": "docs/Onboarding/Identity_Provider_Switch/Implementation.md", - "name": "Implementation.md" - }, - { - "path": "docs/Onboarding/Identity_Provider_Switch/Summary.md", - "name": "Summary.md" - }, - { - "path": "docs/Onboarding/Identity_Provider_Switch/User Description.md", - "name": "User Description.md" - } - ] - }, - { - "path": "docs/Onboarding/Invite", - "name": "Invite", - "children": [ - { "path": "docs/Onboarding/Invite/FAQ.md", "name": "FAQ.md" }, - { - "path": "docs/Onboarding/Invite/Implementation.md", - "name": "Implementation.md" - }, - { - "path": "docs/Onboarding/Invite/Summary.md", - "name": "Summary.md" - } - ] - }, - { - "path": "docs/Onboarding/Registration", - "name": "Registration", - "children": [ - { "path": "docs/Onboarding/Registration/FAQ.md", "name": "FAQ.md" }, - { - "path": "docs/Onboarding/Registration/Implementation.md", - "name": "Implementation.md" - }, - { - "path": "docs/Onboarding/Registration/Summary.md", - "name": "Summary.md" - } - ] - }, - { - "path": "docs/Onboarding/Registration Approval", - "name": "Registration Approval", - "children": [ - { - "path": "docs/Onboarding/Registration Approval/FAQ.md", - "name": "FAQ.md" - }, - { - "path": "docs/Onboarding/Registration Approval/Functional Details.md", - "name": "Functional Details.md" - }, - { - "path": "docs/Onboarding/Registration Approval/Implementation.md", - "name": "Implementation.md" - }, - { - "path": "docs/Onboarding/Registration Approval/Summary.md", - "name": "Summary.md" - } - ] - } - ] - }, - { "path": "docs/Release-Process.md", "name": "Release-Process.md" }, - { - "path": "docs/Service(s)", - "name": "Service(s)", - "children": [ - { - "path": "docs/Service(s)/Marketplace", - "name": "Marketplace", - "children": [ - { - "path": "docs/Service(s)/Marketplace/Design.md", - "name": "Design.md" - }, - { "path": "docs/Service(s)/Marketplace/FAQ.md", "name": "FAQ.md" }, - { - "path": "docs/Service(s)/Marketplace/Implementation.md", - "name": "Implementation.md" - }, - { - "path": "docs/Service(s)/Marketplace/User_Description.md", - "name": "User_Description.md" - } - ] - }, - { - "path": "docs/Service(s)/Release-Process", - "name": "Release-Process", - "children": [ - { - "path": "docs/Service(s)/Release-Process/Design.md", - "name": "Design.md" - }, - { - "path": "docs/Service(s)/Release-Process/FAQ.md", - "name": "FAQ.md" - }, - { - "path": "docs/Service(s)/Release-Process/Implementation.md", - "name": "Implementation.md" - }, - { - "path": "docs/Service(s)/Release-Process/User_Description.md", - "name": "User_Description.md" - } - ] - }, - { - "path": "docs/Service(s)/Subscription", - "name": "Subscription", - "children": [ - { - "path": "docs/Service(s)/Subscription/Design.md", - "name": "Design.md" - }, - { "path": "docs/Service(s)/Subscription/FAQ.md", "name": "FAQ.md" }, - { - "path": "docs/Service(s)/Subscription/Implementation.md", - "name": "Implementation.md" - }, - { - "path": "docs/Service(s)/Subscription/User_Description.md", - "name": "User_Description.md" - } - ] - } - ] - }, - { - "path": "docs/Style-Guide", - "name": "Style-Guide", - "children": [ - { - "path": "docs/Style-Guide/Static_Page_Template.md", - "name": "Static_Page_Template.md" - } - ] - }, - { - "path": "docs/User Management", - "name": "User Management", - "children": [ - { - "path": "docs/User Management/App_Access_Management", - "name": "App_Access_Management", - "children": [ - { - "path": "docs/User Management/App_Access_Management/Design.md", - "name": "Design.md" - }, - { - "path": "docs/User Management/App_Access_Management/Implementation.md", - "name": "Implementation.md" - }, - { - "path": "docs/User Management/App_Access_Management/Summary.md", - "name": "Summary.md" - } - ] - }, - { - "path": "docs/User Management/Edit_User_Account", - "name": "Edit_User_Account", - "children": [ - { - "path": "docs/User Management/Edit_User_Account/Add&Delete_BPN.md", - "name": "Add&Delete_BPN.md" - }, - { - "path": "docs/User Management/Edit_User_Account/Delete_User.md", - "name": "Delete_User.md" - }, - { - "path": "docs/User Management/Edit_User_Account/Design.md", - "name": "Design.md" - }, - { - "path": "docs/User Management/Edit_User_Account/Password_Reset.md", - "name": "Password_Reset.md" - }, - { - "path": "docs/User Management/Edit_User_Account/Summary.md", - "name": "Summary.md" - }, - { - "path": "docs/User Management/Edit_User_Account/Suspend_User.md", - "name": "Suspend_User.md" - }, - { - "path": "docs/User Management/Edit_User_Account/User_Permissions.md", - "name": "User_Permissions.md" - } - ] - }, - { - "path": "docs/User Management/Technical_User", - "name": "Technical_User", - "children": [ - { - "path": "docs/User Management/Technical_User/Design.md", - "name": "Design.md" - }, - { - "path": "docs/User Management/Technical_User/FAQ.md", - "name": "FAQ.md" - }, - { - "path": "docs/User Management/Technical_User/HowTo.md", - "name": "HowTo.md" - }, - { - "path": "docs/User Management/Technical_User/Implementation.md", - "name": "Implementation.md" - }, - { - "path": "docs/User Management/Technical_User/Summary.md", - "name": "Summary.md" - } - ] - }, - { - "path": "docs/User Management/User_Account", - "name": "User_Account", - "children": [ - { - "path": "docs/User Management/User_Account/FAQ.md", - "name": "FAQ.md" - }, - { - "path": "docs/User Management/User_Account/HowTo.md", - "name": "HowTo.md" - }, - { - "path": "docs/User Management/User_Account/Implementation.md", - "name": "Implementation.md" - }, - { - "path": "docs/User Management/User_Account/Summary.md", - "name": "Summary.md" - } - ] - } - ] - } - ] -} diff --git a/public/documentation/data/1.0.0-RC4/docs.json b/public/documentation/data/1.0.0-RC4/docs.json deleted file mode 100644 index 401eef6a7..000000000 --- a/public/documentation/data/1.0.0-RC4/docs.json +++ /dev/null @@ -1,926 +0,0 @@ -{ - "path": "docs", - "name": "Catena-X Help Desk", - "children": [ - { - "path": "docs/01. Onboarding", - "name": "01. Onboarding", - "children": [ - { - "path": "docs/01. Onboarding/01. Registration Invite", - "name": "01. Registration Invite", - "children": [ - { - "path": "docs/01. Onboarding/01. Registration Invite/FAQ.md", - "name": "FAQ.md", - "chapter": [ - "# FAQ", - "## How can I invite a potential new Catena-X member?", - "## Can I identify already invited members?" - ] - }, - { - "path": "docs/01. Onboarding/01. Registration Invite/Implementation.md", - "name": "Implementation.md", - "chapter": [ - "# Implementation", - "## 1 Get Invited Companies", - "#### API Details", - "## 2 Invite Companies", - "#### API Details", - "## 3Ā  Search" - ] - }, - { - "path": "docs/01. Onboarding/01. Registration Invite/Summary.md", - "name": "Summary.md", - "chapter": ["## Summary"] - } - ] - }, - { - "path": "docs/01. Onboarding/02. Registration", - "name": "02. Registration", - "children": [ - { - "path": "docs/01. Onboarding/02. Registration/01. Login.md", - "name": "01. Login.md", - "chapter": ["# Intro", "#### Registration Login"] - }, - { - "path": "docs/01. Onboarding/02. Registration/02. Add Company Data.md", - "name": "02. Add Company Data.md", - "chapter": ["#### Add Company Data"] - }, - { - "path": "docs/01. Onboarding/02. Registration/03. Add Additional User(s).md", - "name": "03. Add Additional User(s).md", - "chapter": ["#### Invite additional users", "#optional step#"] - }, - { - "path": "docs/01. Onboarding/02. Registration/04. Company Role & Consent.md", - "name": "04. Company Role & Consent.md", - "chapter": ["#### Company Role & Terms and Conditions"] - }, - { - "path": "docs/01. Onboarding/02. Registration/05. Document Upload.md", - "name": "05. Document Upload.md", - "chapter": ["#### Document upload"] - }, - { - "path": "docs/01. Onboarding/02. Registration/06. Verify Registration Data.md", - "name": "06. Verify Registration Data.md", - "chapter": ["#### Submit company data"] - }, - { - "path": "docs/01. Onboarding/02. Registration/07. FAQ.md", - "name": "07. FAQ.md", - "chapter": [ - "# FAQ", - "## For what are the registration data used for?", - "## What will happen after the registration?", - "## Do I need to do the registration in one flow or can i pause in between?", - "## What can I do, if I dont have all necessary information available, which are needed to register my company?", - "## Why do I always receive a message / warning screen when logging in to the registration form of my company." - ] - } - ] - }, - { - "path": "docs/01. Onboarding/03. Registration Approval", - "name": "03. Registration Approval", - "children": [ - { - "path": "docs/01. Onboarding/03. Registration Approval/FAQ.md", - "name": "FAQ.md", - "chapter": ["# FAQ"] - }, - { - "path": "docs/01. Onboarding/03. Registration Approval/Functional Details.md", - "name": "Functional Details.md", - "chapter": [ - "# Functional Details", - "### Display Application Details", - "### Approval Flow", - "##### Details \"Manual Validation\"", - "###### Scenario: Approve", - "###### Scenario: Decline", - "##### Details \"Create Business Partner Number (if necessary)\"", - "###### Scenario 1 - Registration with BPN", - "###### Scenario 2 - Registration without BPN", - "###### Scenario 3 - manually add BPN as operator (interim supported workflow)", - "##### Details \"Create Managed Identity Wallet\"", - "##### Details \"Clearinghouse Check\"", - "###### Step 1 - manually add BPN as operator (interim supported workflow)", - "###### Step 2 - Clearinghouse response", - "##### Details \"Self-Description Creation LegalPerson\"", - "###### DB Table Content", - "##### Details \"Activation\"", - "### Add/Update BPN for the registration company" - ] - }, - { - "path": "docs/01. Onboarding/03. Registration Approval/Implementation.md", - "name": "Implementation.md", - "chapter": [ - "# Implementation", - "## 1 Get Applications", - "###### Filtering", - "###### Search", - "#### Logical flow of the service", - "#### API Details", - "## 2 Get Application Details", - "#### API Details", - "## 3 Confirm/Approve Application", - "#### Logical flow of the service", - "#### API Details", - "## 4 Decline Application", - "#### Logical flow of the service", - "#### API Details", - "## 5 Download Documents", - "#### Logical flow of the service", - "#### API Details", - "## 6 Add bpn to a company registration", - "#### Logical flow of the service", - "#### API Details" - ] - }, - { - "path": "docs/01. Onboarding/03. Registration Approval/Summary.md", - "name": "Summary.md", - "chapter": ["## Summary"] - } - ] - } - ] - }, - { - "path": "docs/02. Technical Integration", - "name": "02. Technical Integration", - "children": [ - { - "path": "docs/02. Technical Integration/01. Connector Registration", - "name": "01. Connector Registration", - "children": [ - { - "path": "docs/02. Technical Integration/01. Connector Registration/01. Summary.md", - "name": "01. Summary.md", - "chapter": ["# Summary"] - }, - { - "path": "docs/02. Technical Integration/01. Connector Registration/02. Implementation.md", - "name": "02. Implementation.md", - "chapter": [ - "# Implementation", - "## 1 Get all MY Connector Registrations", - "#### Logical flow of the service", - "#### API Details", - "## 2 Create new Connector Registration - self-owned", - "#### Logical flow of the service", - "#### API Details", - "## 3 Create new Connector Registration - managedĀ ", - "#### Logical flow of the service", - "#### API Details", - "## 4 Retrigger DAPS", - "#### API Details", - "## 5 Delete Connector", - "#### API Details", - "## DB Model" - ] - }, - { - "path": "docs/02. Technical Integration/01. Connector Registration/03. FAQ.md", - "name": "03. FAQ.md", - "chapter": [ - "## FAQ", - "### How to register a connector inside the network?", - "### Whats the difference of a OWNED and a MANAGED connector?", - "### How can a connector get deleted?", - "### What is a \"PENDING\" connector?", - "### Why is my connector authentication icon green or grey?", - "### Whats a public key and how do I create the public key?", - "##### Steps to install OpenSSL on mac with brew:", - "###### Step 1: Install brew", - "###### Step 2: Add Homebrew to your path and install openssl", - "###### Step 3: Navigate to the folder having openssl.cnf and run the command" - ] - } - ] - }, - { - "path": "docs/02. Technical Integration/02. Identity Provider Management", - "name": "02. Identity Provider Management", - "children": [ - { - "path": "docs/02. Technical Integration/02. Identity Provider Management/01. Summary.md", - "name": "01. Summary.md", - "chapter": ["# Summary"] - }, - { - "path": "docs/02. Technical Integration/02. Identity Provider Management/02. User Description.md", - "name": "02. User Description.md", - "chapter": [ - "# User Description", - "### Register your company IdP", - "#### Create the new idp record", - "#### Migrate existing user accounts to the new created IdP" - ] - }, - { - "path": "docs/02. Technical Integration/02. Identity Provider Management/03. FAQ.md", - "name": "03. FAQ.md", - "chapter": [ - "### FAQ", - "#### ?" - ] - } - ] - }, - { - "path": "docs/04. App(s)/Marketplace", - "name": "Marketplace", - "children": [ - { - "path": "docs/04. App(s)/Marketplace/Design.md", - "name": "Design.md", - "chapter": [ - "## App Favorites", - "## App Overview", - "## App Details", - "## My Business Applications" - ] - }, - { - "path": "docs/04. App(s)/Marketplace/FAQ.md", - "name": "FAQ.md", - "chapter": [ - "### FAQ", - "#### ?" - ] - } - ] - }, - { - "path": "docs/04. App(s)/Marketplace", - "name": "Marketplace", - "children": [ - { - "path": "docs/04. App(s)/Marketplace/Design.md", - "name": "Design.md", - "chapter": [ - "## App Favorites", - "## App Overview", - "## App Details", - "## My Business Applications" - ] - }, - { - "path": "docs/04. App(s)/Marketplace/FAQ.md", - "name": "FAQ.md", - "chapter": [ - "### FAQ", - "#### ?" - ] - } - ] - }, - { - "path": "docs/04. App(s)/App-Change-Process.md", - "name": "App-Change-Process.md", - "chapter": ["# Summary", "# Function", "# Implementation"] - }, - { - "path": "docs/04. App(s)/Index.md", - "name": "Index.md", - "chapter": [ - "# Summary", - "### App Marketplace in Catena-X", - "### Service Marketplace in Catena-X" - ] - } - ] - }, - { - "path": "docs/05. Service(s)", - "name": "05. Service(s)", - "children": [ - { - "path": "docs/05. Service(s)/Service Marketplace", - "name": "Service Marketplace", - "children": [ - { - "path": "docs/05. Service(s)/Service Marketplace/01. Service Marketplace - IMPL.md", - "name": "01. Service Marketplace - IMPL.md", - "chapter": [ - "## Service Marketplace", - "## Implementation Details", - "### #1 Search", - "### #2 Filter", - "### #3 Sorting", - "### #4 Get all active services" - ] - }, - { - "path": "docs/05. Service(s)/Service Marketplace/01. Service Marketplace.md", - "name": "01. Service Marketplace.md", - "chapter": [ - "# Summary", - "# Functionality", - "### Service Marketplace Overview", - "### Service Marketplace - Service Details" - ] - }, - { - "path": "docs/05. Service(s)/Service Marketplace/02. Service Details - IMPL.md", - "name": "02. Service Details - IMPL.md", - "chapter": [ - "## Service Offer Details", - "## Implementation Details", - "### #1 Get Service Offer Details", - "### #2 Get Service Order Details" - ] - }, - { - "path": "docs/05. Service(s)/Service Marketplace/02. Service Details - UPDATE NEEDED.md", - "name": "02. Service Details - UPDATE NEEDED.md", - "chapter": [ - "# Summary", - "# Functionality", - "### Service Marketplace Overview", - "### Service Marketplace - Service Details" - ] - }, - { - "path": "docs/05. Service(s)/Service Marketplace/03. FAQ.md", - "name": "03. FAQ.md", - "chapter": ["### FAQ"] - } - ] - }, - { - "path": "docs/05. Service(s)/Service Release Process", - "name": "Service Release Process", - "children": [ - { - "path": "docs/05. Service(s)/Service Release Process/01. Release Flow - IMPL.md", - "name": "01. Release Flow - IMPL.md", - "chapter": [ - "# Summary", - "# Implementation", - "### #1 Create Service Offering", - "### #2 Update Service Offering", - "### #3 Submit new Service Offering for release/publishing", - "### #4 Approve Service Request", - "### #5 Decline Service Request" - ] - }, - { - "path": "docs/05. Service(s)/Service Release Process/01. Release Flow.md", - "name": "01. Release Flow.md", - "chapter": ["# Summary"] - }, - { - "path": "docs/05. Service(s)/Service Release Process/02. FAQ.md", - "name": "02. FAQ.md", - "chapter": [ - "### FAQ", - "### How can I submit a new service offer for marketplace publishing?" - ] - } - ] - }, - { - "path": "docs/05. Service(s)/Service Subscription", - "name": "Service Subscription", - "children": [ - { - "path": "docs/05. Service(s)/Service Subscription/01. Service Subscription IMPL.md", - "name": "01. Service Subscription IMPL.md", - "chapter": [ - "# Summary", - "# Implementation", - "### #1 Get Service Agreements", - "### #2 Post Subscription Request", - "### #3 Activate Subscription & Tenant" - ] - }, - { - "path": "docs/05. Service(s)/Service Subscription/01. Service Subscription.md", - "name": "01. Service Subscription.md", - "chapter": ["# Summary", "# Connected Documentation"] - }, - { - "path": "docs/05. Service(s)/Service Subscription/02. FAQ.md", - "name": "02. FAQ.md", - "chapter": [ - "### FAQ", - "#### Can I trigger a second service subscription request?", - "#### I dont have subscription rights - how can I receive the necessary rights?", - "#### I triggered a service request what do I need to do now?" - ] - } - ] - } - ] - }, - { - "path": "docs/Style-Guide", - "name": "Style-Guide", - "children": [ - { - "path": "docs/Style-Guide/Static_Page_Template.md", - "name": "Static_Page_Template.md", - "chapter": [ - "## Static Page Template(s)", - "### Templates", - "#### Common Notes", - "#### #1 TextCenterAlignedWithCardGrid", - "#### #2 TextCenterAlignedWithLinkButtonGrid ", - "#### #3 TextImageSideBySideWithCardGrid ", - "#### #4 TextVideoSideBySide ", - "#### #5 Video-Text-Side-By-Side ", - "#### #6 Text-Image-Center-Aligned", - "#### #7 Text-Center-Aligned", - "#### #8 Text-Image-Side-By-Side", - "### Implementation ", - "#### New Page creation", - "#### Enhancing an existing page" - ] - } - ] - } - ] -} diff --git a/public/documentation/data/1.0.0-RC7/developer.json b/public/documentation/data/1.0.0-RC7/developer.json deleted file mode 100644 index 36b446e14..000000000 --- a/public/documentation/data/1.0.0-RC7/developer.json +++ /dev/null @@ -1,1169 +0,0 @@ -{ - "path": "developer", - "name": "Catena-X Developer Documentation", - "children": [ - { - "path": "developer/01. Onboarding", - "name": "01. Onboarding", - "children": [ - { - "path": "developer/01. Onboarding/01. Invite", - "name": "01. Invite", - "children": [ - { - "path": "developer/01. Onboarding/01. Invite/01. Summary.md", - "name": "01. Summary.md", - "chapter": ["## Summary"] - }, - { - "path": "developer/01. Onboarding/01. Invite/02. Overview Invited Companies.md", - "name": "02. Overview Invited Companies.md", - "chapter": ["## Get Invited Companies", "#### API Details"] - }, - { - "path": "developer/01. Onboarding/01. Invite/03. Invite Company : Create Application.md", - "name": "03. Invite Company : Create Application.md", - "chapter": ["## Invite Company", "#### API Details"] - } - ] - }, - { - "path": "developer/01. Onboarding/02. Registration", - "name": "02. Registration", - "children": [ - { - "path": "developer/01. Onboarding/02. Registration/01. Login.md", - "name": "01. Login.md", - "chapter": [ - "# Intro", - "#### Registration Login", - "### Registration Login Details", - "## Portal Login" - ] - }, - { - "path": "developer/01. Onboarding/02. Registration/02. Add Company Data.md", - "name": "02. Add Company Data.md", - "chapter": [ - "# Implementation", - "## Enter / Verify Company Data", - "#### API Details", - "##### Display Company Data Registration Details (pre-saved)", - "###### a) via BPN search and automatic data load", - "###### a) adding the data manually", - "##### Unique Identifier", - "##### Logic implemented for the country specific identifier", - "###### API Response", - "###### Result on UI", - "#A - no unique identifier", - "#B - only one unique identifier (happy path)", - "#C - multiple identifier", - "###### Implemented Pattern", - "###### POST allowed Unique Identifier", - "##### Store / Save Company Data Registration Details" - ] - }, - { - "path": "developer/01. Onboarding/02. Registration/03. Add Additional Users.md", - "name": "03. Add Additional Users.md", - "chapter": [ - "# Implementation", - "## Add Aditional Users", - "#### API Details" - ] - }, - { - "path": "developer/01. Onboarding/02. Registration/04. Company Role & Consent.md", - "name": "04. Company Role & Consent.md", - "chapter": [ - "# Implementation", - "## Select company role & sign terms and conditions", - "#### API Details", - "#1 Roles and agreements are fetched from the consent endpoint", - "#2 Consent Post" - ] - }, - { - "path": "developer/01. Onboarding/02. Registration/05. Document Upload.md", - "name": "05. Document Upload.md", - "chapter": [ - "# Implementation", - "## Upload registration relevant documents", - "#### API Details", - "##### #1 API Get Documents", - "##### #2 API Upload Document", - "##### #3 API Delete Document", - "##### #4 API Download Document" - ] - }, - { - "path": "developer/01. Onboarding/02. Registration/06. Verify Registration Data.md", - "name": "06. Verify Registration Data.md", - "chapter": [ - "# Implementation", - "## Verify your data", - "##### #1 Get application data", - "##### #2 Submit Registration" - ] - } - ] - }, - { - "path": "developer/01. Onboarding/03. Registration Approval", - "name": "03. Registration Approval", - "children": [ - { - "path": "developer/01. Onboarding/03. Registration Approval/01. Summary.md", - "name": "01. Summary.md", - "chapter": [ - "## Summary", - "## Functional Details", - "### Display Application Details" - ] - }, - { - "path": "developer/01. Onboarding/03. Registration Approval/02. View Company Application(s).md", - "name": "02. View Company Application(s).md", - "chapter": [ - "## View Company Application(s)", - "## 1 Get Applications", - "###### Filtering", - "###### Search", - "#### Logical flow of the service", - "#### API Details", - "## 2 Get Application Details", - "#### API Details", - "## 3 Download Documents", - "#### Logical flow of the service", - "#### API Details" - ] - }, - { - "path": "developer/01. Onboarding/03. Registration Approval/03. Registration Approval Process.md", - "name": "03. Registration Approval Process.md", - "chapter": [ - "## Summary", - "### Approval Flow", - "##### Details \"Manual Validation\"", - "###### Scenario: Approve", - "###### Scenario: Decline", - "##### Details \"Create Business Partner Number (if necessary)\"", - "###### Scenario 1 - Registration with BPN", - "###### Scenario 2 - Registration without BPN", - "###### Scenario 3 - manually add BPN as operator (interim supported workflow)", - "##### Details \"Create Managed Identity Wallet\"", - "##### Details \"Clearinghouse Check\"", - "###### Step 1 - manually add BPN as operator (interim supported workflow)", - "###### Step 2 - Clearinghouse response", - "##### Details \"Self-Description Creation LegalPerson\"", - "###### DB Table Content", - "##### Details \"Activation\"", - "### Add/Update BPN for the registration company", - "### Status endpoint - Checklist Details" - ] - } - ] - } - ] - }, - { - "path": "developer/02. Technical Integration", - "name": "02. Technical Integration", - "children": [ - { - "path": "developer/02. Technical Integration/01. Connector Registration", - "name": "01. Connector Registration", - "children": [ - { - "path": "developer/02. Technical Integration/01. Connector Registration/01. Summary.md", - "name": "01. Summary.md", - "chapter": ["# Summary"] - }, - { - "path": "developer/02. Technical Integration/01. Connector Registration/02. View Connector.md", - "name": "02. View Connector.md", - "chapter": [ - "# Implementation", - "## 1 Get all MY Connector Registrations", - "#### Logical flow of the service", - "#### API Details" - ] - }, - { - "path": "developer/02. Technical Integration/01. Connector Registration/03. Create new Connector Registration.md", - "name": "03. Create new Connector Registration.md", - "chapter": [ - "## 1. Create new Connector Registration - self-owned", - "#### Logical flow of the service", - "#### API Details", - "## 2. Create new Connector Registration - managedĀ ", - "#### Logical flow of the service", - "#### API Details" - ] - }, - { - "path": "developer/02. Technical Integration/01. Connector Registration/04. DAPS Registration.md", - "name": "04. DAPS Registration.md", - "chapter": ["## 4 Retrigger DAPS", "#### API Details"] - }, - { - "path": "developer/02. Technical Integration/01. Connector Registration/05. Self Description.md", - "name": "05. Self Description.md", - "chapter": ["## Self Description"] - }, - { - "path": "developer/02. Technical Integration/01. Connector Registration/06. Delete Connector.md", - "name": "06. Delete Connector.md", - "chapter": [ - "## 5 Delete Connector", - "#### API Details", - "## DB Model" - ] - } - ] - }, - { - "path": "developer/02. Technical Integration/02. Identity Provider Management", - "name": "02. Identity Provider Management", - "children": [ - { - "path": "developer/02. Technical Integration/02. Identity Provider Management/01. Summary.md", - "name": "01. Summary.md", - "chapter": ["# Summary"] - }, - { - "path": "developer/02. Technical Integration/02. Identity Provider Management/02. Configure Company IdP.md", - "name": "02. Configure Company IdP.md", - "chapter": [ - "# User Description", - "### Register your company IdP", - "#### Create the new idp record", - "#### Migrate existing user accounts to the new created IdP" - ] - }, - { - "path": "developer/02. Technical Integration/02. Identity Provider Management/03. User Migration.md", - "name": "03. User Migration.md", - "chapter": [ - "#### Migrate existing user accounts to the new created IdP" - ] - }, - { - "path": "developer/02. Technical Integration/02. Identity Provider Management/04. FAQ.md", - "name": "04. FAQ.md", - "chapter": [ - "### FAQ", - "#### ?" - ] - } - ] - }, - { - "path": "docs/04. App(s)/06. App Change Process", - "name": "06. App Change Process", - "children": [ - { - "path": "docs/04. App(s)/06. App Change Process/App Deactivation.md", - "name": "App Deactivation.md", - "chapter": ["## Summary"] - } - ] - }, - { - "path": "docs/04. App(s)/App-Change-Process.md", - "name": "App-Change-Process.md", - "chapter": ["## Summary", "## Function"] - }, - { - "path": "docs/04. App(s)/Index.md", - "name": "Index.md", - "chapter": [ - "# Summary", - "### App Marketplace in Catena-X", - "### Service Marketplace in Catena-X" - ] - } - ] - }, - { - "path": "docs/05. Service(s)", - "name": "05. Service(s)", - "children": [ - { - "path": "docs/05. Service(s)/Service Marketplace", - "name": "Service Marketplace", - "children": [ - { - "path": "docs/05. Service(s)/Service Marketplace/01. Service Marketplace.md", - "name": "01. Service Marketplace.md", - "chapter": [ - "## Summary", - "## Functionality", - "### Service Marketplace Overview" - ] - }, - { - "path": "docs/05. Service(s)/Service Marketplace/02. Service Details.md", - "name": "02. Service Details.md", - "chapter": ["## Service Offer Details"] - }, - { - "path": "docs/05. Service(s)/Service Marketplace/03. FAQ.md", - "name": "03. FAQ.md", - "chapter": ["### FAQ"] - } - ] - }, - { - "path": "docs/05. Service(s)/Service Release Process", - "name": "Service Release Process", - "children": [ - { - "path": "docs/05. Service(s)/Service Release Process/01. Release Flow.md", - "name": "01. Release Flow.md", - "chapter": ["## Summary"] - }, - { - "path": "docs/05. Service(s)/Service Release Process/02. FAQ.md", - "name": "02. FAQ.md", - "chapter": [ - "### FAQ", - "### How can I submit a new service offer for marketplace publishing?" - ] - } - ] - }, - { - "path": "docs/05. Service(s)/Service Subscription", - "name": "Service Subscription", - "children": [ - { - "path": "docs/05. Service(s)/Service Subscription/01. Service Subscription.md", - "name": "01. Service Subscription.md", - "chapter": ["## Summary", "## Connected Documentation"] - }, - { - "path": "docs/05. Service(s)/Service Subscription/02. FAQ.md", - "name": "02. FAQ.md", - "chapter": [ - "### FAQ", - "#### Can I trigger a second service subscription request?", - "#### I dont have subscription rights - how can I receive the necessary rights?", - "#### I triggered a service request what do I need to do now?" - ] - } - ] - } - ] - }, - { - "path": "docs/Style-Guide", - "name": "Style-Guide", - "children": [ - { - "path": "docs/Style-Guide/Static_Page_Template.md", - "name": "Static_Page_Template.md", - "chapter": [ - "## Static Page Template(s)", - "### Templates", - "#### Common Notes", - "#### #1 TextCenterAlignedWithCardGrid", - "#### #2 TextCenterAlignedWithLinkButtonGrid ", - "#### #3 TextImageSideBySideWithCardGrid ", - "#### #4 TextVideoSideBySide ", - "#### #5 Video-Text-Side-By-Side ", - "#### #6 Text-Image-Center-Aligned", - "#### #7 Text-Center-Aligned", - "#### #8 Text-Image-Side-By-Side", - "### Implementation ", - "#### New Page creation", - "#### Enhancing an existing page" - ] - } - ] - } - ] -} diff --git a/public/documentation/data/1.0.0-RC8/developer.json b/public/documentation/data/1.0.0-RC8/developer.json deleted file mode 100644 index 44aaeffc1..000000000 --- a/public/documentation/data/1.0.0-RC8/developer.json +++ /dev/null @@ -1,1317 +0,0 @@ -{ - "path": "developer", - "name": "Catena-X Developer Documentation", - "children": [ - { - "path": "developer/01. Onboarding", - "name": "01. Onboarding", - "children": [ - { - "path": "developer/01. Onboarding/01. Invite", - "name": "01. Invite", - "children": [ - { - "path": "developer/01. Onboarding/01. Invite/01. Summary.md", - "name": "01. Summary.md", - "chapter": ["## Summary"] - }, - { - "path": "developer/01. Onboarding/01. Invite/02. Overview Invited Companies.md", - "name": "02. Overview Invited Companies.md", - "chapter": ["## Get Invited Companies", "#### API Details"] - }, - { - "path": "developer/01. Onboarding/01. Invite/03. Invite Company : Create Application.md", - "name": "03. Invite Company : Create Application.md", - "chapter": ["## Invite Company", "#### API Details"] - } - ] - }, - { - "path": "developer/01. Onboarding/02. Registration", - "name": "02. Registration", - "children": [ - { - "path": "developer/01. Onboarding/02. Registration/01. Login.md", - "name": "01. Login.md", - "chapter": [ - "# Intro", - "#### Registration Login", - "### Registration Login Details", - "## Portal Login" - ] - }, - { - "path": "developer/01. Onboarding/02. Registration/02. Add Company Data.md", - "name": "02. Add Company Data.md", - "chapter": [ - "# Implementation", - "## Enter / Verify Company Data", - "#### API Details", - "##### Display Company Data Registration Details (pre-saved)", - "###### a) via BPN search and automatic data load", - "###### a) adding the data manually", - "##### Unique Identifier", - "##### Logic implemented for the country specific identifier", - "###### API Response", - "###### Result on UI", - "#A - no unique identifier", - "#B - only one unique identifier (happy path)", - "#C - multiple identifier", - "###### Implemented Pattern", - "###### POST allowed Unique Identifier", - "##### Store / Save Company Data Registration Details" - ] - }, - { - "path": "developer/01. Onboarding/02. Registration/03. Add Additional Users.md", - "name": "03. Add Additional Users.md", - "chapter": [ - "# Implementation", - "## Add Aditional Users", - "#### API Details" - ] - }, - { - "path": "developer/01. Onboarding/02. Registration/04. Company Role & Consent.md", - "name": "04. Company Role & Consent.md", - "chapter": [ - "# Implementation", - "## Select company role & sign terms and conditions", - "#### API Details", - "#1 Roles and agreements are fetched from the consent endpoint", - "#2 Consent Post" - ] - }, - { - "path": "developer/01. Onboarding/02. Registration/05. Document Upload.md", - "name": "05. Document Upload.md", - "chapter": [ - "# Implementation", - "## Upload registration relevant documents", - "#### API Details", - "##### #1 API Get Documents", - "##### #2 API Upload Document", - "##### #3 API Delete Document", - "##### #4 API Download Document" - ] - }, - { - "path": "developer/01. Onboarding/02. Registration/06. Verify Registration Data.md", - "name": "06. Verify Registration Data.md", - "chapter": [ - "# Implementation", - "## Verify your data", - "##### #1 Get application data", - "##### #2 Submit Registration" - ] - } - ] - }, - { - "path": "developer/01. Onboarding/03. Registration Approval", - "name": "03. Registration Approval", - "children": [ - { - "path": "developer/01. Onboarding/03. Registration Approval/01. Summary.md", - "name": "01. Summary.md", - "chapter": [ - "## Summary", - "## Functional Details", - "### Display Application Details" - ] - }, - { - "path": "developer/01. Onboarding/03. Registration Approval/02. View Company Application(s).md", - "name": "02. View Company Application(s).md", - "chapter": [ - "## View Company Application(s)", - "## 1 Get Applications", - "###### Filtering", - "###### Search", - "#### Logical flow of the service", - "#### API Details", - "## 2 Get Application Details", - "#### API Details Get Company Registration Data", - "##### Response Body / Details:", - "#### API Details Get Company Checklist Status", - "## 3 Download Documents", - "#### Logical flow of the service", - "#### API Details" - ] - }, - { - "path": "developer/01. Onboarding/03. Registration Approval/03. Registration Approval Process.md", - "name": "03. Registration Approval Process.md", - "chapter": [ - "## Summary", - "### Approval Overlay/Status", - "##### #1 Registration Validation", - "##### #2 BPN Creation", - "##### #3 Managed Identity Wallet", - "##### #4 Clearinghouse", - "##### #5 Self Description LP", - "### Approval Flow", - "#### Details \"Manual Validation\"", - "##### Scenario: Approve", - "##### Scenario: Decline", - "##### Details \"Create Business Partner Number (if necessary)\"", - "##### Scenario 1 - Registration with BPN", - "##### Scenario 2 - Registration without BPN", - "##### Scenario 3 - manually add BPN as an operator (interim supported workflow)", - "##### Details \"Create Managed Identity Wallet\"", - "#### Details \"Clearinghouse Check\"", - "###### Step 1 - Send company data to clearinghouse", - "###### Step 2 - Clearinghouse response", - "##### Details \"Self-Description Creation LegalPerson\"", - "###### Step 1 - Create SelfDescription - send company data to SD Factory", - "###### Step 2 - Save self description document", - "###### DB Table Content", - "##### Details \"Activation\"", - "### Add/Update BPN for the registration company", - "### Status endpoint - Checklist Details" - ] - }, - { - "path": "developer/01. Onboarding/03. Registration Approval/04. Decline Application.md", - "name": "04. Decline Application.md", - "chapter": [ - "## Decline Company Application", - "##### API Implementation" - ] - } - ] - } - ] - }, - { - "path": "developer/02. Technical Integration", - "name": "02. Technical Integration", - "children": [ - { - "path": "developer/02. Technical Integration/01. Connector Registration", - "name": "01. Connector Registration", - "children": [ - { - "path": "developer/02. Technical Integration/01. Connector Registration/01. Summary.md", - "name": "01. Summary.md", - "chapter": ["# Summary"] - }, - { - "path": "developer/02. Technical Integration/01. Connector Registration/02. View Connector.md", - "name": "02. View Connector.md", - "chapter": [ - "## View Connector", - "## Details", - "##### Status:", - "##### SD Registration:", - "##### Host:", - "## Implementation/APIs", - "### 1 Get all MY Connector Registrations", - "#### Logical flow of the service", - "#### API Details" - ] - }, - { - "path": "developer/02. Technical Integration/01. Connector Registration/03. Create new Connector Registration.md", - "name": "03. Create new Connector Registration.md", - "chapter": [ - "## 1. Create new Connector Registration - self-owned", - "#### Details to the DAPS", - "#### Details to the SD", - "##### #1 Self description request", - "##### #2 Self description response (asynchron)", - "#### Logical flow of the service", - "#### API Details", - "## 2. Create new Connector Registration - managedĀ ", - "#### Logical flow of the service", - "#### API Details" - ] - }, - { - "path": "developer/02. Technical Integration/01. Connector Registration/04. DAPS Registration.md", - "name": "04. DAPS Registration.md", - "chapter": ["## 4 Retrigger DAPS", "#### API Details"] - }, - { - "path": "developer/02. Technical Integration/01. Connector Registration/05. Self Description.md", - "name": "05. Self Description.md", - "chapter": [ - "## Self Description", - "### Implementation Details", - "#### Send Company Data to SD Factory (Create SD)", - "#### SD CallBack Service" - ] - }, - { - "path": "developer/02. Technical Integration/01. Connector Registration/06. Delete Connector.md", - "name": "06. Delete Connector.md", - "chapter": ["## 5 Delete Connector", "#### API Details"] - } - ] - }, - { - "path": "developer/02. Technical Integration/02. Identity Provider Management", - "name": "02. Identity Provider Management", - "children": [ - { - "path": "developer/02. Technical Integration/02. Identity Provider Management/01. Summary.md", - "name": "01. Summary.md", - "chapter": ["# Summary"] - }, - { - "path": "developer/02. Technical Integration/02. Identity Provider Management/02. Configure Company IdP.md", - "name": "02. Configure Company IdP.md", - "chapter": [ - "# User Description", - "### Register your company IdP", - "#### Create the new idp record" - ] - }, - { - "path": "developer/02. Technical Integration/02. Identity Provider Management/03. User Migration.md", - "name": "03. User Migration.md", - "chapter": [ - "#### Migrate existing user accounts to the new created IdP" - ] - }, - { - "path": "developer/02. Technical Integration/02. Identity Provider Management/04. FAQ.md", - "name": "04. FAQ.md", - "chapter": [ - "### FAQ", - "#### ?" - ] - } - ] - }, - { - "path": "docs/04. App(s)/06. App Change Process", - "name": "06. App Change Process", - "children": [ - { - "path": "docs/04. App(s)/06. App Change Process/01. Summary.md", - "name": "01. Summary.md", - "chapter": ["## Summary", "## Function"] - }, - { - "path": "docs/04. App(s)/06. App Change Process/02. App Deactivation.md", - "name": "02. App Deactivation.md", - "chapter": ["## Summary"] - } - ] - }, - { - "path": "docs/04. App(s)/07. App Provider Management", - "name": "07. App Provider Management", - "children": [ - { - "path": "docs/04. App(s)/07. App Provider Management/01. Open API.md", - "name": "01. Open API.md", - "chapter": [ - "## Open API - Offer Autosetup", - "## Interface / API / Service Summary", - "## Architecture Overview", - "## Implementation", - "### #1 PUT Service URL", - "### #2 POST Service Request", - "### #3 POST Service Instance" - ] - } - ] - }, - { - "path": "docs/04. App(s)/index.md", - "name": "index.md", - "chapter": ["# Summary", "### App Marketplace in Catena-X"] - } - ] - }, - { - "path": "docs/05. Service(s)", - "name": "05. Service(s)", - "children": [ - { - "path": "docs/05. Service(s)/01. Service Marketplace", - "name": "01. Service Marketplace", - "children": [ - { - "path": "docs/05. Service(s)/01. Service Marketplace/01. Service Marketplace.md", - "name": "01. Service Marketplace.md", - "chapter": [ - "## Summary", - "## Functionality", - "### Service Marketplace Overview" - ] - }, - { - "path": "docs/05. Service(s)/01. Service Marketplace/02. Service Details.md", - "name": "02. Service Details.md", - "chapter": ["## Service Offer Details"] - }, - { - "path": "docs/05. Service(s)/01. Service Marketplace/03. FAQ.md", - "name": "03. FAQ.md", - "chapter": ["### FAQ"] - } - ] - }, - { - "path": "docs/05. Service(s)/02. Service Release Process", - "name": "02. Service Release Process", - "children": [ - { - "path": "docs/05. Service(s)/02. Service Release Process/01. Release Flow.md", - "name": "01. Release Flow.md", - "chapter": ["## Summary"] - }, - { - "path": "docs/05. Service(s)/02. Service Release Process/02. FAQ.md", - "name": "02. FAQ.md", - "chapter": [ - "### FAQ", - "### How can I submit a new service offer for marketplace publishing?" - ] - } - ] - }, - { - "path": "docs/05. Service(s)/03. Service Subscription", - "name": "03. Service Subscription", - "children": [ - { - "path": "docs/05. Service(s)/03. Service Subscription/01. Service Subscription.md", - "name": "01. Service Subscription.md", - "chapter": ["## Summary", "## Connected Documentation"] - }, - { - "path": "docs/05. Service(s)/03. Service Subscription/02. FAQ.md", - "name": "02. FAQ.md", - "chapter": [ - "### FAQ", - "#### Can I trigger a second service subscription request?", - "#### I dont have subscription rights - how can I receive the necessary rights?", - "#### I triggered a service request what do I need to do now?" - ] - } - ] - }, - { - "path": "docs/05. Service(s)/index.md", - "name": "index.md", - "chapter": ["## Service Marketplace in Catena-X"] - } - ] - }, - { - "path": "docs/Style-Guide", - "name": "Style-Guide", - "children": [ - { - "path": "docs/Style-Guide/Static_Page_Template.md", - "name": "Static_Page_Template.md", - "chapter": [ - "## Static Page Template(s)", - "### Templates", - "#### Common Notes", - "#### #1 TextCenterAlignedWithCardGrid", - "#### #2 TextCenterAlignedWithLinkButtonGrid ", - "#### #3 TextImageSideBySideWithCardGrid ", - "#### #4 TextVideoSideBySide ", - "#### #5 Video-Text-Side-By-Side ", - "#### #6 Text-Image-Center-Aligned", - "#### #7 Text-Center-Aligned", - "#### #8 Text-Image-Side-By-Side", - "### Implementation ", - "#### New Page creation", - "#### Enhancing an existing page" - ] - } - ] - } - ] -} diff --git a/public/documentation/data/1.0.0/developer.json b/public/documentation/data/1.0.0/developer.json deleted file mode 100644 index 2cb551935..000000000 --- a/public/documentation/data/1.0.0/developer.json +++ /dev/null @@ -1,1335 +0,0 @@ -{ - "path": "developer", - "name": "Catena-X Developer Documentation", - "children": [ - { - "path": "developer/01. Onboarding", - "name": "01. Onboarding", - "children": [ - { - "path": "developer/01. Onboarding/01. Invite", - "name": "01. Invite", - "children": [ - { - "path": "developer/01. Onboarding/01. Invite/01. Summary.md", - "name": "01. Summary.md", - "chapter": ["## Summary"] - }, - { - "path": "developer/01. Onboarding/01. Invite/02. Overview Invited Companies.md", - "name": "02. Overview Invited Companies.md", - "chapter": ["## Get Invited Companies", "#### API Details"] - }, - { - "path": "developer/01. Onboarding/01. Invite/03. Invite Company : Create Application.md", - "name": "03. Invite Company : Create Application.md", - "chapter": ["## Invite Company", "#### API Details"] - } - ] - }, - { - "path": "developer/01. Onboarding/02. Registration", - "name": "02. Registration", - "children": [ - { - "path": "developer/01. Onboarding/02. Registration/01. Login.md", - "name": "01. Login.md", - "chapter": [ - "# Intro", - "#### Registration Login", - "### Registration Login Details", - "## Portal Login" - ] - }, - { - "path": "developer/01. Onboarding/02. Registration/02. Add Company Data.md", - "name": "02. Add Company Data.md", - "chapter": [ - "# Implementation", - "## Enter / Verify Company Data", - "#### API Details", - "##### Display Company Data Registration Details (pre-saved)", - "###### a) via BPN search and automatic data load", - "###### a) adding the data manually", - "##### Unique Identifier", - "##### Logic implemented for the country specific identifier", - "###### API Response", - "###### Result on UI", - "#A - no unique identifier", - "#B - only one unique identifier (happy path)", - "#C - multiple identifier", - "###### Implemented Pattern", - "###### POST allowed Unique Identifier", - "##### Store / Save Company Data Registration Details" - ] - }, - { - "path": "developer/01. Onboarding/02. Registration/03. Add Additional Users.md", - "name": "03. Add Additional Users.md", - "chapter": [ - "# Implementation", - "## Add Aditional Users", - "#### API Details" - ] - }, - { - "path": "developer/01. Onboarding/02. Registration/04. Company Role & Consent.md", - "name": "04. Company Role & Consent.md", - "chapter": [ - "# Implementation", - "## Select company role & sign terms and conditions", - "#### API Details", - "#1 Roles and agreements are fetched from the consent endpoint", - "#2 Consent Post" - ] - }, - { - "path": "developer/01. Onboarding/02. Registration/05. Document Upload.md", - "name": "05. Document Upload.md", - "chapter": [ - "# Implementation", - "## Upload registration relevant documents", - "#### API Details", - "##### #1 API Get Documents", - "##### #2 API Upload Document", - "##### #3 API Delete Document", - "##### #4 API Download Document" - ] - }, - { - "path": "developer/01. Onboarding/02. Registration/06. Verify Registration Data.md", - "name": "06. Verify Registration Data.md", - "chapter": [ - "# Implementation", - "## Verify your data", - "##### #1 Get application data", - "##### #2 Submit Registration" - ] - } - ] - }, - { - "path": "developer/01. Onboarding/03. Registration Approval", - "name": "03. Registration Approval", - "children": [ - { - "path": "developer/01. Onboarding/03. Registration Approval/01. Summary.md", - "name": "01. Summary.md", - "chapter": [ - "## Summary", - "## Functional Details", - "### Display Application Details" - ] - }, - { - "path": "developer/01. Onboarding/03. Registration Approval/02. View Company Application(s).md", - "name": "02. View Company Application(s).md", - "chapter": [ - "## View Company Application(s)", - "## 1 Get Applications", - "###### Filtering", - "###### Search", - "#### Logical flow of the service", - "#### API Details", - "## 2 Get Application Details", - "#### API Details Get Company Registration Data", - "##### Response Body / Details:", - "#### API Details Get Company Checklist Status", - "## 3 Download Documents", - "#### Logical flow of the service", - "#### API Details" - ] - }, - { - "path": "developer/01. Onboarding/03. Registration Approval/03. Registration Approval Process.md", - "name": "03. Registration Approval Process.md", - "chapter": [ - "## Summary", - "### Approval Overlay/Status", - "##### #1 Registration Validation", - "##### #2 BPN Creation", - "##### #3 Managed Identity Wallet", - "##### #4 Clearinghouse", - "##### #5 Self Description LP", - "### Approval Flow", - "#### Details \"Manual Validation\"", - "##### Scenario: Approve", - "##### Scenario: Decline", - "##### Details \"Create Business Partner Number (if necessary)\"", - "##### Scenario 1 - Registration with BPN", - "##### Scenario 2 - Registration without BPN", - "##### Scenario 3 - manually add BPN as an operator (interim supported workflow)", - "##### Details \"Create Managed Identity Wallet\"", - "#### Details \"Clearinghouse Check\"", - "###### Step 1 - Send company data to clearinghouse", - "###### Step 2 - Clearinghouse response", - "##### Details \"Self-Description Creation LegalPerson\"", - "###### Step 1 - Create SelfDescription - send company data to SD Factory", - "###### Step 2 - Save self description document", - "###### DB Table Content", - "##### Details \"Activation\"", - "### Add/Update BPN for the registration company", - "### Status endpoint - Checklist Details" - ] - }, - { - "path": "developer/01. Onboarding/03. Registration Approval/04. Decline Application.md", - "name": "04. Decline Application.md", - "chapter": [ - "## Decline Company Application", - "##### API Implementation" - ] - } - ] - } - ] - }, - { - "path": "developer/02. Technical Integration", - "name": "02. Technical Integration", - "children": [ - { - "path": "developer/02. Technical Integration/01. Connector Registration", - "name": "01. Connector Registration", - "children": [ - { - "path": "developer/02. Technical Integration/01. Connector Registration/01. Summary.md", - "name": "01. Summary.md", - "chapter": ["# Summary"] - }, - { - "path": "developer/02. Technical Integration/01. Connector Registration/02. View Connector.md", - "name": "02. View Connector.md", - "chapter": [ - "## View Connector", - "## Details", - "##### Status:", - "##### SD Registration:", - "##### Host:", - "## Implementation/APIs", - "### 1 Get all MY Connector Registrations", - "#### Logical flow of the service", - "#### API Details" - ] - }, - { - "path": "developer/02. Technical Integration/01. Connector Registration/03. Create new Connector Registration.md", - "name": "03. Create new Connector Registration.md", - "chapter": [ - "## 1. Create new Connector Registration - self-owned", - "#### Details to the DAPS", - "#### Details to the SD", - "##### #1 Self description request", - "##### #2 Self description response (asynchron)", - "#### Logical flow of the service", - "#### API Details", - "## 2. Create new Connector Registration - managedĀ ", - "#### Logical flow of the service", - "#### API Details" - ] - }, - { - "path": "developer/02. Technical Integration/01. Connector Registration/04. DAPS Registration.md", - "name": "04. DAPS Registration.md", - "chapter": ["## 4 Retrigger DAPS", "#### API Details"] - }, - { - "path": "developer/02. Technical Integration/01. Connector Registration/05. Self Description.md", - "name": "05. Self Description.md", - "chapter": [ - "## Self Description", - "### Implementation Details", - "#### Send Company Data to SD Factory (Create SD)", - "#### SD CallBack Service" - ] - }, - { - "path": "developer/02. Technical Integration/01. Connector Registration/06. Delete Connector.md", - "name": "06. Delete Connector.md", - "chapter": ["## 5 Delete Connector", "#### API Details"] - } - ] - }, - { - "path": "developer/02. Technical Integration/02. Identity Provider Management", - "name": "02. Identity Provider Management", - "children": [ - { - "path": "developer/02. Technical Integration/02. Identity Provider Management/01. Summary.md", - "name": "01. Summary.md", - "chapter": ["# Summary"] - }, - { - "path": "developer/02. Technical Integration/02. Identity Provider Management/02. Configure Company IdP.md", - "name": "02. Configure Company IdP.md", - "chapter": [ - "# User Description", - "### Register your company IdP", - "#### Create the new idp record" - ] - }, - { - "path": "developer/02. Technical Integration/02. Identity Provider Management/03. User Migration.md", - "name": "03. User Migration.md", - "chapter": [ - "#### Migrate existing user accounts to the new created IdP" - ] - }, - { - "path": "developer/02. Technical Integration/02. Identity Provider Management/04. FAQ.md", - "name": "04. FAQ.md", - "chapter": [ - "### FAQ", - "#### ?" - ] - } - ] - }, - { - "path": "docs/04. App(s)/06. App Change Process", - "name": "06. App Change Process", - "children": [ - { - "path": "docs/04. App(s)/06. App Change Process/01. Summary.md", - "name": "01. Summary.md", - "chapter": ["## Summary", "## Function"] - }, - { - "path": "docs/04. App(s)/06. App Change Process/02. App Deactivation.md", - "name": "02. App Deactivation.md", - "chapter": ["## Summary"] - } - ] - }, - { - "path": "docs/04. App(s)/07. App Provider Management", - "name": "07. App Provider Management", - "children": [ - { - "path": "docs/04. App(s)/07. App Provider Management/01. Open API.md", - "name": "01. Open API.md", - "chapter": [ - "## Open API - Offer Autosetup", - "## Interface / API / Service Summary", - "## Architecture Overview", - "## Implementation", - "### #1 PUT Service URL", - "### #2 POST Service Request", - "### #3 POST Service Instance" - ] - } - ] - }, - { - "path": "docs/04. App(s)/index.md", - "name": "index.md", - "chapter": ["# Summary", "### App Marketplace in Catena-X"] - } - ] - }, - { - "path": "docs/05. Service(s)", - "name": "05. Service(s)", - "children": [ - { - "path": "docs/05. Service(s)/01. Service Marketplace", - "name": "01. Service Marketplace", - "children": [ - { - "path": "docs/05. Service(s)/01. Service Marketplace/01. Service Marketplace.md", - "name": "01. Service Marketplace.md", - "chapter": [ - "## Summary", - "## Functionality", - "### Service Marketplace Overview" - ] - }, - { - "path": "docs/05. Service(s)/01. Service Marketplace/02. Service Details.md", - "name": "02. Service Details.md", - "chapter": ["## Service Offer Details"] - }, - { - "path": "docs/05. Service(s)/01. Service Marketplace/03. FAQ.md", - "name": "03. FAQ.md", - "chapter": ["### FAQ"] - } - ] - }, - { - "path": "docs/05. Service(s)/02. Service Release Process", - "name": "02. Service Release Process", - "children": [ - { - "path": "docs/05. Service(s)/02. Service Release Process/01. Release Flow.md", - "name": "01. Release Flow.md", - "chapter": ["## Summary"] - }, - { - "path": "docs/05. Service(s)/02. Service Release Process/02. FAQ.md", - "name": "02. FAQ.md", - "chapter": [ - "### FAQ", - "### How can I submit a new service offer for marketplace publishing?" - ] - } - ] - }, - { - "path": "docs/05. Service(s)/03. Service Subscription", - "name": "03. Service Subscription", - "children": [ - { - "path": "docs/05. Service(s)/03. Service Subscription/01. Service Subscription.md", - "name": "01. Service Subscription.md", - "chapter": ["## Summary", "## Connected Documentation"] - }, - { - "path": "docs/05. Service(s)/03. Service Subscription/02. FAQ.md", - "name": "02. FAQ.md", - "chapter": [ - "### FAQ", - "#### Can I trigger a second service subscription request?", - "#### I dont have subscription rights - how can I receive the necessary rights?", - "#### I triggered a service request what do I need to do now?" - ] - } - ] - }, - { - "path": "docs/05. Service(s)/index.md", - "name": "index.md", - "chapter": ["## Service Marketplace in Catena-X"] - } - ] - }, - { - "path": "docs/Style-Guide", - "name": "Style-Guide", - "children": [ - { - "path": "docs/Style-Guide/Static_Page_Template.md", - "name": "Static_Page_Template.md", - "chapter": [ - "## Static Page Template(s)", - "### Templates", - "#### Common Notes", - "#### #1 TextCenterAlignedWithCardGrid", - "#### #2 TextCenterAlignedWithLinkButtonGrid ", - "#### #3 TextImageSideBySideWithCardGrid ", - "#### #4 TextVideoSideBySide ", - "#### #5 Video-Text-Side-By-Side ", - "#### #6 Text-Image-Center-Aligned", - "#### #7 Text-Center-Aligned", - "#### #8 Text-Image-Side-By-Side", - "### Implementation ", - "#### New Page creation", - "#### Enhancing an existing page" - ] - } - ] - } - ] -} diff --git a/public/documentation/data/1.1.0/developer.json b/public/documentation/data/1.1.0/developer.json deleted file mode 100644 index 4ef28f4cf..000000000 --- a/public/documentation/data/1.1.0/developer.json +++ /dev/null @@ -1,1376 +0,0 @@ -{ - "path": "developer", - "name": "Catena-X Developer Documentation", - "children": [ - { - "path": "developer/01. Onboarding", - "name": "01. Onboarding", - "children": [ - { - "path": "developer/01. Onboarding/01. Invite", - "name": "01. Invite", - "children": [ - { - "path": "developer/01. Onboarding/01. Invite/01. Summary.md", - "name": "01. Summary.md", - "chapter": ["## Summary"] - }, - { - "path": "developer/01. Onboarding/01. Invite/02. Overview Invited Companies.md", - "name": "02. Overview Invited Companies.md", - "chapter": ["## Get Invited Companies", "#### API Details"] - }, - { - "path": "developer/01. Onboarding/01. Invite/03. Invite Company : Create Application.md", - "name": "03. Invite Company : Create Application.md", - "chapter": ["## Invite Company", "#### API Details"] - } - ] - }, - { - "path": "developer/01. Onboarding/02. Registration", - "name": "02. Registration", - "children": [ - { - "path": "developer/01. Onboarding/02. Registration/01. Login.md", - "name": "01. Login.md", - "chapter": [ - "# Intro", - "#### Registration Login", - "### Registration Login Details", - "## Portal Login" - ] - }, - { - "path": "developer/01. Onboarding/02. Registration/02. Add Company Data.md", - "name": "02. Add Company Data.md", - "chapter": [ - "## Add Company Data", - "## Functional View", - "## Implementation View", - "### Enter Company Data", - "#### a) via BPN search and automatic data load", - "#### b) manually entered", - "##### Unique Identifier", - "###### Logic implemented for the country specific identifier", - "###### Result on UI", - "#A - no unique identifier", - "#B - only one unique identifier (happy path)", - "#C - multiple identifier", - "###### Implemented Pattern", - "###### POST allowed Unique Identifier", - "### Store/Save Company Data", - "### Display Company Data (pre-saved)" - ] - }, - { - "path": "developer/01. Onboarding/02. Registration/03. Add Additional Users.md", - "name": "03. Add Additional Users.md", - "chapter": [ - "# Implementation", - "## Add Aditional Users", - "#### API Details" - ] - }, - { - "path": "developer/01. Onboarding/02. Registration/04. Company Role & Consent.md", - "name": "04. Company Role & Consent.md", - "chapter": [ - "# Implementation", - "## Select company role & sign terms and conditions", - "#### API Details", - "#1 Roles and agreements are fetched from the consent endpoint", - "#2 Consent Post" - ] - }, - { - "path": "developer/01. Onboarding/02. Registration/05. Document Upload.md", - "name": "05. Document Upload.md", - "chapter": [ - "# Implementation", - "## Upload registration relevant documents", - "#### API Details", - "##### #1 API Get Documents", - "##### #2 API Upload Document", - "##### #3 API Delete Document", - "##### #4 API Download Document" - ] - }, - { - "path": "developer/01. Onboarding/02. Registration/06. Verify Registration Data.md", - "name": "06. Verify Registration Data.md", - "chapter": [ - "# Implementation", - "## Verify your data", - "##### #1 Get application data", - "##### #2 Submit Registration" - ] - }, - { - "path": "developer/01. Onboarding/02. Registration/07. Error Scenarios.md", - "name": "07. Error Scenarios.md", - "chapter": [ - "## Error Scenarios", - "### System Availability", - "### 1 Login", - "### 2 Company Data", - "### 3 Invite Users", - "### 4 Company Role and Terms&Conditions", - "### 5 Document Load", - "### 6 Verify Data" - ] - } - ] - }, - { - "path": "developer/01. Onboarding/03. Registration Approval", - "name": "03. Registration Approval", - "children": [ - { - "path": "developer/01. Onboarding/03. Registration Approval/02. View Company Application(s).md", - "name": "02. View Company Application(s).md", - "chapter": [ - "## View Company Application(s)", - "## 1 Get Applications", - "###### Filtering", - "###### Search", - "#### Logical flow of the service", - "#### API Details", - "## 2 Get Application Details", - "#### API Details Get Company Registration Data", - "##### Response Body / Details:", - "#### API Details Get Company Checklist Status", - "## 3 Download Documents", - "#### Logical flow of the service", - "#### API Details" - ] - }, - { - "path": "developer/01. Onboarding/03. Registration Approval/03. Registration Approval Process.md", - "name": "03. Registration Approval Process.md", - "chapter": [ - "## Summary", - "### Approval Overlay/Status", - "##### #1 Registration Validation", - "##### #2 BPN Creation", - "##### #3 Managed Identity Wallet", - "##### #4 Clearinghouse", - "##### #5 Self Description LP", - "### Approval Flow", - "#### Details \"Manual Validation\"", - "##### Scenario: Approve", - "##### Scenario: Decline", - "##### Details \"Create Business Partner Number (if necessary)\"", - "##### Scenario 1 - Registration with BPN", - "##### Scenario 2 - Registration without BPN", - "##### Scenario 3 - manually add BPN as an operator (interim supported workflow)", - "##### Details \"Create Managed Identity Wallet\"", - "#### Details \"Clearinghouse Check\"", - "###### Step 1 - Send company data to clearinghouse", - "###### Step 2 - Clearinghouse response", - "##### Details \"Self-Description Creation LegalPerson\"", - "###### Step 1 - Create SelfDescription - send company data to SD Factory", - "###### Step 2 - Save self description document", - "###### DB Table Content", - "##### Details \"Activation\"", - "### Add/Update BPN for the registration company", - "### Status endpoint - Checklist Details" - ] - }, - { - "path": "developer/01. Onboarding/03. Registration Approval/04. Decline Application.md", - "name": "04. Decline Application.md", - "chapter": [ - "## Decline Company Application", - "##### API Implementation" - ] - }, - { - "path": "developer/01. Onboarding/03. Registration Approval/index.md", - "name": "index.md", - "chapter": [ - "## Summary", - "## Functional Details", - "### Display Application Details" - ] - } - ] - } - ] - }, - { - "path": "developer/02. Technical Integration", - "name": "02. Technical Integration", - "children": [ - { - "path": "developer/02. Technical Integration/01. Connector Registration", - "name": "01. Connector Registration", - "children": [ - { - "path": "developer/02. Technical Integration/01. Connector Registration/01. Summary.md", - "name": "01. Summary.md", - "chapter": ["# Summary"] - }, - { - "path": "developer/02. Technical Integration/01. Connector Registration/02. View Connector.md", - "name": "02. View Connector.md", - "chapter": [ - "## View Connector", - "## Details", - "##### Status:", - "##### SD Registration:", - "##### Host:", - "## Implementation/APIs", - "### 1 Get all MY Connector Registrations", - "#### Logical flow of the service", - "#### API Details" - ] - }, - { - "path": "developer/02. Technical Integration/01. Connector Registration/03. Create new Connector Registration.md", - "name": "03. Create new Connector Registration.md", - "chapter": [ - "## 1. Create new Connector Registration - self-owned", - "#### Details to the DAPS", - "#### Details to the SD", - "##### #1 Self description request", - "##### #2 Self description response (asynchron)", - "#### Logical flow of the service", - "#### API Details", - "## 2. Create new Connector Registration - managedĀ ", - "#### Logical flow of the service", - "#### API Details" - ] - }, - { - "path": "developer/02. Technical Integration/01. Connector Registration/04. DAPS Registration.md", - "name": "04. DAPS Registration.md", - "chapter": ["## 4 Retrigger DAPS", "#### API Details"] - }, - { - "path": "developer/02. Technical Integration/01. Connector Registration/05. Self Description.md", - "name": "05. Self Description.md", - "chapter": [ - "## Self Description", - "### Implementation Details", - "#### Send Company Data to SD Factory (Create SD)", - "#### SD CallBack Service" - ] - }, - { - "path": "developer/02. Technical Integration/01. Connector Registration/06. Delete Connector.md", - "name": "06. Delete Connector.md", - "chapter": ["## 5 Delete Connector", "#### API Details"] - } - ] - }, - { - "path": "developer/02. Technical Integration/02. Identity Provider Management", - "name": "02. Identity Provider Management", - "children": [ - { - "path": "developer/02. Technical Integration/02. Identity Provider Management/01. Summary.md", - "name": "01. Summary.md", - "chapter": ["# Summary"] - }, - { - "path": "developer/02. Technical Integration/02. Identity Provider Management/02. Configure Company IdP.md", - "name": "02. Configure Company IdP.md", - "chapter": [ - "# User Description", - "### Register your company IdP", - "#### Create the new idp record" - ] - }, - { - "path": "developer/02. Technical Integration/02. Identity Provider Management/03. User Migration.md", - "name": "03. User Migration.md", - "chapter": [ - "#### Migrate existing user accounts to the new created IdP" - ] - }, - { - "path": "developer/02. Technical Integration/02. Identity Provider Management/04. FAQ.md", - "name": "04. FAQ.md", - "chapter": [ - "### FAQ", - "#### ", - "#### Steps to install OpenSSL on windows:" - ] - } - ] - }, - { - "path": "docs/02. Technical Integration/02. Identity Provider Management", - "name": "02. Identity Provider Management", - "children": [ - { - "path": "docs/02. Technical Integration/02. Identity Provider Management/01. Summary.md", - "name": "01. Summary.md", - "chapter": ["# Summary"] - }, - { - "path": "docs/02. Technical Integration/02. Identity Provider Management/02. Configure Company IdP.md", - "name": "02. Configure Company IdP.md", - "chapter": [ - "# User Description", - "### Register your company IdP", - "#### Create the new idp record" - ] - }, - { - "path": "docs/02. Technical Integration/02. Identity Provider Management/03. User Migration.md", - "name": "03. User Migration.md", - "chapter": [ - "#### Migrate existing user accounts to the new created IdP" - ] - }, - { - "path": "docs/02. Technical Integration/02. Identity Provider Management/04. FAQ.md", - "name": "04. FAQ.md", - "chapter": [ - "### FAQ", - "#### ?" - ] - } - ] - }, - { - "path": "docs/04. App(s)/06. App Change Process", - "name": "06. App Change Process", - "children": [ - { - "path": "docs/04. App(s)/06. App Change Process/01. Summary.md", - "name": "01. Summary.md", - "chapter": ["## Summary", "## Function"] - }, - { - "path": "docs/04. App(s)/06. App Change Process/02. App Deactivation.md", - "name": "02. App Deactivation.md", - "chapter": ["## Summary"] - } - ] - }, - { - "path": "docs/04. App(s)/07. App Provider Management", - "name": "07. App Provider Management", - "children": [ - { - "path": "docs/04. App(s)/07. App Provider Management/01. Open API.md", - "name": "01. Open API.md", - "chapter": [ - "## Open API - Offer Autosetup", - "## Interface / API / Service Summary", - "## Architecture Overview", - "## Implementation", - "### #1 PUT Service URL", - "### #2 POST Service Request", - "### #3 POST Service Instance" - ] - } - ] - }, - { - "path": "docs/04. App(s)/index.md", - "name": "index.md", - "chapter": ["# Summary", "### App Marketplace in Catena-X"] - } - ] - }, - { - "path": "docs/05. Service(s)", - "name": "05. Service(s)", - "children": [ - { - "path": "docs/05. Service(s)/01. Service Marketplace", - "name": "01. Service Marketplace", - "children": [ - { - "path": "docs/05. Service(s)/01. Service Marketplace/01. Service Marketplace.md", - "name": "01. Service Marketplace.md", - "chapter": [ - "## Summary", - "## Functionality", - "### Service Marketplace Overview" - ] - }, - { - "path": "docs/05. Service(s)/01. Service Marketplace/02. Service Details.md", - "name": "02. Service Details.md", - "chapter": ["## Service Offer Details"] - }, - { - "path": "docs/05. Service(s)/01. Service Marketplace/03. FAQ.md", - "name": "03. FAQ.md", - "chapter": ["### FAQ"] - } - ] - }, - { - "path": "docs/05. Service(s)/02. Service Release Process", - "name": "02. Service Release Process", - "children": [ - { - "path": "docs/05. Service(s)/02. Service Release Process/01. Release Flow.md", - "name": "01. Release Flow.md", - "chapter": [ - "## Service Release Process", - "#### Trigger the Publishing Process", - "#### Step 1 - Service Card Details", - "###### Sales Manager", - "#### Step 2 - Offer Page Details", - "#### Step 3 - Terms & Conditions / Consent", - "#### Step 4 - Validate & Submit for Publishing check" - ] - }, - { - "path": "docs/05. Service(s)/02. Service Release Process/02. FAQ.md", - "name": "02. FAQ.md", - "chapter": [ - "### FAQ", - "### How can I submit a new service offer for marketplace publishing?" - ] - } - ] - }, - { - "path": "docs/05. Service(s)/03. Service Subscription", - "name": "03. Service Subscription", - "children": [ - { - "path": "docs/05. Service(s)/03. Service Subscription/01. Service Subscription.md", - "name": "01. Service Subscription.md", - "chapter": ["## Summary", "## Connected Documentation"] - }, - { - "path": "docs/05. Service(s)/03. Service Subscription/02. FAQ.md", - "name": "02. FAQ.md", - "chapter": [ - "### FAQ", - "#### Can I trigger a second service subscription request?", - "#### I dont have subscription rights - how can I receive the necessary rights?", - "#### I triggered a service request what do I need to do now?" - ] - } - ] - }, - { - "path": "docs/05. Service(s)/index.md", - "name": "index.md", - "chapter": ["## Service Marketplace in Catena-X"] - } - ] - }, - { - "path": "docs/Style-Guide", - "name": "Style-Guide", - "children": [ - { - "path": "docs/Style-Guide/Static_Page_Template.md", - "name": "Static_Page_Template.md", - "chapter": [ - "## Static Page Template(s)", - "### Templates", - "#### Common Notes", - "#### #1 TextCenterAlignedWithCardGrid", - "#### #2 TextCenterAlignedWithLinkButtonGrid ", - "#### #3 TextImageSideBySideWithCardGrid ", - "#### #4 TextVideoSideBySide ", - "#### #5 Video-Text-Side-By-Side ", - "#### #6 Text-Image-Center-Aligned", - "#### #7 Text-Center-Aligned", - "#### #8 Text-Image-Side-By-Side", - "### Implementation ", - "#### New Page creation", - "#### Enhancing an existing page" - ] - } - ] - } - ] -} diff --git a/public/documentation/data/main/developer.json b/public/documentation/data/main/developer.json index efcdcec1e..167059d61 100644 --- a/public/documentation/data/main/developer.json +++ b/public/documentation/data/main/developer.json @@ -13,17 +13,21 @@ { "path": "developer/01. Onboarding/01. Invite/01. Summary.md", "name": "01. Summary.md", - "chapter": ["## Summary"] + "chapter": ["## Summary", "## NOTICE"] }, { "path": "developer/01. Onboarding/01. Invite/02. Overview Invited Companies.md", "name": "02. Overview Invited Companies.md", - "chapter": ["## Get Invited Companies", "#### API Details"] + "chapter": [ + "## Get Invited Companies", + "#### API Details", + "## NOTICE" + ] }, { - "path": "developer/01. Onboarding/01. Invite/03. Invite Company : Create Application.md", - "name": "03. Invite Company : Create Application.md", - "chapter": ["## Invite Company", "#### API Details"] + "path": "developer/01. Onboarding/01. Invite/03. Invite Company_Create Application.md", + "name": "03. Invite Company_Create Application.md", + "chapter": ["## Invite Company", "#### API Details", "## NOTICE"] } ] }, @@ -38,7 +42,8 @@ "# Intro", "#### Registration Login", "### Registration Login Details", - "## Portal Login" + "## Portal Login", + "## NOTICE" ] }, { @@ -60,7 +65,8 @@ "###### Implemented Pattern", "###### POST allowed Unique Identifier", "### Store/Save Company Data", - "### Display Company Data (pre-saved)" + "### Display Company Data (pre-saved)", + "## NOTICE" ] }, { @@ -69,7 +75,8 @@ "chapter": [ "# Implementation", "## Add Aditional Users", - "#### API Details" + "#### API Details", + "## NOTICE" ] }, { @@ -80,7 +87,8 @@ "## Select company role & sign terms and conditions", "#### API Details", "#1 Roles and agreements are fetched from the consent endpoint", - "#2 Consent Post" + "#2 Consent Post", + "## NOTICE" ] }, { @@ -93,17 +101,19 @@ "##### #1 API Get Documents", "##### #2 API Upload Document", "##### #3 API Delete Document", - "##### #4 API Download Document" + "##### #4 API Download Document", + "## NOTICE" ] }, { "path": "developer/01. Onboarding/02. Registration/06. Verify Registration Data.md", "name": "06. Verify Registration Data.md", "chapter": [ - "# Implementation", - "## Verify your data", - "##### #1 Get application data", - "##### #2 Submit Registration" + "## Verify Registration Data data", + "#### #1 Get application data", + "#### #2 Submit Registration", + "###### Validations", + "## NOTICE" ] }, { @@ -117,7 +127,8 @@ "### 3 Invite Users", "### 4 Company Role and Terms&Conditions", "### 5 Document Load", - "### 6 Verify Data" + "### 6 Verify Data", + "## NOTICE" ] } ] @@ -142,7 +153,8 @@ "#### API Details Get Company Checklist Status", "## 3 Download Documents", "#### Logical flow of the service", - "#### API Details" + "#### API Details", + "## NOTICE" ] }, { @@ -168,13 +180,15 @@ "#### Details \"Clearinghouse Check\"", "###### Step 1 - Send company data to clearinghouse", "###### Step 2 - Clearinghouse response", - "##### Details \"Self-Description Creation LegalPerson\"", + "##### Details \"Self-Description Creation LegalParticipant\"", "###### Step 1 - Create SelfDescription - send company data to SD Factory", "###### Step 2 - Save self description document", "###### DB Table Content", "##### Details \"Activation\"", "### Add/Update BPN for the registration company", - "### Status endpoint - Checklist Details" + "### Status endpoint - Checklist Details", + "### Details for retrigger process", + "## NOTICE" ] }, { @@ -182,7 +196,8 @@ "name": "04. Decline Application.md", "chapter": [ "## Decline Company Application", - "##### API Implementation" + "##### API Implementation", + "## NOTICE" ] }, { @@ -191,7 +206,8 @@ "chapter": [ "## Summary", "## Functional Details", - "### Display Application Details" + "### Display Application Details", + "## NOTICE" ] } ] @@ -209,7 +225,7 @@ { "path": "developer/02. Technical Integration/01. Connector Registration/01. Summary.md", "name": "01. Summary.md", - "chapter": ["# Summary"] + "chapter": ["# Summary", "## NOTICE"] }, { "path": "developer/02. Technical Integration/01. Connector Registration/02. View Connector.md", @@ -226,7 +242,8 @@ "#### API Details", "### 2 Get all \"my\" Connector Registrations hosted for customers/3rd parties", "#### Logical flow of the service", - "#### API Details" + "#### API Details", + "## NOTICE" ] }, { @@ -234,23 +251,17 @@ "name": "03. Create new Connector Registration.md", "chapter": [ "## 1. Create new Connector Registration - self-owned", - "#### Details to the DAPS", - "##### API Details", "#### Details to the SD", "##### #1 Self description request", - "##### #2 Self description response (asynchron)", + "##### #2 Self description response (asynchronous)", "#### Logical flow of the service", "#### API Details", - "## 2. Create new Connector Registration - managedĀ ", + "## 2. Create new Connector Registration - managed", "#### Logical flow of the service", - "#### API Details" + "#### API Details", + "## NOTICE" ] }, - { - "path": "developer/02. Technical Integration/01. Connector Registration/04. DAPS Registration.md", - "name": "04. DAPS Registration.md", - "chapter": ["## 4 Retrigger DAPS", "#### API Details"] - }, { "path": "developer/02. Technical Integration/01. Connector Registration/05. Self Description.md", "name": "05. Self Description.md", @@ -258,13 +269,18 @@ "## Self Description", "### Implementation Details", "#### Send Company Data to SD Factory (Create SD)", - "#### SD CallBack Service" + "#### SD CallBack Service", + "## NOTICE" ] }, { "path": "developer/02. Technical Integration/01. Connector Registration/06. Delete Connector.md", "name": "06. Delete Connector.md", - "chapter": ["## 5 Delete Connector", "#### API Details"] + "chapter": [ + "## 5 Delete Connector", + "#### API Details", + "## NOTICE" + ] }, { "path": "developer/02. Technical Integration/01. Connector Registration/07. Error Handling.md", @@ -274,7 +290,8 @@ "### View Connector Table", "#### #1 Scenario: No Data available", "#### #2 Scenario: Endpoints are responding with an 500 error", - "#### #3 Scenario: Endpoints are responding with an 4xx error" + "#### #3 Scenario: Endpoints are responding with an 4xx error", + "## NOTICE" ] } ] @@ -286,22 +303,52 @@ { "path": "developer/02. Technical Integration/02. Identity Provider Management/01. Summary.md", "name": "01. Summary.md", - "chapter": ["# Summary"] + "chapter": ["# Summary", "## NOTICE"] + }, + { + "path": "developer/02. Technical Integration/02. Identity Provider Management/02. Company IdPs.md", + "name": "02. Company IdPs.md", + "chapter": [ + "## Identity Provider Overview", + "### Implementation", + "### API GET IdPs", + "## NOTICE" + ] }, { "path": "developer/02. Technical Integration/02. Identity Provider Management/02. Configure Company IdP.md", "name": "02. Configure Company IdP.md", "chapter": [ - "# User Description", - "### Register your company IdP", - "#### Create the new idp record" + "## IDP Configuration", + "### Create IdP", + "#### Implementation details:", + "#### API Create new IdP connection", + "### Configure IdP", + "#### Implementation details:", + "#### API Update IdP Config", + "### User Connection", + "## NOTICE" ] }, { "path": "developer/02. Technical Integration/02. Identity Provider Management/03. User Migration.md", "name": "03. User Migration.md", "chapter": [ - "#### Migrate existing user accounts to the new created IdP" + "### Migrate existing user accounts to the new created IdP", + "### Implementation Details", + "#### GET User List", + "#### POST User IdP Link", + "## NOTICE" + ] + }, + { + "path": "developer/02. Technical Integration/02. Identity Provider Management/04. Delete Identity Provider.md", + "name": "04. Delete Identity Provider.md", + "chapter": [ + "### Identity Provider Deletion", + "#### Implementation details:", + "#### API DELETE IdPs", + "## NOTICE" ] }, { @@ -311,7 +358,18 @@ "### FAQ", "#### ", - "#### Steps to install OpenSSL on windows:" - ] - } - ] - }, - { - "path": "docs/02. Technical Integration/02. Identity Provider Management", - "name": "02. Identity Provider Management", - "children": [ - { - "path": "docs/02. Technical Integration/02. Identity Provider Management/01. Summary.md", - "name": "01. Summary.md", - "chapter": ["# Summary"] - }, - { - "path": "docs/02. Technical Integration/02. Identity Provider Management/02. Configure Company IdP.md", - "name": "02. Configure Company IdP.md", - "chapter": [ - "# User Description", - "### Register your company IdP", - "#### Create the new idp record" - ] - }, - { - "path": "docs/02. Technical Integration/02. Identity Provider Management/03. User Migration.md", - "name": "03. User Migration.md", - "chapter": [ - "#### Migrate existing user accounts to the new created IdP" - ] - }, - { - "path": "docs/02. Technical Integration/02. Identity Provider Management/04. FAQ.md", - "name": "04. FAQ.md", - "chapter": [ - "### FAQ", - "#### ?" - ] - } - ] - }, - { - "path": "docs/04. App(s)/06. App Change Process", - "name": "06. App Change Process", - "children": [ - { - "path": "docs/04. App(s)/06. App Change Process/01. Summary.md", - "name": "01. Summary.md", - "chapter": ["## Summary", "## Function"] - }, - { - "path": "docs/04. App(s)/06. App Change Process/02. App Deactivation.md", - "name": "02. App Deactivation.md", - "chapter": ["## Summary"] - } - ] - }, - { - "path": "docs/04. App(s)/07. App Provider Management", - "name": "07. App Provider Management", - "children": [ - { - "path": "docs/04. App(s)/07. App Provider Management/01. Open API.md", - "name": "01. Open API.md", - "chapter": [ - "## Open API - Offer Autosetup", - "## Interface / API / Service Summary", - "## Architecture Overview", - "## Implementation", - "### #1 PUT Service URL", - "### #2 POST Service Request", - "### #3 POST Service Instance" - ] - } - ] - }, - { - "path": "docs/04. App(s)/index.md", - "name": "index.md", - "chapter": ["# Summary", "### App Marketplace in Catena-X"] - } - ] - }, - { - "path": "docs/05. Service(s)", - "name": "05. Service(s)", - "children": [ - { - "path": "docs/05. Service(s)/01. Service Marketplace", - "name": "01. Service Marketplace", - "children": [ - { - "path": "docs/05. Service(s)/01. Service Marketplace/01. Service Marketplace.md", - "name": "01. Service Marketplace.md", - "chapter": [ - "## Summary", - "## Functionality", - "### Service Marketplace Overview" - ] - }, - { - "path": "docs/05. Service(s)/01. Service Marketplace/02. Service Details.md", - "name": "02. Service Details.md", - "chapter": ["## Service Offer Details"] - }, - { - "path": "docs/05. Service(s)/01. Service Marketplace/03. FAQ.md", - "name": "03. FAQ.md", - "chapter": ["### FAQ"] - } - ] - }, - { - "path": "docs/05. Service(s)/02. Service Release Process", - "name": "02. Service Release Process", - "children": [ - { - "path": "docs/05. Service(s)/02. Service Release Process/01. Release Flow.md", - "name": "01. Release Flow.md", - "chapter": [ - "## Service Release Process", - "#### Trigger the Publishing Process", - "#### Step 1 - Service Card Details", - "#### Step 2 - Service Page Details", - "#### Step 3 - Terms & Conditions / Consent", - "#### Step 4 - Validate & Submit for Publishing check" - ] - }, - { - "path": "docs/05. Service(s)/02. Service Release Process/02. FAQ.md", - "name": "02. FAQ.md", - "chapter": [ - "### FAQ", - "### How can I submit a new service offer for marketplace publishing?" - ] - } - ] - }, - { - "path": "docs/05. Service(s)/03. Service Release Approval", - "name": "03. Service Release Approval", - "children": [ - { - "path": "docs/05. Service(s)/03. Service Release Approval/01. Service Approval Board.md", - "name": "01. Service Approval Board.md", - "chapter": ["## Summary", "### Page Design "] - }, - { - "path": "docs/05. Service(s)/03. Service Release Approval/02. Service Details.md", - "name": "02. Service Details.md", - "chapter": ["## Service Details"] - }, - { - "path": "docs/05. Service(s)/03. Service Release Approval/03. Approve Service Release.md", - "name": "03. Approve Service Release.md", - "chapter": ["## Approve Service Release"] - }, - { - "path": "docs/05. Service(s)/03. Service Release Approval/04. Decline Service Release.md", - "name": "04. Decline Service Release.md", - "chapter": ["## Decline Service Release"] - } - ] - }, - { - "path": "docs/05. Service(s)/03. Service Subscription", - "name": "03. Service Subscription", - "children": [ - { - "path": "docs/05. Service(s)/03. Service Subscription/01. Service Subscription.md", - "name": "01. Service Subscription.md", - "chapter": ["## Summary", "## Connected Documentation"] - }, - { - "path": "docs/05. Service(s)/03. Service Subscription/02. FAQ.md", - "name": "02. FAQ.md", - "chapter": [ - "### FAQ", - "#### Can I trigger a second service subscription request?", - "#### I dont have subscription rights - how can I receive the necessary rights?", - "#### I triggered a service request what do I need to do now?" - ] - } - ] - }, - { - "path": "docs/05. Service(s)/index.md", - "name": "index.md", - "chapter": ["## Service Marketplace in Catena-X"] - } - ] - }, - { - "path": "docs/Style-Guide", - "name": "Style-Guide", - "children": [ - { - "path": "docs/Style-Guide/Static_Page_Template.md", - "name": "Static_Page_Template.md", - "chapter": [ - "## Static Page Template(s)", - "### Templates", - "#### Common Notes", - "#### #1 TextCenterAlignedWithCardGrid", - "#### #2 TextCenterAlignedWithLinkButtonGrid ", - "#### #3 TextImageSideBySideWithCardGrid ", - "#### #4 TextVideoSideBySide ", - "#### #5 Video-Text-Side-By-Side ", - "#### #6 Text-Image-Center-Aligned", - "#### #7 Text-Center-Aligned", - "#### #8 Text-Image-Side-By-Side", - "### Implementation ", - "#### New Page creation", - "#### Enhancing an existing page" - ] - } - ] - } - ] -} diff --git a/public/documentation/data/main/user.json b/public/documentation/data/main/user.json new file mode 100644 index 000000000..706bbfaee --- /dev/null +++ b/public/documentation/data/main/user.json @@ -0,0 +1,1312 @@ +{ + "path": "user", + "name": "Catena-X Help Desk", + "children": [ + { + "path": "user/01. Onboarding", + "name": "01. Onboarding", + "children": [ + { + "path": "user/01. Onboarding/01. Registration Invite", + "name": "01. Registration Invite", + "children": [ + { + "path": "user/01. Onboarding/01. Registration Invite/01. Summary.md", + "name": "01. Summary.md", + "chapter": [ + "## Summary", + "#### Operator Invite Flow", + "## NOTICE" + ] + }, + { + "path": "user/01. Onboarding/01. Registration Invite/02. FAQ.md", + "name": "02. FAQ.md", + "chapter": [ + "# FAQ", + "## How can I invite a potential new Catena-X member?", + "## Can I identify already invited members?", + "## NOTICE" + ] + }, + { + "path": "user/01. Onboarding/01. Registration Invite/index.md", + "name": "index.md", + "chapter": ["## Registration Invite", "## NOTICE"] + } + ] + }, + { + "path": "user/01. Onboarding/02. Registration", + "name": "02. Registration", + "children": [ + { + "path": "user/01. Onboarding/02. Registration/01. Login.md", + "name": "01. Login.md", + "chapter": [ + "## Login Details", + "### Registration Login", + "### Portal Login", + "## NOTICE" + ] + }, + { + "path": "user/01. Onboarding/02. Registration/02. Add Company Data.md", + "name": "02. Add Company Data.md", + "chapter": ["## Add Company Data", "## NOTICE"] + }, + { + "path": "user/01. Onboarding/02. Registration/03. Add Additional User(s).md", + "name": "03. Add Additional User(s).md", + "chapter": [ + "#### Invite additional users", + "#optional step#", + "## NOTICE" + ] + }, + { + "path": "user/01. Onboarding/02. Registration/04. Company Role & Consent.md", + "name": "04. Company Role & Consent.md", + "chapter": [ + "#### Company Role & Terms and Conditions", + "## NOTICE" + ] + }, + { + "path": "user/01. Onboarding/02. Registration/05. Document Upload.md", + "name": "05. Document Upload.md", + "chapter": ["#### Document upload", "## NOTICE"] + }, + { + "path": "user/01. Onboarding/02. Registration/06. Verify Registration Data.md", + "name": "06. Verify Registration Data.md", + "chapter": ["## Submit company data", "## NOTICE"] + }, + { + "path": "user/01. Onboarding/02. Registration/07. FAQ.md", + "name": "07. FAQ.md", + "chapter": [ + "# FAQ", + "## For what are the registration data used for?", + "## What will happen after the registration?", + "## Do I need to do the registration in one flow or can i pause in between?", + "## What can I do, if I dont have all necessary information available, which are needed to register my company?", + "## Why do I always receive a message / warning screen when logging in to the registration form of my company.", + "## NOTICE" + ] + }, + { + "path": "user/01. Onboarding/02. Registration/index.md", + "name": "index.md", + "chapter": ["## Registration", "## NOTICE"] + } + ] + }, + { + "path": "user/01. Onboarding/03. Registration Approval", + "name": "03. Registration Approval", + "children": [ + { + "path": "user/01. Onboarding/03. Registration Approval/02. View Company Application(s).md", + "name": "02. View Company Application(s).md", + "chapter": [ + "## View Company Application (with Details)", + "### Display Application Details", + "## NOTICE" + ] + }, + { + "path": "user/01. Onboarding/03. Registration Approval/03. Registration Approval Process.md", + "name": "03. Registration Approval Process.md", + "chapter": [ + "## Registration Approval Flow", + "### Checklist Stepper", + "##### Details \"Manual Validation\"", + "###### Scenario: Approve", + "###### Scenario: Decline", + "##### Details \"Create Business Partner Number (if necessary)\"", + "###### Scenario 1 - Registration with BPN", + "###### Scenario 2 - Registration without BPN", + "###### Scenario 3 - manually add BPN as operator (interim supported workflow)", + "##### Details \"Create Managed Identity Wallet\"", + "##### Details \"Clearinghouse Check\"", + "###### Step 1 - manually add BPN as operator (interim supported workflow)", + "###### Step 2 - Clearinghouse response", + "##### Details \"Self-Description Creation LegalPerson\"", + "###### DB Table Content", + "##### Details \"Activation\"", + "### Add/Update BPN for the registration company", + "## NOTICE" + ] + }, + { + "path": "user/01. Onboarding/03. Registration Approval/04. Decline Application.md", + "name": "04. Decline Application.md", + "chapter": ["## Decline Company Application", "## NOTICE"] + }, + { + "path": "user/01. Onboarding/03. Registration Approval/05. FAQ.md", + "name": "05. FAQ.md", + "chapter": [ + "## FAQ", + "### What happens if I decline an application?", + "### Can I as a registration company view my registration status?", + "## NOTICE" + ] + }, + { + "path": "user/01. Onboarding/03. Registration Approval/index.md", + "name": "index.md", + "chapter": ["## Summary", "## NOTICE"] + } + ] + }, + { + "path": "user/01. Onboarding/index.md", + "name": "index.md", + "chapter": ["## Onboarding", "## NOTICE"] + } + ] + }, + { + "path": "user/02. Technical Integration", + "name": "02. Technical Integration", + "children": [ + { + "path": "user/02. Technical Integration/01. Connector Registration", + "name": "01. Connector Registration", + "children": [ + { + "path": "user/02. Technical Integration/01. Connector Registration/00. Summary.md", + "name": "00. Summary.md", + "chapter": ["## Summary", "## NOTICE"] + }, + { + "path": "user/02. Technical Integration/01. Connector Registration/01. Connector Overview.md", + "name": "01. Connector Overview.md", + "chapter": [ + "## Connector Overview", + "#### SelfDescription Status", + "#### Connector Status", + "#### Connector Providers", + "## NOTICE" + ] + }, + { + "path": "user/02. Technical Integration/01. Connector Registration/02. Connector Registration.md", + "name": "02. Connector Registration.md", + "chapter": [ + "## Connector Registration", + "### Create new Connector Registration - self-owned", + "### Create new Connector Registration - managedĀ ", + "## NOTICE" + ] + }, + { + "path": "user/02. Technical Integration/01. Connector Registration/04. SelfDescription Retrigger.md", + "name": "04. SelfDescription Retrigger.md", + "chapter": ["#### Self Description Retrigger", "## NOTICE"] + }, + { + "path": "user/02. Technical Integration/01. Connector Registration/05. Delete Connector.md", + "name": "05. Delete Connector.md", + "chapter": ["## 5 Delete Connector", "## NOTICE"] + }, + { + "path": "user/02. Technical Integration/01. Connector Registration/06. OpenAPI.md", + "name": "06. OpenAPI.md", + "chapter": [ + "## Open API - Create new Connector Registration - managed", + "##### API Details", + "##### Request Body", + "###### Subscription Id", + "###### TechnicalUserId", + "## NOTICE" + ] + }, + { + "path": "user/02. Technical Integration/01. Connector Registration/07. FAQ.md", + "name": "07. FAQ.md", + "chapter": [ + "## FAQ", + "### How to register a connector inside the network?", + "### Whats the difference of a OWNED and a MANAGED connector?", + "### How can a connector get deleted?", + "### Why is my connector \"PENDING\"?", + "## NOTICE" + ] + }, + { + "path": "user/02. Technical Integration/01. Connector Registration/08. Policy Management.md", + "name": "08. Policy Management.md", + "chapter": [ + "## Policy Management", + "### Overview", + "### Setup Access & Usage Policies", + "#### Example: \"Public Policy\"", + "#### Example: \"Membership Policy\"", + "#### Example: Combined Policy for \"Membership Policy\" & \"BPN Policy\"", + "#### Example: Combined Policy for \"Membership Policy\" & Usage: \"Traceability Credential\"", + "### Further Specific Examples", + "#### Scenario 1", + "##### Partner 1 - Access Policy Example", + "##### Desired Outcome", + "#### Scenario 2", + "##### Partner 1 - Access Policy Example", + "##### Partner 1 - Usage/Contract Policy Example", + "##### Desired Outcome", + "#### Scenario 3", + "##### Partner 1 - Access Policy Example", + "##### Desired Outcome", + "#### Scenario 4", + "##### Partner 1 - Access Policy Example", + "##### Partner 1 - Usage/Contract Policy Example", + "##### Desired Outcome", + "## NOTICE" + ] + }, + { + "path": "user/02. Technical Integration/01. Connector Registration/index.md", + "name": "index.md", + "chapter": ["## Connector Management", "## NOTICE"] + } + ] + }, + { + "path": "user/02. Technical Integration/02. Identity Provider Management", + "name": "02. Identity Provider Management", + "children": [ + { + "path": "user/02. Technical Integration/02. Identity Provider Management/01. Summary.md", + "name": "01. Summary.md", + "chapter": ["# Summary", "## NOTICE"] + }, + { + "path": "user/02. Technical Integration/02. Identity Provider Management/02. Company IdPs.md", + "name": "02. Company IdPs.md", + "chapter": ["## Identity Provider Overview", "## NOTICE"] + }, + { + "path": "user/02. Technical Integration/02. Identity Provider Management/02. Configure Company IdP.md", + "name": "02. Configure Company IdP.md", + "chapter": [ + "# User Description", + "### Register your company IdP", + "#### Create the new idp record", + "## NOTICE" + ] + }, + { + "path": "user/02. Technical Integration/02. Identity Provider Management/03. User Migration.md", + "name": "03. User Migration.md", + "chapter": [ + "#### Migrate existing user accounts to the new created IdP", + "## NOTICE" + ] + }, + { + "path": "user/02. Technical Integration/02. Identity Provider Management/04. Identity Provider Deletion.md", + "name": "04. Identity Provider Deletion.md", + "chapter": ["### Identity Provider Deletion", "## NOTICE"] + }, + { + "path": "user/02. Technical Integration/02. Identity Provider Management/05. Disable Identity Provider.md", + "name": "05. Disable Identity Provider.md", + "chapter": ["### Identity Provider Disable", "## NOTICE"] + }, + { + "path": "user/02. Technical Integration/02. Identity Provider Management/06. FAQ.md", + "name": "06. FAQ.md", + "chapter": [ + "### FAQ", + "#### What do the different IDP types stand for", + "#### Can I have multiple active IdPs?", + "#### Is SAML supported?", + "#### If I connect my company IdP with the platform IdP - which data will get logged by the platform IdP?", + "## NOTICE" + ] + }, + { + "path": "user/02. Technical Integration/02. Identity Provider Management/index.md", + "name": "index.md", + "chapter": ["## Identity Provider Management", "## NOTICE"] + } + ] + }, + { + "path": "user/02. Technical Integration/03. CX Membership", + "name": "03. CX Membership", + "children": [ + { + "path": "user/02. Technical Integration/03. CX Membership/01. Open API.md", + "name": "01. Open API.md", + "chapter": [ + "## Open API - CX-Membership", + "### Architecture Overview", + "### #1 application programming interface (API)", + "###### Request Body", + "###### Response Body", + "## NOTICE" + ] + }, + { + "path": "user/02. Technical Integration/03. CX Membership/index.md", + "name": "index.md", + "chapter": ["## CX Membership", "## NOTICE"] + } + ] + }, + { + "path": "user/02. Technical Integration/04. Dataspace Discovery", + "name": "04. Dataspace Discovery", + "children": [ + { + "path": "user/02. Technical Integration/04. Dataspace Discovery/01. Open API.md", + "name": "01. Open API.md", + "chapter": [ + "## Open API - Connector Discovery", + "## Interface/API/Service Summary", + "### Architecture Overview", + "### EDC Discovery - application programming interface (API)", + "###### Request Body", + "###### Response Body", + "## NOTICE" + ] + }, + { + "path": "user/02. Technical Integration/04. Dataspace Discovery/index.md", + "name": "index.md", + "chapter": ["## Dataspace Discovery", "## NOTICE"] + } + ] + }, + { + "path": "user/02. Technical Integration/05. Company Role", + "name": "05. Company Role", + "children": [ + { + "path": "user/02. Technical Integration/05. Company Role/Change Company Role.md", + "name": "Change Company Role.md", + "chapter": ["## Company Role Change", "## NOTICE"] + }, + { + "path": "user/02. Technical Integration/05. Company Role/index.md", + "name": "index.md", + "chapter": ["## Company Participation Role", "## NOTICE"] + } + ] + }, + { + "path": "user/02. Technical Integration/index.md", + "name": "index.md", + "chapter": ["# Technical Integration", "## NOTICE"] + } + ] + }, + { + "path": "user/03. User Management", + "name": "03. User Management", + "children": [ + { + "path": "user/03. User Management/01. User Account", + "name": "01. User Account", + "children": [ + { + "path": "user/03. User Management/01. User Account/01. Summary.md", + "name": "01. Summary.md", + "chapter": ["# Summary", "## NOTICE"] + }, + { + "path": "user/03. User Management/01. User Account/02. User Account.md", + "name": "02. User Account.md", + "chapter": ["## View company user accounts", "## NOTICE"] + }, + { + "path": "user/03. User Management/01. User Account/03. Create new user account (single).md", + "name": "03. Create new user account (single).md", + "chapter": [ + "## Create a new user account (single)", + "### Role Description/Details", + "## NOTICE" + ] + }, + { + "path": "user/03. User Management/01. User Account/04. Create new user account (bulk).md", + "name": "04. Create new user account (bulk).md", + "chapter": [ + "## Create a new user account (bulk)", + "#### Preparation", + "##### Mapping", + "#### Upload", + "##### Validation and Error Handling:", + "#### Feedback", + "## NOTICE" + ] + }, + { + "path": "user/03. User Management/01. User Account/05. FAQ.md", + "name": "05. FAQ.md", + "chapter": [ + "# FAQ", + "#### Can I delete an user of another company?", + "#### How can I delete an user account which is company IdP federated?", + "#### Can I revert a user deletion?", + "#### If my/a user has 2 idp connections, will the user deletion delete both idp connections?", + "## NOTICE" + ] + }, + { + "path": "user/03. User Management/01. User Account/index.md", + "name": "index.md", + "chapter": ["# User Account", "## NOTICE"] + } + ] + }, + { + "path": "user/03. User Management/02. Modify User Account", + "name": "02. Modify User Account", + "children": [ + { + "path": "user/03. User Management/02. Modify User Account/01. Summary.md", + "name": "01. Summary.md", + "chapter": [ + "# User Account Details", + "# My CX Account", + "## NOTICE" + ] + }, + { + "path": "user/03. User Management/02. Modify User Account/02. Password Reset.md", + "name": "02. Password Reset.md", + "chapter": [ + "## Password Reset", + "### Error message handling for password reset", + "### Password reset policy", + "## NOTICE" + ] + }, + { + "path": "user/03. User Management/02. Modify User Account/03. User Permissions.md", + "name": "03. User Permissions.md", + "chapter": [ + "## User Permissions", + "### Portal Assigned Roles", + "### App Assigned Roles", + "## NOTICE" + ] + }, + { + "path": "user/03. User Management/02. Modify User Account/04. Manage user assigned BPN.md", + "name": "04. Manage user assigned BPN.md", + "chapter": ["## Add BPN", "# Delete BPN", "## NOTICE"] + }, + { + "path": "user/03. User Management/02. Modify User Account/05. Suspend User.md", + "name": "05. Suspend User.md", + "chapter": ["# Suspend User", "## NOTICE"] + }, + { + "path": "user/03. User Management/02. Modify User Account/06. Delete User.md", + "name": "06. Delete User.md", + "chapter": [ + "## Delete User", + "### Own User Deletion Flow", + "### Company User Deletion Flow", + "## NOTICE" + ] + }, + { + "path": "user/03. User Management/02. Modify User Account/index.md", + "name": "index.md", + "chapter": ["# Summary", "## NOTICE"] + } + ] + }, + { + "path": "user/03. User Management/03. Technical User", + "name": "03. Technical User", + "children": [ + { + "path": "user/03. User Management/03. Technical User/01. Technical User Overview.md", + "name": "01. Technical User Overview.md", + "chapter": ["## Technical User Overview", "## NOTICE"] + }, + { + "path": "user/03. User Management/03. Technical User/02. Create Technical User.md", + "name": "02. Create Technical User.md", + "chapter": [ + "## Introduction", + "#### Available technical user roles", + "## Create a new technical user", + "## Further information", + "## NOTICE" + ] + }, + { + "path": "user/03. User Management/03. Technical User/03. Delete Technical User.md", + "name": "03. Delete Technical User.md", + "chapter": ["## Delete an user", "## NOTICE"] + }, + { + "path": "user/03. User Management/03. Technical User/04. FAQ.md", + "name": "04. FAQ.md", + "chapter": [ + "### As a service or app provider, am I able to create a technical user in the name of my app/service customer?", + "### How to retrieve a technical user token?", + "## NOTICE" + ] + }, + { + "path": "user/03. User Management/03. Technical User/04. Reset Credentials.md", + "name": "04. Reset Credentials.md", + "chapter": [ + "## Introduction", + "### Reset Credential", + "## NOTICE" + ] + }, + { + "path": "user/03. User Management/03. Technical User/index.md", + "name": "index.md", + "chapter": [ + "# Summary", + "### Customer Functionalities covered in the function", + "## NOTICE" + ] + } + ] + }, + { + "path": "user/03. User Management/04. Assign App Roles", + "name": "04. Assign App Roles", + "children": [ + { + "path": "user/03. User Management/04. Assign App Roles/01. App Access Management Overview.md", + "name": "01. App Access Management Overview.md", + "chapter": ["## App Access Management Overview", "## NOTICE"] + }, + { + "path": "user/03. User Management/04. Assign App Roles/02. Assign User App Role(s).md", + "name": "02. Assign User App Role(s).md", + "chapter": ["## Assign User App Role", "## NOTICE"] + }, + { + "path": "user/03. User Management/04. Assign App Roles/03. Update Users Assigned App Role(s).md", + "name": "03. Update Users Assigned App Role(s).md", + "chapter": ["## Update User Assigned App Role", "## NOTICE"] + }, + { + "path": "user/03. User Management/04. Assign App Roles/04. FAQ.md", + "name": "04. FAQ.md", + "chapter": ["## NOTICE"] + }, + { + "path": "user/03. User Management/04. Assign App Roles/index.md", + "name": "index.md", + "chapter": ["# Summary", "## NOTICE"] + } + ] + }, + { + "path": "user/03. User Management/index.md", + "name": "index.md", + "chapter": ["# User Management", "## NOTICE"] + } + ] + }, + { + "path": "user/04. App(s)", + "name": "04. App(s)", + "children": [ + { + "path": "user/04. App(s)/01. Marketplace", + "name": "01. Marketplace", + "children": [ + { + "path": "user/04. App(s)/01. Marketplace/01. App Overview.md", + "name": "01. App Overview.md", + "chapter": ["## App Overview", "## NOTICE"] + }, + { + "path": "user/04. App(s)/01. Marketplace/02. App Details.md", + "name": "02. App Details.md", + "chapter": ["## App Details", "## NOTICE"] + }, + { + "path": "user/04. App(s)/01. Marketplace/03. App Favorites.md", + "name": "03. App Favorites.md", + "chapter": ["## App Favorites", "## NOTICE"] + }, + { + "path": "user/04. App(s)/01. Marketplace/04. My Business Apps.md", + "name": "04. My Business Apps.md", + "chapter": ["## My Business Applications", "## NOTICE"] + }, + { + "path": "user/04. App(s)/01. Marketplace/05. FAQ.md", + "name": "05. FAQ.md", + "chapter": [ + "### FAQ", + "#### How can I release my app on the app marketplace.", + "#### Is it possible to deactivate an app from the marketplace?", + "#### ", + "## NOTICE" + ] + } + ] + }, + { + "path": "user/04. App(s)/02. App Release Process", + "name": "02. App Release Process", + "children": [ + { + "path": "user/04. App(s)/02. App Release Process/01. App Card.md", + "name": "01. App Card.md", + "chapter": [ + "### Step 1 - App Card Details", + "###### App language", + "###### Use Case", + "###### Sales Manager", + "###### App Lead Picture Image", + "## NOTICE" + ] + }, + { + "path": "user/04. App(s)/02. App Release Process/02. App Detail Page.md", + "name": "02. App Detail Page.md", + "chapter": [ + "### Step 2 - App Page Details", + "###### App Details Images", + "###### App Documents", + "###### Privacy Policy", + "## NOTICE" + ] + }, + { + "path": "user/04. App(s)/02. App Release Process/03.Terms&Conditions.md", + "name": "03.Terms&Conditions.md", + "chapter": [ + "### Step 3 - Terms & Conditions / Consent", + "## NOTICE" + ] + }, + { + "path": "user/04. App(s)/02. App Release Process/04.Technical Integration.md", + "name": "04.Technical Integration.md", + "chapter": ["### Step 4 - Technical Integration", "## NOTICE"] + }, + { + "path": "user/04. App(s)/02. App Release Process/05.Verify & Submit.md", + "name": "05.Verify & Submit.md", + "chapter": [ + "### Step 6 - Validate & Submit for Publishing check", + "## NOTICE" + ] + }, + { + "path": "user/04. App(s)/02. App Release Process/App-Design_guidelines.md", + "name": "App-Design_guidelines.md", + "chapter": [ + "## App Design Guidelines", + "### The App Picture", + "### Support Information", + "#### App Picture Layout Template", + "#### App Color Guidelines", + "###### Do's", + "###### Dont's", + "#### App Picture Icon Template", + "#### In-App Design (Catena-X Apps)", + "##### App Typography", + "##### Language Support", + "## NOTICE" + ] + }, + { + "path": "user/04. App(s)/02. App Release Process/App-Release_guidelines.md", + "name": "App-Release_guidelines.md", + "chapter": [ + "# App Release Guidelines", + "## Summary", + "## Technical Guidelines", + "#### #1 Authentication", + "#### #2 User Error Handling", + "## Functional Guidelines", + "## NOTICE" + ] + }, + { + "path": "user/04. App(s)/02. App Release Process/index.md", + "name": "index.md", + "chapter": [ + "## Summary", + "### Trigger the Publishing Process", + "## NOTICE" + ] + } + ] + }, + { + "path": "user/04. App(s)/03. App Release Approval", + "name": "03. App Release Approval", + "children": [ + { + "path": "user/04. App(s)/03. App Release Approval/01. App Approval Board.md", + "name": "01. App Approval Board.md", + "chapter": ["## Summary", "### Page Design", "## NOTICE"] + }, + { + "path": "user/04. App(s)/03. App Release Approval/02. App Details.md", + "name": "02. App Details.md", + "chapter": ["## App details", "## NOTICE"] + }, + { + "path": "user/04. App(s)/03. App Release Approval/03. Approve App Release.md", + "name": "03. Approve App Release.md", + "chapter": ["## Approve App Release", "## NOTICE"] + }, + { + "path": "user/04. App(s)/03. App Release Approval/04. Decline App Release.md", + "name": "04. Decline App Release.md", + "chapter": ["## Decline App Release", "## NOTICE"] + } + ] + }, + { + "path": "user/04. App(s)/04. App Provider Management Board(s)", + "name": "04. App Provider Management Board(s)", + "children": [ + { + "path": "user/04. App(s)/04. App Provider Management Board(s)/01. App Board.md", + "name": "01. App Board.md", + "chapter": ["## App Board", "### Details", "## NOTICE"] + } + ] + }, + { + "path": "user/04. App(s)/05. App Subscription", + "name": "05. App Subscription", + "children": [ + { + "path": "user/04. App(s)/05. App Subscription/01. Subscription Request (Customer).md", + "name": "01. Subscription Request (Customer).md", + "chapter": ["# Summary", "## NOTICE"] + }, + { + "path": "user/04. App(s)/05. App Subscription/02. Overview Company Subscription (Customer).md", + "name": "02. Overview Company Subscription (Customer).md", + "chapter": ["# Summary", "## NOTICE"] + }, + { + "path": "user/04. App(s)/05. App Subscription/03. Subscription Overview (App Provider).md", + "name": "03. Subscription Overview (App Provider).md", + "chapter": [ + "## Summary", + "## Management Board", + "## Specific Subscription Details", + "## NOTICE" + ] + }, + { + "path": "user/04. App(s)/05. App Subscription/04. Subscription Activation (App Provider).md", + "name": "04. Subscription Activation (App Provider).md", + "chapter": ["## Subscription Activation", "## NOTICE"] + }, + { + "path": "user/04. App(s)/05. App Subscription/05. App Unsubscribe.md", + "name": "05. App Unsubscribe.md", + "chapter": ["## Unsubscribe", "## NOTICE"] + }, + { + "path": "user/04. App(s)/05. App Subscription/05. FAQ.md", + "name": "05. FAQ.md", + "chapter": [ + "### FAQ", + "#### I don't have subscription rights - how can I receive the necessary rights?", + "#### I triggered an app subscription request what do I need to do now?", + "#### Where can I see my company subscriptions?", + "#### ?", + "## NOTICE" + ] + } + ] + }, + { + "path": "user/04. App(s)/06. App Change Process", + "name": "06. App Change Process", + "children": [ + { + "path": "user/04. App(s)/06. App Change Process/01. Summary.md", + "name": "01. Summary.md", + "chapter": ["## Summary", "## Function", "## NOTICE"] + }, + { + "path": "user/04. App(s)/06. App Change Process/02. Change App Lead Image.md", + "name": "02. Change App Lead Image.md", + "chapter": ["## Summary", "## NOTICE"] + }, + { + "path": "user/04. App(s)/06. App Change Process/03. Change App Description.md", + "name": "03. Change App Description.md", + "chapter": ["## Summary", "## NOTICE"] + }, + { + "path": "user/04. App(s)/06. App Change Process/04. App Deactivation.md", + "name": "04. App Deactivation.md", + "chapter": ["## Summary", "## NOTICE"] + }, + { + "path": "user/04. App(s)/06. App Change Process/05. Change App Tenant URL.md", + "name": "05. Change App Tenant URL.md", + "chapter": ["## App Tenant URL Change", "## NOTICE"] + }, + { + "path": "user/04. App(s)/06. App Change Process/06. Change App RolesL.md", + "name": "06. Change App RolesL.md", + "chapter": [ + "## App Role Change", + "#### How to fill the template", + "## NOTICE" + ] + }, + { + "path": "user/04. App(s)/06. App Change Process/07. Document Change.md", + "name": "07. Document Change.md", + "chapter": [ + "### Document Change", + "#### Add Documents", + "#### Deleting" + ] + } + ] + }, + { + "path": "user/04. App(s)/07. App Provider Management", + "name": "07. App Provider Management", + "children": [ + { + "path": "user/04. App(s)/07. App Provider Management/01. Open API.md", + "name": "01. Open API.md", + "chapter": [ + "## Open API - Offer Autosetup", + "## Interface / API / Service Summary", + "## Architecture Overview", + "## Implementation", + "### #1 PUT Service URL", + "### #2 POST Service Request", + "### #3 POST Service Instance", + "## NOTICE" + ] + } + ] + }, + { + "path": "user/04. App(s)/index.md", + "name": "index.md", + "chapter": [ + "# Summary", + "### App Marketplace in Catena-X", + "## NOTICE" + ] + } + ] + }, + { + "path": "user/05. Service(s)", + "name": "05. Service(s)", + "children": [ + { + "path": "user/05. Service(s)/01. Service Marketplace", + "name": "01. Service Marketplace", + "children": [ + { + "path": "user/05. Service(s)/01. Service Marketplace/01. Service Marketplace.md", + "name": "01. Service Marketplace.md", + "chapter": [ + "## Summary", + "## Functionality", + "### Service Marketplace Overview", + "## NOTICE" + ] + }, + { + "path": "user/05. Service(s)/01. Service Marketplace/02. Service Details.md", + "name": "02. Service Details.md", + "chapter": ["## Service Offer Details", "## NOTICE"] + }, + { + "path": "user/05. Service(s)/01. Service Marketplace/03. FAQ.md", + "name": "03. FAQ.md", + "chapter": ["### FAQ", "## NOTICE"] + } + ] + }, + { + "path": "user/05. Service(s)/02. Service Release Process", + "name": "02. Service Release Process", + "children": [ + { + "path": "user/05. Service(s)/02. Service Release Process/01. Service Card.md", + "name": "01. Service Card.md", + "chapter": ["### Step 1 - Service Card Details", "## NOTICE"] + }, + { + "path": "user/05. Service(s)/02. Service Release Process/02. Service Detail Page.md", + "name": "02. Service Detail Page.md", + "chapter": [ + "### Step 2 - Service Page Details", + "#### Additional information to the requested service details", + "##### Long Description", + "##### Additional Documents/Information", + "##### Provider Details", + "## NOTICE" + ] + }, + { + "path": "user/05. Service(s)/02. Service Release Process/03.Terms&Conditions.md", + "name": "03.Terms&Conditions.md", + "chapter": [ + "### Step 3 - Terms & Conditions / Consent", + "## NOTICE" + ] + }, + { + "path": "user/05. Service(s)/02. Service Release Process/04.Technical Integration.md", + "name": "04.Technical Integration.md", + "chapter": ["### Step 4 - Technical Integration", "## NOTICE"] + }, + { + "path": "user/05. Service(s)/02. Service Release Process/05.Verify & Submit.md", + "name": "05.Verify & Submit.md", + "chapter": [ + "### Step 4 - Validate & Submit for Publishing check", + "## NOTICE" + ] + }, + { + "path": "user/05. Service(s)/02. Service Release Process/06. FAQ.md", + "name": "06. FAQ.md", + "chapter": [ + "### FAQ", + "### How can I submit a new service offer for marketplace publishing?", + "## NOTICE" + ] + }, + { + "path": "user/05. Service(s)/02. Service Release Process/index.md", + "name": "index.md", + "chapter": [ + "## Service Release Process", + "### Trigger the Publishing Process", + "## NOTICE" + ] + } + ] + }, + { + "path": "user/05. Service(s)/03. Service Release Approval", + "name": "03. Service Release Approval", + "children": [ + { + "path": "user/05. Service(s)/03. Service Release Approval/01. Service Approval Board.md", + "name": "01. Service Approval Board.md", + "chapter": ["## Summary", "### Page Design", "## NOTICE"] + }, + { + "path": "user/05. Service(s)/03. Service Release Approval/02. Service Details.md", + "name": "02. Service Details.md", + "chapter": ["## Service Details", "## NOTICE"] + }, + { + "path": "user/05. Service(s)/03. Service Release Approval/03. Approve Service Release.md", + "name": "03. Approve Service Release.md", + "chapter": ["## Approve Service Release", "## NOTICE"] + }, + { + "path": "user/05. Service(s)/03. Service Release Approval/04. Decline Service Release.md", + "name": "04. Decline Service Release.md", + "chapter": ["## Decline Service Release", "## NOTICE"] + } + ] + }, + { + "path": "user/05. Service(s)/03. Service Subscription", + "name": "03. Service Subscription", + "children": [ + { + "path": "user/05. Service(s)/03. Service Subscription/01. Service Subscription.md", + "name": "01. Service Subscription.md", + "chapter": ["## Summary", "## NOTICE"] + }, + { + "path": "user/05. Service(s)/03. Service Subscription/03. Subscription Overview (Provider).md", + "name": "03. Subscription Overview (Provider).md", + "chapter": [ + "## Summary", + "## Management Board", + "## Specific Subscription Details", + "## NOTICE" + ] + }, + { + "path": "user/05. Service(s)/03. Service Subscription/04. Service Subscription Activation (Provider).md", + "name": "04. Service Subscription Activation (Provider).md", + "chapter": [ + "## Subscription Activation", + "#### A) Services with technical user profile configured", + "#### B) Services without technical user profile configured", + "## NOTICE" + ] + }, + { + "path": "user/05. Service(s)/03. Service Subscription/04. Service Unsubscribe.md", + "name": "04. Service Unsubscribe.md", + "chapter": ["## NOTICE"] + }, + { + "path": "user/05. Service(s)/03. Service Subscription/05. FAQ.md", + "name": "05. FAQ.md", + "chapter": [ + "### FAQ", + "#### Can I trigger a second service subscription request?", + "#### I don't have subscription rights - how can I receive the necessary rights?", + "#### I triggered a service request what do I need to do now?", + "## NOTICE" + ] + } + ] + }, + { + "path": "user/05. Service(s)/05. Service Change Process", + "name": "05. Service Change Process", + "children": [ + { + "path": "user/05. Service(s)/05. Service Change Process/01. Summary.md", + "name": "01. Summary.md", + "chapter": ["## Summary", "## NOTICE"] + }, + { + "path": "user/05. Service(s)/05. Service Change Process/02. Service Deactivation.md", + "name": "02. Service Deactivation.md", + "chapter": ["## Summary", "## NOTICE"] + } + ] + }, + { + "path": "user/05. Service(s)/index.md", + "name": "index.md", + "chapter": ["## Service Marketplace in Catena-X", "## NOTICE"] + } + ] + }, + { + "path": "user/06. Certificates", + "name": "06. Certificates", + "children": [ + { + "path": "user/06. Certificates/01. UseCase Participation.md", + "name": "01. UseCase Participation.md", + "chapter": ["## UseCase Participation", "## NOTICE"] + }, + { + "path": "user/06. Certificates/02. Other Certificates.md", + "name": "02. Other Certificates.md", + "chapter": ["## Company Certificates", "## NOTICE"] + }, + { + "path": "user/06. Certificates/03. Credential Admin Board.md", + "name": "03. Credential Admin Board.md", + "chapter": [ + "## Credential Admin Board", + "#### Filter based on credential request status", + "#### Open the attached document", + "#### Approve Credential Request", + "#### Reject Credential Request", + "## NOTICE" + ] + }, + { + "path": "user/06. Certificates/03. FAQ.md", + "name": "03. FAQ.md", + "chapter": [ + "## FAQ", + "#### 1. Why can I not upload any certificate", + "#### 2. Who validates my VC request after submission", + "#### 3. For how long will the credential be valid.", + "## NOTICE" + ] + }, + { + "path": "user/06. Certificates/index.md", + "name": "index.md", + "chapter": ["## Summary", "## NOTICE"] + } + ] + }, + { + "path": "user/06. Notifications", + "name": "06. Notifications", + "children": [ + { + "path": "user/06. Notifications/01. Notifications", + "name": "01. Notifications", + "children": [ + { + "path": "user/06. Notifications/01. Notifications/01. Overview.md", + "name": "01. Overview.md", + "chapter": [ + "## Notifications", + "### Notification Element Details", + "## NOTICE" + ] + } + ] + } + ] + }, + { + "path": "user/09. Others", + "name": "09. Others", + "children": [ + { + "path": "user/09. Others/01. Login.md", + "name": "01. Login.md", + "chapter": [] + }, + { + "path": "user/09. Others/12. Offer Authentication Flow.md", + "name": "12. Offer Authentication Flow.md", + "chapter": [ + "## Connect Your App to the central Opertaor IdP (Keycloak)", + "### Overview", + "### Process", + "## Highlevel Process", + "## Background Information", + "### Client Concept", + "## Step by Step description", + "### #1 Register your app/service inside the CX marketplace", + "### #2 App Subscription and activation", + "### Connected Topics", + "## NOTICE" + ] + } + ] + }, + { + "path": "user/Style-Guide", + "name": "Style-Guide", + "children": [ + { + "path": "user/Style-Guide/Static_Page_Template.md", + "name": "Static_Page_Template.md", + "chapter": [ + "## Static Page Template(s)", + "### Templates", + "#### Common Notes", + "#### #1 TextCenterAlignedWithCardGrid", + "#### #2 TextCenterAlignedWithLinkButtonGrid", + "#### #3 TextImageSideBySideWithCardGrid", + "#### #4 TextVideoSideBySide", + "#### #5 Video-Text-Side-By-Side", + "#### #6 Text-Image-Center-Aligned", + "#### #7 Text-Center-Aligned", + "#### #8 Text-Image-Side-By-Side", + "#### #9 TextCenterAlignedBody2", + "#### #10 TextImageSideBySideWithLinks", + "#### #11 TextImageSideBySideWithSections", + "### Implementation", + "#### New Page creation", + "#### Enhancing an existing page", + "## NOTICE" + ] + }, + { + "path": "user/Style-Guide/button load more.md", + "name": "button load more.md", + "chapter": [ + "### Buttons Pagination / Load More", + "##### Setting:", + "## NOTICE" + ] + }, + { + "path": "user/Style-Guide/button.md", + "name": "button.md", + "chapter": [ + "### Buttons", + "#### Interaction", + "#### Context and usage", + "#### When to consider something else", + "#### Guidance", + "## NOTICE" + ] + }, + { + "path": "user/Style-Guide/date picker.md", + "name": "date picker.md", + "chapter": [ + "### Date Picker", + "#### Principles", + "#### When to use", + "## NOTICE" + ] + }, + { + "path": "user/Style-Guide/drop down.md", + "name": "drop down.md", + "chapter": ["### Drop Down", "#### ...", "#### Guidance", "## NOTICE"] + }, + { + "path": "user/Style-Guide/dropzone.md", + "name": "dropzone.md", + "chapter": [ + "### Dropzone", + "##### The dropzone supports following setting", + "#### Upload List", + "#### Upload Status", + "#### Auto upload queue", + "#### Delete Function", + "#### Preview Function", + "## NOTICE" + ] + }, + { + "path": "user/Style-Guide/input field.md", + "name": "input field.md", + "chapter": ["### Input Field", "#### Guidance", "## NOTICE"] + }, + { + "path": "user/Style-Guide/loading.md", + "name": "loading.md", + "chapter": ["### Loading", "#### Guidance", "## NOTICE"] + }, + { + "path": "user/Style-Guide/scrollbar.md", + "name": "scrollbar.md", + "chapter": ["### Scrollbar", "## NOTICE"] + }, + { + "path": "user/Style-Guide/searchbar.md", + "name": "searchbar.md", + "chapter": [ + "### Searchbar", + "#### Details", + "#### Interaction", + "#### Context and usage", + "#### Guidance", + "## NOTICE" + ] + }, + { + "path": "user/Style-Guide/toast message.md", + "name": "toast message.md", + "chapter": [ + "### Toast Message", + "#### Details", + "#### Style", + "## NOTICE" + ] + } + ] + } + ] +} diff --git a/public/documentation/js/Main.js b/public/documentation/js/Main.js index f6708a0ea..070680193 100644 --- a/public/documentation/js/Main.js +++ b/public/documentation/js/Main.js @@ -546,11 +546,11 @@ class Content extends Viewable { const isRawLink = url.href.startsWith(Settings.DOCBASE) const isAppLink = isLocalLink && url.pathname.startsWith('/documentation/') const isDevLink = - (isLocalLink && url.pathname.startsWith('/developer/')) || - (isRawLink && url.pathname.includes('/developer/')) + (isLocalLink && url.pathname.startsWith('/docs/developer/')) || + (isRawLink && url.pathname.includes('/docs/developer/')) const isDocsLink = - (isLocalLink && url.pathname.startsWith('/docs/')) || - (isRawLink && url.pathname.includes('/docs/')) + (isLocalLink && url.pathname.startsWith('/docs/user/')) || + (isRawLink && url.pathname.includes('/docs/user/')) const isPageLink = isAppLink && url.search === location.search if (isPageLink) { // ignore @@ -558,8 +558,8 @@ class Content extends Viewable { // ignore } else if (isDocsLink || isDevLink) { const path = decodeURI(link.href) - .replace(/^.*docs\//, 'docs/') - .replace(/^.*developer\//, 'developer/') + .replace(/^.*docs\/user\//, 'user/') + .replace(/^.*docs\/developer\//, 'developer/') .replace(/\/$/, '') link.setAttribute('href', `.?path=${encodeURI(path)}`) } @@ -584,7 +584,7 @@ class Content extends Viewable { renderMD(content) { this.content = content - const url = `${Settings.DOCBASE}/${state.releaseSelection}/${content.path}` + const url = `${Settings.DOCBASE}/${state.releaseSelection}/docs/${content.path}` this.loader.classList.remove('hidden') fetch(url) .then((response) => response.text()) diff --git a/public/documentation/js/Settings.js b/public/documentation/js/Settings.js index 3e3699c53..9146c33ca 100644 --- a/public/documentation/js/Settings.js +++ b/public/documentation/js/Settings.js @@ -20,7 +20,7 @@ export const Settings = { DOCBASE: 'https://raw.githubusercontent.com/eclipse-tractusx/portal-assets', SRCBASE: 'https://github.com/eclipse-tractusx/portal-assets', - DEFAULT_ROOT: 'docs', + DEFAULT_ROOT: 'user', } export const Patterns = { diff --git a/src/documentation/Release.js b/src/documentation/Release.js index beb217da8..965a62204 100644 --- a/src/documentation/Release.js +++ b/src/documentation/Release.js @@ -20,8 +20,6 @@ import fs from 'fs' import dirTree from 'directory-tree' -const exclude = /\/static(\/|$)/ - class MDHelper { readContent(path) { if (!fs.lstatSync(path).isFile()) return '' @@ -50,59 +48,40 @@ class MDHelper { class TreeHelper { static readDirTree(root) { - const tree = dirTree(root, { exclude }) + const tree = dirTree(root) //const tree = Transformer.tree2map({}, dirTree(root), undefined, 0, 0) return tree } } const createReleaseSelection = (version) => { - const Settings = { - BASE: 'https://api.github.com', - OWNER: 'eclipse-tractusx', - REPO: 'portal-assets', - } - - const url = `${Settings.BASE}/repos/${Settings.OWNER}/${Settings.REPO}/git/refs/tags` - const writeReleases = (releases) => fs.writeFileSync( './public/documentation/data/Releases.json', JSON.stringify(releases, null, 2) ) - const saveTags = (data) => - writeReleases( - data - .map((item) => item.ref) - .concat('main') - .reverse() - ) - - //(async () => saveLocal(await getJSON(url)))() - - if (version) { - writeReleases([version === 'main' ? version : `ref/tags/${version}`]) - } else { - fetch(url) - .then((response) => response.json()) - .then(saveTags) - .catch(() => writeReleases(['main'])) - } + writeReleases([ + version !== undefined && version !== 'main' + ? `ref/tags/${version}` + : 'main', + ]) } const createDocsMetadata = (version) => { version ||= 'main' const DOCS = { - docs: 'Catena-X Help Desk', + user: 'Catena-X Help Desk', developer: 'Catena-X Developer Documentation', } Object.entries(DOCS).forEach((item) => { + process.chdir('./docs') const tree = new MDHelper().extractChapterTree( TreeHelper.readDirTree(item[0]) ) + process.chdir('..') tree.name = item[1] const path = `./public/documentation/data/${version}` if (!fs.existsSync(path)) { diff --git a/src/documentation/https-proxy-get.js b/src/documentation/https-proxy-get.js deleted file mode 100644 index 634efa11b..000000000 --- a/src/documentation/https-proxy-get.js +++ /dev/null @@ -1,120 +0,0 @@ -/******************************************************************************** - * Copyright (c) 2021, 2023 Contributors to the Eclipse Foundation - * - * See the NOTICE file(s) distributed with this work for additional - * information regarding copyright ownership. - * - * This program and the accompanying materials are made available under the - * terms of the Apache License, Version 2.0 which is available at - * https://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - * - * SPDX-License-Identifier: Apache-2.0 - ********************************************************************************/ - -import http from 'http' -import https from 'https' - -/** - * checkProxy - check if the given URL needs to go through corporate proxy set as https_proxy - * - * @param {*} url parsed url - * @returns proxy settings or falsy if not applicable - */ - -export const checkProxy = (url) => - process.env.https_proxy && - !process.env.no_proxy - ?.split(/[, ]+/) - .find((domain) => url.hostname.endsWith(domain)) && - ((token) => - token.length < 4 - ? { - protocol: token[0], - host: token[1], - port: token[2], - } - : { - protocol: token[0], - auth: `${token[1]}:${token[2]}`, - host: token[3], - port: token[4], - })(process.env.https_proxy.split(/[:/@]+/)) - -/** - * get - read data from https URL, detect proxy settings from env vars - * - * Note: currently doesn't work with multiple proxies (like cntlm) - * - * @param {*} urlString url as string - * @param {*} options currently only supports headers attribute - * @returns promise to fulfil the https request - */ - -export async function get(urlString, options) { - const url = new URL(urlString) - - return new Promise((resolve, reject) => { - const readData = (response) => { - const chunks = [] - response.on('error', (err) => reject(err)) - response.on('data', (chunk) => chunks.push(chunk)) - response.on('end', () => - resolve({ - body: Buffer.concat(chunks).toString(), - headers: response.headers, - status: response.statusCode, - }) - ) - response.setTimeout(15000, () => reject('Timeout')) - } - const headers = { ...(options?.headers || {}), 'user-agent': 'nodejs' } - const proxy = checkProxy(url) - - if (proxy) { - if (proxy.auth) { - headers['proxy-authorization'] = - 'Basic ' + Buffer.from(proxy.auth).toString('base64') - } - http - .request({ - host: proxy.host, - port: proxy.port, - method: 'CONNECT', - path: `${url.hostname}:${url.port || 443}`, - headers, - }) - .on('connect', (res, socket) => { - delete headers['proxy-authorization'] - if (res.statusCode === 200) { - const agent = new https.Agent({ socket }) - https - .get( - { - host: url.hostname, - path: url.pathname, - agent, - headers: headers, - }, - readData - ) - .on('error', (err) => reject(err.message)) - } else { - reject('Could not connect to proxy!') - } - }) - .on('error', (err) => reject(err.message)) - .end() - } else { - https.get(url, readData) - } - }) -} - -export const getJSON = async (urlString, options) => - JSON.parse((await get(urlString, options)).body)