From be1502175b791822f4452633bd8d5f6f610f8fe1 Mon Sep 17 00:00:00 2001 From: Amy <131142051+poort8amy@users.noreply.github.com> Date: Thu, 11 Jul 2024 15:35:29 +0200 Subject: [PATCH] Renamed docs and images --- README.md | 22 +++++++++--------- ...- Introduction.md => 01 - Introduction.md} | 0 ...Concepts.md => 02 - Dataspace Concepts.md} | 2 +- ... Journeys.md => 03 - Customer Journeys.md} | 0 ...> 04 - NoodleBar Implementation Stages.md} | 0 .../{5 - Tech Stack.md => 05 - Tech Stack.md} | 0 ...ployment Using a Local Identity Server.md} | 0 ... => 07 - Deployment Using OAuth Server.md} | 0 ...ARE.md => 08 - Deployment Using iSHARE.md} | 0 ...rations.md => 09 - Database Migrations.md} | 0 docs/10 - NoodleBar Showcase.md | 18 +++++++------- .../{1-home.png => 01-home.png} | Bin .../{2-login.png => 02-login.png} | Bin .../{3-registering.png => 03-registering.png} | Bin .../{4-logging-in.png => 04-logging-in.png} | Bin docs/showcase-images/{5-or.png => 05-or.png} | Bin ...ization.png => 06-or-add-organization.png} | Bin ...es.png => 07-ar-organization-mandates.png} | Bin ...png => 08-ar-add-organization-mandate.png} | Bin ...-ar-add-organization-mandate-property.png} | Bin 20 files changed, 21 insertions(+), 21 deletions(-) rename docs/{1 - Introduction.md => 01 - Introduction.md} (100%) rename docs/{2 - Dataspace Concepts.md => 02 - Dataspace Concepts.md} (97%) rename docs/{3 - Customer Journeys.md => 03 - Customer Journeys.md} (100%) rename docs/{4 - NoodleBar Implementation Stages.md => 04 - NoodleBar Implementation Stages.md} (100%) rename docs/{5 - Tech Stack.md => 05 - Tech Stack.md} (100%) rename docs/{6 - Deployment Using a Local Identity Server.md => 06 - Deployment Using a Local Identity Server.md} (100%) rename docs/{7 - Deployment Using OAuth Server.md => 07 - Deployment Using OAuth Server.md} (100%) rename docs/{8 - Deployment Using iSHARE.md => 08 - Deployment Using iSHARE.md} (100%) rename docs/{9 - Database Migrations.md => 09 - Database Migrations.md} (100%) rename docs/showcase-images/{1-home.png => 01-home.png} (100%) rename docs/showcase-images/{2-login.png => 02-login.png} (100%) rename docs/showcase-images/{3-registering.png => 03-registering.png} (100%) rename docs/showcase-images/{4-logging-in.png => 04-logging-in.png} (100%) rename docs/showcase-images/{5-or.png => 05-or.png} (100%) rename docs/showcase-images/{6-or-add-organization.png => 06-or-add-organization.png} (100%) rename docs/showcase-images/{7-ar-organization-mandates.png => 07-ar-organization-mandates.png} (100%) rename docs/showcase-images/{8-ar-add-organization-mandate.png => 08-ar-add-organization-mandate.png} (100%) rename docs/showcase-images/{9-ar-add-organization-mandate-property.png => 09-ar-add-organization-mandate-property.png} (100%) diff --git a/README.md b/README.md index e5b54cd..0828d95 100644 --- a/README.md +++ b/README.md @@ -6,15 +6,15 @@ NoodleBar, developed by Poort8, is a cutting-edge dataspace solution designed to ## Table of Contents -1. [Introduction](docs/1%20-%20Introduction.md) -2. [Dataspace Concepts](docs/2%20-%20Dataspace%20Concepts.md) -3. [Customer Journeys](docs/3%20-%20Customer%20Journeys.md) -4. [NoodleBar Implementation Stages](docs/4%20-%20NoodleBar%20Implementation%20Stages.md) -5. [Tech Stack](docs/5%20-%20Tech%20Stack.md) -6. [Deployment Using a Local Identity Server](docs/6%20-%20Deployment%20Using%20a%20Local%20Identity%20Server.md) -7. [Deployment Using OAuth Server](docs/7%20-%20Deployment%20Using%20OAuth%20Server.md) -8. [Deployment Using iSHARE](docs/8%20-%20Deployment%20Using%20iSHARE.md) -9. [Database Migrations](docs/9%20-%20Database%20Migrations.md) +1. [Introduction](docs/01%20-%20Introduction.md) +2. [Dataspace Concepts](docs/02%20-%20Dataspace%20Concepts.md) +3. [Customer Journeys](docs/03%20-%20Customer%20Journeys.md) +4. [NoodleBar Implementation Stages](docs/04%20-%20NoodleBar%20Implementation%20Stages.md) +5. [Tech Stack](docs/05%20-%20Tech%20Stack.md) +6. [Deployment Using a Local Identity Server](docs/06%20-%20Deployment%20Using%20a%20Local%20Identity%20Server.md) +7. [Deployment Using OAuth Server](docs/07%20-%20Deployment%20Using%20OAuth%20Server.md) +8. [Deployment Using iSHARE](docs/08%20-%20Deployment%20Using%20iSHARE.md) +9. [Database Migrations](docs/09%20-%20Database%20Migrations.md) 10. [NoodleBar Showcase](docs/10%20-%20NoodleBar%20Showcase.md) ## Context @@ -40,7 +40,7 @@ To facilitate setting up dataspaces that follow certain principles, serving as a ## Customer Journeys -The wiki describes the following [Customer Journeys](docs/3%20-%20Customer%20Journeys.md) in more detail: +The wiki describes the following [Customer Journeys](docs/03%20-%20Customer%20Journeys.md) in more detail: - Initiating Dataspace Core - Onboarding Data Sources @@ -55,7 +55,7 @@ The first 3 journeys comprise the launch of a first (prototype) of a dataspace. The Dataspace Core provides services for the organization registry, the organization onboarding process, the dataspace manager and (optionally) an authorization registry. With the dataspace manager the dataspace standards can be managed, such as the requirements for authentication and onboarding, and the definition of a dataspace data model. Secondly (and optionally), the dataspace initiator can provide Dataspace Adapters to Data Providers, with services to support them with mapping to the dataspace data model, and Identification, Authentication and Authorisation (IAA) according to the Dataspace standards. Dataspace Adapters are expected to be made redundant as Data Providers create independent solutions for this. Thirdly (and optionally), the dataspace initiator may choose to launch the dataspace with a prototype app, using the Dataspace Prototype services for logic, IAA, and multiple front-end channels for the end user. Such a Dataspace Prototype app can be removed when additional apps are added to the dataspace. -See the [architectural outline](docs/2%20-%20Dataspace%20Concepts.md) of these functions for more detail. +See the [architectural outline](docs/02%20-%20Dataspace%20Concepts.md) of these functions for more detail. ## Challenges diff --git a/docs/1 - Introduction.md b/docs/01 - Introduction.md similarity index 100% rename from docs/1 - Introduction.md rename to docs/01 - Introduction.md diff --git a/docs/2 - Dataspace Concepts.md b/docs/02 - Dataspace Concepts.md similarity index 97% rename from docs/2 - Dataspace Concepts.md rename to docs/02 - Dataspace Concepts.md index 1d6f863..b27b766 100644 --- a/docs/2 - Dataspace Concepts.md +++ b/docs/02 - Dataspace Concepts.md @@ -55,7 +55,7 @@ These roles ensure that all parties involved in data sharing are properly authen - **Modularity**: The components can be customized and integrated with other systems, making it a flexible solution for various organizational needs. - **Scalability**: NoodleBar is designed to scale, supporting growing data sharing needs as organizations expand. - **Compliance**: Fully aligned with the iSHARE Trust Framework, NoodleBar ensures compliance with stringent data sharing standards. -- **Versatility**: NoodleBar supports various [deployment models](/4%20-%20NoodleBar%20Implementation%20Stages.md), from simple local [identity management](/6%20-%20Deployment%20Using%20a%20Local%20Identity%20Server.md) to advanced [OAuth (recommended)](/7%20-%20Deployment%20Using%20OAuth%20Server.md) and [iSHARE](/8%20-%20Deployment%20Using%20iSHARE.md) compliant setups. +- **Versatility**: NoodleBar supports various [deployment models](04%20-%20NoodleBar%20Implementation%20Stages.md), from simple local [identity management](06%20-%20Deployment%20Using%20a%20Local%20Identity%20Server.md) to advanced [OAuth (recommended)](07%20-%20Deployment%20Using%20OAuth%20Server.md) and [iSHARE](08%20-%20Deployment%20Using%20iSHARE.md) compliant setups. ### 2.6 Dataspace Adapters (In Development) diff --git a/docs/3 - Customer Journeys.md b/docs/03 - Customer Journeys.md similarity index 100% rename from docs/3 - Customer Journeys.md rename to docs/03 - Customer Journeys.md diff --git a/docs/4 - NoodleBar Implementation Stages.md b/docs/04 - NoodleBar Implementation Stages.md similarity index 100% rename from docs/4 - NoodleBar Implementation Stages.md rename to docs/04 - NoodleBar Implementation Stages.md diff --git a/docs/5 - Tech Stack.md b/docs/05 - Tech Stack.md similarity index 100% rename from docs/5 - Tech Stack.md rename to docs/05 - Tech Stack.md diff --git a/docs/6 - Deployment Using a Local Identity Server.md b/docs/06 - Deployment Using a Local Identity Server.md similarity index 100% rename from docs/6 - Deployment Using a Local Identity Server.md rename to docs/06 - Deployment Using a Local Identity Server.md diff --git a/docs/7 - Deployment Using OAuth Server.md b/docs/07 - Deployment Using OAuth Server.md similarity index 100% rename from docs/7 - Deployment Using OAuth Server.md rename to docs/07 - Deployment Using OAuth Server.md diff --git a/docs/8 - Deployment Using iSHARE.md b/docs/08 - Deployment Using iSHARE.md similarity index 100% rename from docs/8 - Deployment Using iSHARE.md rename to docs/08 - Deployment Using iSHARE.md diff --git a/docs/9 - Database Migrations.md b/docs/09 - Database Migrations.md similarity index 100% rename from docs/9 - Database Migrations.md rename to docs/09 - Database Migrations.md diff --git a/docs/10 - NoodleBar Showcase.md b/docs/10 - NoodleBar Showcase.md index 45f763b..921ea1b 100644 --- a/docs/10 - NoodleBar Showcase.md +++ b/docs/10 - NoodleBar Showcase.md @@ -3,17 +3,17 @@ The NoodleBar Core Manager is a web application for managing the Organization Re ### 10.1 Registering and logging in When launching the Core Manager, the user is met with a welcome page. From here, the user can go to the login page. All other menu options are visible, but the user will automatically be directed to the login page if they are not authenticated. -![Home](showcase-images/1-home.png) -![Login](showcase-images/2-login.png) +![Home](showcase-images/01-home.png) +![Login](showcase-images/02-login.png) If the user isn't registered yet, they can do so with an email address and password. If the registration is complete, the user can login using their credentials. -![Registering](showcase-images/3-registering.png) -![Logging in](showcase-images/4-logging-in.png) +![Registering](showcase-images/03-registering.png) +![Logging in](showcase-images/04-logging-in.png) ### 10.2 Organization Register Within the Organization Register, the user can manage their organizations. They can add a new organization using the **New Organization** button. -![OR](showcase-images/5-or.png) -![OR - Add organization](showcase-images/6-or-add-organization.png) +![OR](showcase-images/05-or.png) +![OR - Add organization](showcase-images/06-or-add-organization.png) The user can delete an organization by clicking the delete button, or view additional details by clicking the **i** button. @@ -22,11 +22,11 @@ Within the Authorization Register, the user can manage their organizations manda #### 10.3.1 Organization mandates The user can add an organization mandate using the **Add Organization** button. Each organization can only have one mandate, the *Add Organization* form contains a dropdown menu with available organizations from the Organization Register. This means that an organization mandate cannot be added if there are no organizations in the Organization Register. The user can delete an organization mandate by clicking the trash can button. -![AR - Organization mandates](showcase-images/7-ar-organization-mandates.png) -![Ar - Add organization mandate](showcase-images/8-ar-add-organization-mandate.png) +![AR - Organization mandates](showcase-images/07-ar-organization-mandates.png) +![Ar - Add organization mandate](showcase-images/08-ar-add-organization-mandate.png) By clicking the label button, the user can manage named properties of an organization mandate. -![AR - Add organization mandate propery](showcase-images/9-ar-add-organization-mandate-property.png) +![AR - Add organization mandate propery](showcase-images/09-ar-add-organization-mandate-property.png) By clicking the **i** button, the user can view additional details of an organization mandate. From here, the user can manage employees of the organization mandate. ![AR - Organization mandate details](showcase-images/10-ar-organization-mandate-details.png) diff --git a/docs/showcase-images/1-home.png b/docs/showcase-images/01-home.png similarity index 100% rename from docs/showcase-images/1-home.png rename to docs/showcase-images/01-home.png diff --git a/docs/showcase-images/2-login.png b/docs/showcase-images/02-login.png similarity index 100% rename from docs/showcase-images/2-login.png rename to docs/showcase-images/02-login.png diff --git a/docs/showcase-images/3-registering.png b/docs/showcase-images/03-registering.png similarity index 100% rename from docs/showcase-images/3-registering.png rename to docs/showcase-images/03-registering.png diff --git a/docs/showcase-images/4-logging-in.png b/docs/showcase-images/04-logging-in.png similarity index 100% rename from docs/showcase-images/4-logging-in.png rename to docs/showcase-images/04-logging-in.png diff --git a/docs/showcase-images/5-or.png b/docs/showcase-images/05-or.png similarity index 100% rename from docs/showcase-images/5-or.png rename to docs/showcase-images/05-or.png diff --git a/docs/showcase-images/6-or-add-organization.png b/docs/showcase-images/06-or-add-organization.png similarity index 100% rename from docs/showcase-images/6-or-add-organization.png rename to docs/showcase-images/06-or-add-organization.png diff --git a/docs/showcase-images/7-ar-organization-mandates.png b/docs/showcase-images/07-ar-organization-mandates.png similarity index 100% rename from docs/showcase-images/7-ar-organization-mandates.png rename to docs/showcase-images/07-ar-organization-mandates.png diff --git a/docs/showcase-images/8-ar-add-organization-mandate.png b/docs/showcase-images/08-ar-add-organization-mandate.png similarity index 100% rename from docs/showcase-images/8-ar-add-organization-mandate.png rename to docs/showcase-images/08-ar-add-organization-mandate.png diff --git a/docs/showcase-images/9-ar-add-organization-mandate-property.png b/docs/showcase-images/09-ar-add-organization-mandate-property.png similarity index 100% rename from docs/showcase-images/9-ar-add-organization-mandate-property.png rename to docs/showcase-images/09-ar-add-organization-mandate-property.png