Updated integration guides and main readme

README.md

@@ -23,17 +23,18 @@ For more information please visit the website: https://www.hci.iao.fraunhofer.de
 * Zone Manager
 
 ## Documentation
-* [Short Software Description](./README.md#description)
-* [Usage Guide](./doc/README.md)
-* [Usage guide to integrate with Notarization Service (NOT)](./doc/Integration_with_NotaryAPI/index.md)
-* [Usage and integration guide for TSA](./doc/Integration_with_TSA/index.md)
-* [REST API](./Swagger/openapi-tspa.json)
-* [GDPR design decisions](https://gitlab.eclipse.org/eclipse/xfsc/train/TRAIN-Documentation/-/blob/main/concepts/gdpr/Readme.md)
-* [Security concept](https://gitlab.eclipse.org/eclipse/xfsc/train/TRAIN-Documentation/-/tree/main/concepts/security)
-* [Operations concept for Train Trust Framework Manager](./doc/operation)
-* [Blueprint guides how to setup a federation in usage of all components (step by step)](https://gitlab.eclipse.org/eclipse/xfsc/train/TRAIN-Documentation/-/tree/main/demonstration?ref_type=heads)
-* [FAQ](https://gitlab.eclipse.org/eclipse/xfsc/train/TRAIN-Documentation#frequently-asked-questions)
-* [Keyword Directory](https://gitlab.eclipse.org/eclipse/xfsc/xfsc-spec-2/-/blob/main/docs/train/train.md?ref_type=heads#definitions-acronyms-and-abbreviations)
+### [Short Software Description](./README.md#description)
+### [Usage Guide](./doc/README.md)
+### [Guide to integrate with Notarization Service (NOT)](./doc/Integration_with_NotaryAPI/index.md)
+### [Guide to integrate with OCM/PCM)](./doc/Integration_with_OCM_PCM/index.md)
+### [Usage and integration guide for TSA](./doc/Integration_with_TSA/index.md)
+### [REST API](./Swagger/openapi-tspa.json)
+### [GDPR design decisions](https://gitlab.eclipse.org/eclipse/xfsc/train/TRAIN-Documentation/-/blob/main/concepts/gdpr/Readme.md)
+### [Security concept](https://gitlab.eclipse.org/eclipse/xfsc/train/TRAIN-Documentation/-/tree/main/concepts/security)
+### [Operations concept for Train Trust Framework Manager](./doc/operation)
+### [Blueprint guides how to setup a federation in usage of all components (step by step)](https://gitlab.eclipse.org/eclipse/xfsc/train/TRAIN-Documentation/-/tree/main/demonstration?ref_type=heads)
+### [FAQ](https://gitlab.eclipse.org/eclipse/xfsc/train/TRAIN-Documentation#frequently-asked-questions)
+### [Keyword Directory](https://gitlab.eclipse.org/eclipse/xfsc/xfsc-spec-2/-/blob/main/docs/train/train.md?ref_type=heads#definitions-acronyms-and-abbreviations)
 
 
 ## Support

doc/Integration_with_NotaryAPI/index.md

@@ -2,8 +2,22 @@
 
 Based on the integration requirement from [Notary API extension](https://xfsc-valontoska-c8c70de320fe39c0697cbb8f437291f0f5c33da077eb238.gitlab.io/notare/notare/#external-interfaces:~:text=%5BCP.NOTAR.E1.00014%5D%20Enrollment%20of%20new%20issuers%20and%20authorities) we provide documentation regarding enrollment of new issuers and authorities.
 
-- Follow the Local Build or Helm based deployment procedure mentioned in the [documentation](./../install/README.md)
-- Make sure to initialize the trust list either in json/xml formats based on [TrustList Setup Documentation](./../operation/TrustListSetup.md)
-- Now once the trust list is setup successfully you can use the corresponding [TSP CRUD Operation Documentation](./../operation/TSP-CRUD-Operations.md) to enroll new issuers and authorities in the trust-list. The details regarding Trust Lists & TSP Data model can be found in the following [link](./../TrustList_DataModel_Design/templates-trustlist/)
-- Then make sure that you anchor the trust framework name and DID in the DNS using the following [documentation](./../operation/TrustFrameworkSetup.md)
-- TSPA Service is secured by JWT Token. So make sure you configure the the right OAuth2.0/OIDC Server for authorization&authentication purpose. The example realm used for keycloak can be found [here](./../../keycloak/realm-export.json).
\ No newline at end of file
+## Setup
+For a Setup of the Train Trust Framework Manager only, you should follow this components local build guide found here: [Local Build](./../install/README.md)
+
+If you want to setup the broader Train Framework locally, follow the local Train setup guide here: [Local Train Framework Setup](https://gitlab.eclipse.org/eclipse/xfsc/train/TRAIN-Documentation/-/tree/main/demonstration/local?ref_type=heads)
+
+To setup a production grade environment look at the production grade setup guide here: [Production Train Framework Setup](https://gitlab.eclipse.org/eclipse/xfsc/train/TRAIN-Documentation/-/tree/main/demonstration?ref_type=heads)
+
+## General Usage
+Since Train is not using the Notary as a Service or Dependency there is no special configuration needed on the Train components side. For Notary Users general usage of Train follows the general usage as for any other user.
+
+There are Postman collections showcasing the usage of each Train component from Creating a Trust List, Publishing TSPs, and even verifying a VC for both, local and production grade full Train setups.
+Instructions how to use and import the collections can be found in the setup manuals linked above.
+
+### Local Build usage:
+If you want to have a general simple way of interacting solely with the Train Trust Framework Manager here are the basic steps:
+1. Make sure to initialize the trust list either in json/xml formats based on [TrustList Setup Documentation](./../operation/TrustListSetup.md)
+2. Now once the trust list is setup successfully you can use the corresponding [TSP CRUD Operation Documentation](./../operation/TSP-CRUD-Operations.md) to enroll new issuers and authorities in the trust-list. The details regarding Trust Lists & TSP Data model can be found in the following [link](./../TrustList_DataModel_Design/templates-trustlist/)
+3.  Then make sure that you anchor the trust framework name and DID in the DNS using the following [documentation](./../operation/TrustFrameworkSetup.md)
+4. TSPA Service is secured by JWT Token. So make sure you configure the the right OAuth2.0/OIDC Server for authorization&authentication purpose. The example realm used for keycloak can be found [here](./../../keycloak/realm-export.json).
\ No newline at end of file

doc/Integration_with_OCM_PCM/index.md

+# Integration with OCM and PCM
+
+Based on the integration requirements we provide documentation regarding usage of the TRAIN Framework for OCM and PCM components.
+
+## Setup
+For a Setup of the Train Trust Framework Manager only, you should follow this components local build guide found here: [Local Build](./../install/README.md)
+
+If you want to setup the broader Train Framework locally, follow the local Train setup guide here: [Local Train Framework Setup](https://gitlab.eclipse.org/eclipse/xfsc/train/TRAIN-Documentation/-/tree/main/demonstration/local?ref_type=heads)
+
+To setup a production grade environment look at the production grade setup guide here: [Production Train Framework Setup](https://gitlab.eclipse.org/eclipse/xfsc/train/TRAIN-Documentation/-/tree/main/demonstration?ref_type=heads)
+
+## General Usage
+Since Train is not using the OCM/PCM as a Service or Dependency there is no special configuration needed on the Train components side. For OCM/PCM Users general usage of Train follows the general usage as for any other user.
+
+There are Postman collections showcasing the usage of each Train component from Creating a Trust List, Publishing TSPs, and even verifying a VC for both, local and production grade full Train setups.
+Instructions how to use and import the collections can be found in the setup manuals linked above.
+
+### Local Build usage:
+If you want to have a general simple way of interacting solely with the Train Trust Framework Manager here are the basic steps:
+1. Make sure to initialize the trust list either in json/xml formats based on [TrustList Setup Documentation](./../operation/TrustListSetup.md)
+2. Now once the trust list is setup successfully you can use the corresponding [TSP CRUD Operation Documentation](./../operation/TSP-CRUD-Operations.md) to enroll new issuers and authorities in the trust-list. The details regarding Trust Lists & TSP Data model can be found in the following [link](./../TrustList_DataModel_Design/templates-trustlist/)
+3.  Then make sure that you anchor the trust framework name and DID in the DNS using the following [documentation](./../operation/TrustFrameworkSetup.md)
+4. TSPA Service is secured by JWT Token. So make sure you configure the the right OAuth2.0/OIDC Server for authorization&authentication purpose. The example realm used for keycloak can be found [here](./../../keycloak/realm-export.json).
\ No newline at end of file

doc/Integration_with_TSA/index.md

 # Integration with TSA
 
-TFM uses TSA to sign the trust list VCs. TSA can be configured in the application.yaml and helm charts.
+TFM should use the TSA to sign the trust list VCs. TSA can be configured in the application.yaml and helm charts.
+The TSA Deployment is **not** detailed in the TRAIN Documentation, as the TSA setup instructions could be changed with new releases and then our documentation would not work anymore.
+
+**Current TSA Signer version is not compatible with TCR VC verification procedure so examplary deployments of the TFM use the internal signer implementation.**
 
 ## Configuration in application.yaml & Helm Charts
 
@@ -16,5 +19,3 @@ signer:
 **_url_** points to the public instance of the TSA deployed. **_key_** is the keyname configured in TSA Vault. **_namespace_** is also initialized in TSA.
 
 The deployment details of TSA can be found [here](https://gitlab.eclipse.org/eclipse/xfsc/tsa/signer). TSA is used only for signing in TFM and not used for validation purposes.
-
-Note: current TSA Signer version is not compatible with TCR VC verification procedure and TFM uses internal signer implementation.
\ No newline at end of file