From 587d63ce0b1262914b23619992b26251881731c3 Mon Sep 17 00:00:00 2001 From: Nico Koprowski Date: Sun, 7 Apr 2024 13:31:04 +0800 Subject: [PATCH] docs(admin): move admin guide to docs/admin satisfies TRG 1.06 --- README.md | 4 ++-- docs/README.md | 4 ++-- docs/{OPERATOR_VIEW.md => admin/README.md} | 8 ++++---- docs/api/README.md | 2 +- 4 files changed, 9 insertions(+), 9 deletions(-) rename docs/{OPERATOR_VIEW.md => admin/README.md} (96%) diff --git a/README.md b/README.md index 1de2d5482..89c7d8e63 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ This repository is part of the overarching Eclipse Tractus-X project. BPDM is an acronym for business partner data management. This project serves two main purposes: -1. Provide services for for querying and sharing business partner information +1. Provide services for querying and sharing business partner information 2. Establish an infrastructure for realising the Golden Record process which turns business partner information from sharing members to Golden Records, that is cleaned and enriched business partner data uniquely identified by a business partner number (BPN) @@ -31,7 +31,7 @@ Subfolders for BPDM applications are easily recognizable by the `bpdm` prefix. Installation instructions for the BPDM services can be found in the following places: -1. [Local Installation](docs/OPERATOR_VIEW.md): Details how to install and configure the BPDM services on a host machine. +1. [Local Installation](docs/admin/README.md): Details how to install and configure the BPDM services on a host machine. 2. [Helm Installation](charts/bpdm/README.md): Explains how to use given Helm Charts to install the BPDM services on a kubernetes environment. ## GitHub Workflows diff --git a/docs/README.md b/docs/README.md index b4c6c3dea..c88d046b8 100644 --- a/docs/README.md +++ b/docs/README.md @@ -3,6 +3,6 @@ This folder contains supporting documentation for the BPDM applications. A good entrypoint are the `views` providing guidance for different interest groups: -- [Adoption view](api/ADOPTION_VIEW.md): You want to integrate BPDM APIs -- [Operator view](OPERATOR_VIEW.md): You want to operate BPDM applications +- [Adoption view](api/README.md): You want to integrate BPDM APIs +- [Operator view](admin/README.md): You want to operate BPDM applications - [Developer view](DEVELOPER_VIEW.md): You want to contribute to the development of BPDM \ No newline at end of file diff --git a/docs/OPERATOR_VIEW.md b/docs/admin/README.md similarity index 96% rename from docs/OPERATOR_VIEW.md rename to docs/admin/README.md index 4b85f7aa0..6dd349ca9 100644 --- a/docs/OPERATOR_VIEW.md +++ b/docs/admin/README.md @@ -92,12 +92,12 @@ These property files count to the operation views documentation. ## Installation via Docker Each BPDM application has an exemplary Dockerfile that can be used to install the BPDM application in a container. -Please refer to the [README](../README.md#container-images) for more information. +Please refer to the [README](../../README.md#container-images) for more information. ## Installation via Helm This repository contains Helm files for deploying BPDM Applications to a Kubernetes environment. -See the [BPDM Chart](../charts/bpdm) for details. +See the [BPDM Chart](../../charts/bpdm) for details. ## Post-Run Configuration @@ -113,7 +113,7 @@ If a technical key does not exist in the respective metadata the Pool rejects th Administrative level 1 areas follows the ISO 3166-2 norm and is filled by default. Such metadata does not need to be added by the operator. -The [use case Postman collection](postman/BPDM Tests.postman_collection.json) shows which metadata can be added and how that is done. +The [use case Postman collection](../postman/BPDM%20Tests.postman_collection.json) shows which metadata can be added and how that is done. Refer to use cases for Operators(O): - CL: Shows how to add available legal forms @@ -134,7 +134,7 @@ For deploying an EDC please consult the documentation on the [EDC repository](ht The general idea of configuring data offers for BPDM is to assets which grant access to a portion of the BPDM APIs. Which API resources are accessible over an asset is determined by the purposes defined in the BPDM framework agreement. For some purposes you may need to access business partner output data from the BPDM Gate for example but won't have access to the input data. -Blueprints for such assets are documented in this [POSTMAN collection](postman/EDC Provider Setup.postman_collection.json). +Blueprints for such assets are documented in this [POSTMAN collection](../postman/EDC Provider Setup.postman_collection.json). Accompanying the asset definitions are Policy and Contract Definition blueprints. Except for a general Access Policy those blueprints are grouped by purpose. diff --git a/docs/api/README.md b/docs/api/README.md index ad0be7f5b..1ee7c6158 100644 --- a/docs/api/README.md +++ b/docs/api/README.md @@ -291,7 +291,7 @@ That means if the business partner data contains an additional address, the resu This section details how a sharing member EDC can access an EDC exposing the BPDM API as assets. Before you can access the assets make sure that the BPDM EDC has been configured to provide assets for your company's BPN (see [Operator View](OPERATOR_VIEW.md)). -This [POSTMAN collection](postman/EDC BPDM Consumer.postman_collection.json) gives example requests for communicating with a deployed BPDM EDC over a sharing +This [POSTMAN collection](../postman/EDC BPDM Consumer.postman_collection.json) gives example requests for communicating with a deployed BPDM EDC over a sharing member EDC. In the collection you will see how you can negotiate for a BPDM data offer. Offers are separated into purposes (defined in the BPDM framework agreement) on why you want to access the BPDM API.