From 402a5a0f662cfef58c9cf4c7cdd76c8683c3e2d0 Mon Sep 17 00:00:00 2001 From: "margi.shah1" Date: Thu, 10 Oct 2024 16:15:40 +0530 Subject: [PATCH 01/17] docs: align doc structure with TRG-1 --- .github/pull_request_template.md | 2 +- CHANGELOG.md | 4 ++-- CONTRIBUTING.md | 2 +- README.md | 2 +- charts/centralidp/README.md | 4 ++-- charts/centralidp/README.md.gotmpl | 4 ++-- charts/sharedidp/README.md | 2 +- charts/sharedidp/README.md.gotmpl | 2 +- .../charts/portal-iam/.helmignore | 0 .../charts/portal-iam/Chart.yaml | 0 .../charts/portal-iam/LICENSE | 0 .../charts/portal-iam/templates/_helpers.tpl | 0 .../templates/hooks/check-variable.yaml | 0 .../templates/hooks/seeding-job.yaml | 0 .../templates/secret-external-db.yaml | 0 .../templates/secret-instancetype.yaml | 0 .../portal-iam/templates/secret-kc-admin.yaml | 0 .../charts/portal-iam/values.yaml | 0 .../dev-process/How to contribute.md} | 0 .../blue/kc-central-blue-values.yaml | 0 ...ostgresql-db-central-blue-statefulset.yaml | 0 .../sharedidp/blue/kc-shared-blue-values.yaml | 0 ...postgresql-db-shared-blue-statefulset.yaml | 0 .../portal-iam-helm-chart.md | 2 +- .../00. External Identity Provider.md | 0 .../01. Introduction.md | 0 .../02. Generic Setup.md | 0 .../technical-documentation}/03. Clients.md | 0 .../04 User Management.md | 0 .../05. Authentication Configuration.md | 0 .../06. Roles & Rights Concept.md | 0 .../07. Password Policy.md | 0 .../08. Email Configuration.md | 0 .../09. Event Logging.md | 0 .../10. Generic Security.md | 0 .../technical-documentation}/11. FAQ.md | 6 ++--- .../12. Upgrade Details.md | 0 .../13. Operational Notes.md | 0 .../consultation.md | 0 .../Known-Knowns.md} | 2 +- docs/workshops/README.md | 23 +++++++++++++++++++ .../workshop-20230927.md | 0 .../workshop-20231005.md | 2 +- 43 files changed, 40 insertions(+), 17 deletions(-) rename docs/{consultation => admin}/charts/portal-iam/.helmignore (100%) rename docs/{consultation => admin}/charts/portal-iam/Chart.yaml (100%) rename docs/{consultation => admin}/charts/portal-iam/LICENSE (100%) rename docs/{consultation => admin}/charts/portal-iam/templates/_helpers.tpl (100%) rename docs/{consultation => admin}/charts/portal-iam/templates/hooks/check-variable.yaml (100%) rename docs/{consultation => admin}/charts/portal-iam/templates/hooks/seeding-job.yaml (100%) rename docs/{consultation => admin}/charts/portal-iam/templates/secret-external-db.yaml (100%) rename docs/{consultation => admin}/charts/portal-iam/templates/secret-instancetype.yaml (100%) rename docs/{consultation => admin}/charts/portal-iam/templates/secret-kc-admin.yaml (100%) rename docs/{consultation => admin}/charts/portal-iam/values.yaml (100%) rename docs/{technical documentation/14. How to contribute.md => admin/dev-process/How to contribute.md} (100%) rename docs/{consultation => admin}/environments/centralidp/blue/kc-central-blue-values.yaml (100%) rename docs/{consultation => admin}/environments/centralidp/blue/postgresql-db-central-blue-statefulset.yaml (100%) rename docs/{consultation => admin}/environments/sharedidp/blue/kc-shared-blue-values.yaml (100%) rename docs/{consultation => admin}/environments/sharedidp/blue/postgresql-db-shared-blue-statefulset.yaml (100%) rename docs/{consultation => admin}/portal-iam-helm-chart.md (99%) rename docs/{technical documentation => admin/technical-documentation}/00. External Identity Provider.md (100%) rename docs/{technical documentation => admin/technical-documentation}/01. Introduction.md (100%) rename docs/{technical documentation => admin/technical-documentation}/02. Generic Setup.md (100%) rename docs/{technical documentation => admin/technical-documentation}/03. Clients.md (100%) rename docs/{technical documentation => admin/technical-documentation}/04 User Management.md (100%) rename docs/{technical documentation => admin/technical-documentation}/05. Authentication Configuration.md (100%) rename docs/{technical documentation => admin/technical-documentation}/06. Roles & Rights Concept.md (100%) rename docs/{technical documentation => admin/technical-documentation}/07. Password Policy.md (100%) rename docs/{technical documentation => admin/technical-documentation}/08. Email Configuration.md (100%) rename docs/{technical documentation => admin/technical-documentation}/09. Event Logging.md (100%) rename docs/{technical documentation => admin/technical-documentation}/10. Generic Security.md (100%) rename docs/{technical documentation => admin/technical-documentation}/11. FAQ.md (93%) rename docs/{technical documentation => admin/technical-documentation}/12. Upgrade Details.md (100%) rename docs/{technical documentation => admin/technical-documentation}/13. Operational Notes.md (100%) rename docs/{consultation => architecture}/consultation.md (100%) rename docs/{technical documentation/16. Known-Knowns.md => known-knowns/Known-Knowns.md} (81%) create mode 100644 docs/workshops/README.md rename docs/{consultation => workshops}/workshop-20230927.md (100%) rename docs/{consultation => workshops}/workshop-20231005.md (99%) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index f060dd9d..1ae371ce 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-iam/blob/main/docs/technical%20documentation/14.%20How%20to%20contribute.md) +- [ ] I have followed the [contributing guidelines](https://github.com/eclipse-tractusx/portal-iam/blob/main/docs/admin/dev-process/How%20to%20contribute.md) - [ ] I have added copyright and license headers, footers (for .md files) or files (for images) - [ ] I have performed a self-review of my changes - [ ] I have successfully tested my changes diff --git a/CHANGELOG.md b/CHANGELOG.md index 4697ff84..a331a4b6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -40,7 +40,7 @@ New features, fixed bugs, known defects and other noteworthy changes to each rel The following issues were discovered: * 403 error when accessing the Partner Network in the Portal Frontend [#132](https://github.com/eclipse-tractusx/portal-iam/pull/132) -* Refresh token rotation causes page reload in frontend apps when using multiple tabs, see [User Token Lifespan](docs/consultation/workshop-20231005.md#user-token-lifespan) +* Refresh token rotation causes page reload in frontend apps when using multiple tabs, see [User Token Lifespan](docs/workshops/workshop-20231005.md#user-token-lifespan) * Custom login themes break when inserting HTML/CSS/JavaScript code in the IdP display name ## 3.0.0 @@ -431,7 +431,7 @@ sharedidp: The following issues were recently discovered: -* Refresh token rotation causes page reload in frontend apps when using multiple tabs, see [User Token Lifespan](docs/consultation/workshop-20231005.md#user-token-lifespan) +* Refresh token rotation causes page reload in frontend apps when using multiple tabs, see [User Token Lifespan](docs/workshops/workshop-20231005.md#user-token-lifespan) * Custom login themes break when inserting HTML/CSS/JavaScript code in the IdP display name ## 1.2.0 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f01fc38d..ca2fa84c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -77,7 +77,7 @@ https://www.eclipse.org/projects/handbook/#resources-commit ## How To Contribute -For more practical information, please refer to [Contribution details](/docs/technical%20documentation/14.%20How%20to%20contribute.md). +For more practical information, please refer to [Contribution details](/docs/admin/dev-process/00.%20How%20to%20contribute.md). ## Contact diff --git a/README.md b/README.md index 88a876c9..1c9d5663 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ For further information please refer to the chart specific README files, availab ## Known Issues and Limitations -See [Known Knowns](/docs/technical%20documentation/16.%20Known-Knowns.md). +See [Known Knowns](/docs/known-knowns/00.%20Known-Knowns.md). ## Notice for Docker images diff --git a/charts/centralidp/README.md b/charts/centralidp/README.md index 76d42051..0d0dcb9d 100644 --- a/charts/centralidp/README.md +++ b/charts/centralidp/README.md @@ -4,7 +4,7 @@ This helm chart installs the Helm chart for Central Keycloak Instance. -For further information please refer to the [technical documentation](../../docs/technical%20documentation). +For further information please refer to the [technical documentation](../../docs/admin/technical-documentation/). The referenced container images are for demonstration purposes only. @@ -155,7 +155,7 @@ We also recommend checking out the [Keycloak Upgrading Guide](https://www.keyclo To be explicitly mentioned: this major adds the production mode with default value false and the reverse proxy mode with default value passthrough. Please check the description of those parameters and decide if they're suitable for you. -Please also refer to [Upgrade Details](../../docs/technical%20documentation/12.%20Upgrade%20Details.md#v200). +Please also refer to [Upgrade Details](../../docs/admin/technical-documentation/12.%20Upgrade%20Details.md#v200). #### Upgrade approach diff --git a/charts/centralidp/README.md.gotmpl b/charts/centralidp/README.md.gotmpl index 8bd77957..f1a3a122 100644 --- a/charts/centralidp/README.md.gotmpl +++ b/charts/centralidp/README.md.gotmpl @@ -4,7 +4,7 @@ This helm chart installs the {{ template "chart.description" . }}. -For further information please refer to the [technical documentation](../../docs/technical%20documentation). +For further information please refer to the [technical documentation](../../docs/admin/technical-documentation). The referenced container images are for demonstration purposes only. @@ -80,7 +80,7 @@ We also recommend checking out the [Keycloak Upgrading Guide](https://www.keyclo To be explicitly mentioned: this major adds the production mode with default value false and the reverse proxy mode with default value passthrough. Please check the description of those parameters and decide if they're suitable for you. -Please also refer to [Upgrade Details](../../docs/technical%20documentation/12.%20Upgrade%20Details.md#v200). +Please also refer to [Upgrade Details](../../docs/admin/technical-documentation/12.%20Upgrade%20Details.md#v200). #### Upgrade approach diff --git a/charts/sharedidp/README.md b/charts/sharedidp/README.md index 1fb45ec9..54dacd0f 100644 --- a/charts/sharedidp/README.md +++ b/charts/sharedidp/README.md @@ -4,7 +4,7 @@ This helm chart installs the Helm chart for Shared Keycloak Instance. -For further information please refer to the [technical documentation](../../docs/technical%20documentation). +For further information please refer to the [technical documentation](../../docs/admin/technical-documentation/). The referenced container images are for demonstration purposes only. diff --git a/charts/sharedidp/README.md.gotmpl b/charts/sharedidp/README.md.gotmpl index 823baa69..8e939016 100644 --- a/charts/sharedidp/README.md.gotmpl +++ b/charts/sharedidp/README.md.gotmpl @@ -4,7 +4,7 @@ This helm chart installs the {{ template "chart.description" . }}. -For further information please refer to the [technical documentation](../../docs/technical%20documentation). +For further information please refer to the [technical documentation](../../docs/admin/technical-documentation6). The referenced container images are for demonstration purposes only. diff --git a/docs/consultation/charts/portal-iam/.helmignore b/docs/admin/charts/portal-iam/.helmignore similarity index 100% rename from docs/consultation/charts/portal-iam/.helmignore rename to docs/admin/charts/portal-iam/.helmignore diff --git a/docs/consultation/charts/portal-iam/Chart.yaml b/docs/admin/charts/portal-iam/Chart.yaml similarity index 100% rename from docs/consultation/charts/portal-iam/Chart.yaml rename to docs/admin/charts/portal-iam/Chart.yaml diff --git a/docs/consultation/charts/portal-iam/LICENSE b/docs/admin/charts/portal-iam/LICENSE similarity index 100% rename from docs/consultation/charts/portal-iam/LICENSE rename to docs/admin/charts/portal-iam/LICENSE diff --git a/docs/consultation/charts/portal-iam/templates/_helpers.tpl b/docs/admin/charts/portal-iam/templates/_helpers.tpl similarity index 100% rename from docs/consultation/charts/portal-iam/templates/_helpers.tpl rename to docs/admin/charts/portal-iam/templates/_helpers.tpl diff --git a/docs/consultation/charts/portal-iam/templates/hooks/check-variable.yaml b/docs/admin/charts/portal-iam/templates/hooks/check-variable.yaml similarity index 100% rename from docs/consultation/charts/portal-iam/templates/hooks/check-variable.yaml rename to docs/admin/charts/portal-iam/templates/hooks/check-variable.yaml diff --git a/docs/consultation/charts/portal-iam/templates/hooks/seeding-job.yaml b/docs/admin/charts/portal-iam/templates/hooks/seeding-job.yaml similarity index 100% rename from docs/consultation/charts/portal-iam/templates/hooks/seeding-job.yaml rename to docs/admin/charts/portal-iam/templates/hooks/seeding-job.yaml diff --git a/docs/consultation/charts/portal-iam/templates/secret-external-db.yaml b/docs/admin/charts/portal-iam/templates/secret-external-db.yaml similarity index 100% rename from docs/consultation/charts/portal-iam/templates/secret-external-db.yaml rename to docs/admin/charts/portal-iam/templates/secret-external-db.yaml diff --git a/docs/consultation/charts/portal-iam/templates/secret-instancetype.yaml b/docs/admin/charts/portal-iam/templates/secret-instancetype.yaml similarity index 100% rename from docs/consultation/charts/portal-iam/templates/secret-instancetype.yaml rename to docs/admin/charts/portal-iam/templates/secret-instancetype.yaml diff --git a/docs/consultation/charts/portal-iam/templates/secret-kc-admin.yaml b/docs/admin/charts/portal-iam/templates/secret-kc-admin.yaml similarity index 100% rename from docs/consultation/charts/portal-iam/templates/secret-kc-admin.yaml rename to docs/admin/charts/portal-iam/templates/secret-kc-admin.yaml diff --git a/docs/consultation/charts/portal-iam/values.yaml b/docs/admin/charts/portal-iam/values.yaml similarity index 100% rename from docs/consultation/charts/portal-iam/values.yaml rename to docs/admin/charts/portal-iam/values.yaml diff --git a/docs/technical documentation/14. How to contribute.md b/docs/admin/dev-process/How to contribute.md similarity index 100% rename from docs/technical documentation/14. How to contribute.md rename to docs/admin/dev-process/How to contribute.md diff --git a/docs/consultation/environments/centralidp/blue/kc-central-blue-values.yaml b/docs/admin/environments/centralidp/blue/kc-central-blue-values.yaml similarity index 100% rename from docs/consultation/environments/centralidp/blue/kc-central-blue-values.yaml rename to docs/admin/environments/centralidp/blue/kc-central-blue-values.yaml diff --git a/docs/consultation/environments/centralidp/blue/postgresql-db-central-blue-statefulset.yaml b/docs/admin/environments/centralidp/blue/postgresql-db-central-blue-statefulset.yaml similarity index 100% rename from docs/consultation/environments/centralidp/blue/postgresql-db-central-blue-statefulset.yaml rename to docs/admin/environments/centralidp/blue/postgresql-db-central-blue-statefulset.yaml diff --git a/docs/consultation/environments/sharedidp/blue/kc-shared-blue-values.yaml b/docs/admin/environments/sharedidp/blue/kc-shared-blue-values.yaml similarity index 100% rename from docs/consultation/environments/sharedidp/blue/kc-shared-blue-values.yaml rename to docs/admin/environments/sharedidp/blue/kc-shared-blue-values.yaml diff --git a/docs/consultation/environments/sharedidp/blue/postgresql-db-shared-blue-statefulset.yaml b/docs/admin/environments/sharedidp/blue/postgresql-db-shared-blue-statefulset.yaml similarity index 100% rename from docs/consultation/environments/sharedidp/blue/postgresql-db-shared-blue-statefulset.yaml rename to docs/admin/environments/sharedidp/blue/postgresql-db-shared-blue-statefulset.yaml diff --git a/docs/consultation/portal-iam-helm-chart.md b/docs/admin/portal-iam-helm-chart.md similarity index 99% rename from docs/consultation/portal-iam-helm-chart.md rename to docs/admin/portal-iam-helm-chart.md index 979ade65..fb64161c 100644 --- a/docs/consultation/portal-iam-helm-chart.md +++ b/docs/admin/portal-iam-helm-chart.md @@ -31,7 +31,7 @@ there is a [hook](./charts/portal-iam/templates/hooks/check-variable.yaml) creat The Helm Chart can be extended to add more detailed objects, but it was not part of this Proof of Concept. -The chart is implemented [here](../consultation/charts/). +The chart is implemented [here](../admin/charts/). ### How to use - Example of usage diff --git a/docs/technical documentation/00. External Identity Provider.md b/docs/admin/technical-documentation/00. External Identity Provider.md similarity index 100% rename from docs/technical documentation/00. External Identity Provider.md rename to docs/admin/technical-documentation/00. External Identity Provider.md diff --git a/docs/technical documentation/01. Introduction.md b/docs/admin/technical-documentation/01. Introduction.md similarity index 100% rename from docs/technical documentation/01. Introduction.md rename to docs/admin/technical-documentation/01. Introduction.md diff --git a/docs/technical documentation/02. Generic Setup.md b/docs/admin/technical-documentation/02. Generic Setup.md similarity index 100% rename from docs/technical documentation/02. Generic Setup.md rename to docs/admin/technical-documentation/02. Generic Setup.md diff --git a/docs/technical documentation/03. Clients.md b/docs/admin/technical-documentation/03. Clients.md similarity index 100% rename from docs/technical documentation/03. Clients.md rename to docs/admin/technical-documentation/03. Clients.md diff --git a/docs/technical documentation/04 User Management.md b/docs/admin/technical-documentation/04 User Management.md similarity index 100% rename from docs/technical documentation/04 User Management.md rename to docs/admin/technical-documentation/04 User Management.md diff --git a/docs/technical documentation/05. Authentication Configuration.md b/docs/admin/technical-documentation/05. Authentication Configuration.md similarity index 100% rename from docs/technical documentation/05. Authentication Configuration.md rename to docs/admin/technical-documentation/05. Authentication Configuration.md diff --git a/docs/technical documentation/06. Roles & Rights Concept.md b/docs/admin/technical-documentation/06. Roles & Rights Concept.md similarity index 100% rename from docs/technical documentation/06. Roles & Rights Concept.md rename to docs/admin/technical-documentation/06. Roles & Rights Concept.md diff --git a/docs/technical documentation/07. Password Policy.md b/docs/admin/technical-documentation/07. Password Policy.md similarity index 100% rename from docs/technical documentation/07. Password Policy.md rename to docs/admin/technical-documentation/07. Password Policy.md diff --git a/docs/technical documentation/08. Email Configuration.md b/docs/admin/technical-documentation/08. Email Configuration.md similarity index 100% rename from docs/technical documentation/08. Email Configuration.md rename to docs/admin/technical-documentation/08. Email Configuration.md diff --git a/docs/technical documentation/09. Event Logging.md b/docs/admin/technical-documentation/09. Event Logging.md similarity index 100% rename from docs/technical documentation/09. Event Logging.md rename to docs/admin/technical-documentation/09. Event Logging.md diff --git a/docs/technical documentation/10. Generic Security.md b/docs/admin/technical-documentation/10. Generic Security.md similarity index 100% rename from docs/technical documentation/10. Generic Security.md rename to docs/admin/technical-documentation/10. Generic Security.md diff --git a/docs/technical documentation/11. FAQ.md b/docs/admin/technical-documentation/11. FAQ.md similarity index 93% rename from docs/technical documentation/11. FAQ.md rename to docs/admin/technical-documentation/11. FAQ.md index c8140fa5..419e5ae9 100644 --- a/docs/technical documentation/11. FAQ.md +++ b/docs/admin/technical-documentation/11. FAQ.md @@ -83,7 +83,7 @@ The [CX-Central realm file](../../import/realm-config/generic/catenax-central/CX 4. Update documentation -- [Roles&Rights Matrix](/docs/technical%20documentation/06.%20Roles%20&%20Rights%20Concept.md#253-portal-application) +- [Roles&Rights Matrix](/docs/admin/technical-documentation/06.%20Roles%20&%20Rights%20Concept.md#253-portal-application) ### App Role(s) @@ -134,9 +134,9 @@ The [CX-Central realm file](../../import/realm-config/generic/catenax-central/CX 4. Update documentation -- [Roles&Rights Matrix](/docs/technical%20documentation/06.%20Roles%20&%20Rights%20Concept.md#253b-technical-user-accounts) +- [Roles&Rights Matrix](/docs/admin/technical-documentation/06.%20Roles%20&%20Rights%20Concept.md#253b-technical-user-accounts) -- [Technical User Creation - End User documentation]([/docs/technical%20documentation/04%20User%20Management.md](https://github.com/eclipse-tractusx/portal-assets/blob/main/docs/03.%20User%20Management/03.%20Technical%20User/02.%20Create%20Technical%20User.md#available-technical-user-roles)) +- [Technical User Creation - End User documentation]([/docs/admin/technical-documentation/04%20User%20Management.md](https://github.com/eclipse-tractusx/portal-assets/blob/main/docs/03.%20User%20Management/03.%20Technical%20User/02.%20Create%20Technical%20User.md#available-technical-user-roles)) ## What is the difference between roles & permission diff --git a/docs/technical documentation/12. Upgrade Details.md b/docs/admin/technical-documentation/12. Upgrade Details.md similarity index 100% rename from docs/technical documentation/12. Upgrade Details.md rename to docs/admin/technical-documentation/12. Upgrade Details.md diff --git a/docs/technical documentation/13. Operational Notes.md b/docs/admin/technical-documentation/13. Operational Notes.md similarity index 100% rename from docs/technical documentation/13. Operational Notes.md rename to docs/admin/technical-documentation/13. Operational Notes.md diff --git a/docs/consultation/consultation.md b/docs/architecture/consultation.md similarity index 100% rename from docs/consultation/consultation.md rename to docs/architecture/consultation.md diff --git a/docs/technical documentation/16. Known-Knowns.md b/docs/known-knowns/Known-Knowns.md similarity index 81% rename from docs/technical documentation/16. Known-Knowns.md rename to docs/known-knowns/Known-Knowns.md index 46d1d1a7..415dc1cd 100644 --- a/docs/technical documentation/16. Known-Knowns.md +++ b/docs/known-knowns/Known-Knowns.md @@ -1,6 +1,6 @@ # Known Issues and Limitations -- Refresh token rotation causes page reload in frontend apps when using multiple tabs, see [User Token Lifespan](../consultation/workshop-20231005.md#user-token-lifespan) +- Refresh token rotation causes page reload in frontend apps when using multiple tabs, see [User Token Lifespan](../workshops/workshop-20231005.md#user-token-lifespan) - Custom login themes break when inserting HTML/CSS/JavaScript code in the IdP display name ## NOTICE diff --git a/docs/workshops/README.md b/docs/workshops/README.md new file mode 100644 index 00000000..fa634991 --- /dev/null +++ b/docs/workshops/README.md @@ -0,0 +1,23 @@ +# Workshop Documentation + +This repository contains resources and materials related to the workshops conducted. + +## Workshops Overview + +This folder includes documentation and files for the following workshops: + +1. **Portal IAM Workshop** + - Date: October 5, 2023 + - **Documentation Link**: [Portal IAM Workshop Documentation](workshop-20231005.md) + +2. **IAM Helm Chart Workshop** + - Date: September 27, 2023 + - **Documentation Link**: [IAM Helm Chart Workshop Documentation](workshop-20230927.md) + +## 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: 2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-iam diff --git a/docs/consultation/workshop-20230927.md b/docs/workshops/workshop-20230927.md similarity index 100% rename from docs/consultation/workshop-20230927.md rename to docs/workshops/workshop-20230927.md diff --git a/docs/consultation/workshop-20231005.md b/docs/workshops/workshop-20231005.md similarity index 99% rename from docs/consultation/workshop-20231005.md rename to docs/workshops/workshop-20231005.md index 3d163721..bf371008 100644 --- a/docs/consultation/workshop-20231005.md +++ b/docs/workshops/workshop-20231005.md @@ -1,4 +1,4 @@ -# Portal IAM - Workshop 5th Octuber, 2023 +# Portal IAM - Workshop 5th October, 2023 ## User Token Lifespan From 4d8081b1235177f49365d28f412c89ef5a8646c4 Mon Sep 17 00:00:00 2001 From: "margi.shah1" Date: Fri, 11 Oct 2024 12:07:52 +0530 Subject: [PATCH 02/17] docs: update doc links in .md file after structure change in docs folder --- CONTRIBUTING.md | 2 +- README.md | 2 +- docs/admin/technical-documentation/11. FAQ.md | 7 ++++--- ...henticaction.png => required-authentication.png} | Bin ....license => required-authentication.png.license} | 0 5 files changed, 6 insertions(+), 5 deletions(-) rename docs/static/{required-authenticaction.png => required-authentication.png} (100%) rename docs/static/{required-authenticaction.png.license => required-authentication.png.license} (100%) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ca2fa84c..ef898b5f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -77,7 +77,7 @@ https://www.eclipse.org/projects/handbook/#resources-commit ## How To Contribute -For more practical information, please refer to [Contribution details](/docs/admin/dev-process/00.%20How%20to%20contribute.md). +For more practical information, please refer to [Contribution details](/docs/admin/dev-process/How%20to%20contribute.md). ## Contact diff --git a/README.md b/README.md index 1c9d5663..a7732bff 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ For further information please refer to the chart specific README files, availab ## Known Issues and Limitations -See [Known Knowns](/docs/known-knowns/00.%20Known-Knowns.md). +See [Known Knowns](/docs/known-knowns/Known-Knowns.md). ## Notice for Docker images diff --git a/docs/admin/technical-documentation/11. FAQ.md b/docs/admin/technical-documentation/11. FAQ.md index 419e5ae9..63a399c4 100644 --- a/docs/admin/technical-documentation/11. FAQ.md +++ b/docs/admin/technical-documentation/11. FAQ.md @@ -79,7 +79,7 @@ To transform the created "role" to an actual role, since currently its a single 3. Update keycloak base image -The [CX-Central realm file](../../import/realm-config/generic/catenax-central/CX-Central-realm.json) needs to be updated with role changes (export from Keycloak) to provide the configuration in the init container for the realm import and seeding. +The [CX-Central realm file](../../../import/realm-config/generic/catenax-central/CX-Central-realm.json) needs to be updated with role changes (export from Keycloak) to provide the configuration in the init container for the realm import and seeding. 4. Update documentation @@ -130,13 +130,14 @@ For the scenario of sql, the relevant sql can get found below: 3. Update Keycloak base image -The [CX-Central realm file](../../import/realm-config/generic/catenax-central/CX-Central-realm.json) needs to be updated with role changes (export from Keycloak) to provide the configuration in the init container for the realm import and seeding. +The [CX-Central realm file](../../../import/realm-config/generic/catenax-central/CX-Central-realm.json) needs to be updated with role changes (export from Keycloak) to provide the configuration in the init container for the realm import and seeding. 4. Update documentation - [Roles&Rights Matrix](/docs/admin/technical-documentation/06.%20Roles%20&%20Rights%20Concept.md#253b-technical-user-accounts) -- [Technical User Creation - End User documentation]([/docs/admin/technical-documentation/04%20User%20Management.md](https://github.com/eclipse-tractusx/portal-assets/blob/main/docs/03.%20User%20Management/03.%20Technical%20User/02.%20Create%20Technical%20User.md#available-technical-user-roles)) +- [Technical User Creation - End User documentation](https://github.com/eclipse-tractusx/portal-assets/blob/main/docs/user/03.%20User%20Management/03.%20Technical%20User/02.%20Create%20Technical%20User.md#available-technical-user-roles) +- [User Management](/docs/admin/technical-documentation/04%20User%20Management.md) ## What is the difference between roles & permission diff --git a/docs/static/required-authenticaction.png b/docs/static/required-authentication.png similarity index 100% rename from docs/static/required-authenticaction.png rename to docs/static/required-authentication.png diff --git a/docs/static/required-authenticaction.png.license b/docs/static/required-authentication.png.license similarity index 100% rename from docs/static/required-authenticaction.png.license rename to docs/static/required-authentication.png.license From 07b7163684d45b7f27b71fc28ab657342fcb3358 Mon Sep 17 00:00:00 2001 From: "margi.shah1" Date: Mon, 14 Oct 2024 10:20:53 +0530 Subject: [PATCH 03/17] docs: move workshop folder inside user folder --- docs/{ => user}/known-knowns/Known-Knowns.md | 0 docs/{ => user}/workshops/README.md | 10 +++++----- docs/{ => user}/workshops/workshop-20230927.md | 0 docs/{ => user}/workshops/workshop-20231005.md | 0 4 files changed, 5 insertions(+), 5 deletions(-) rename docs/{ => user}/known-knowns/Known-Knowns.md (100%) rename docs/{ => user}/workshops/README.md (79%) rename docs/{ => user}/workshops/workshop-20230927.md (100%) rename docs/{ => user}/workshops/workshop-20231005.md (100%) diff --git a/docs/known-knowns/Known-Knowns.md b/docs/user/known-knowns/Known-Knowns.md similarity index 100% rename from docs/known-knowns/Known-Knowns.md rename to docs/user/known-knowns/Known-Knowns.md diff --git a/docs/workshops/README.md b/docs/user/workshops/README.md similarity index 79% rename from docs/workshops/README.md rename to docs/user/workshops/README.md index fa634991..b6946389 100644 --- a/docs/workshops/README.md +++ b/docs/user/workshops/README.md @@ -6,14 +6,14 @@ This repository contains resources and materials related to the workshops conduc This folder includes documentation and files for the following workshops: -1. **Portal IAM Workshop** - - Date: October 5, 2023 - - **Documentation Link**: [Portal IAM Workshop Documentation](workshop-20231005.md) - -2. **IAM Helm Chart Workshop** +1. **IAM Helm Chart Workshop** - Date: September 27, 2023 - **Documentation Link**: [IAM Helm Chart Workshop Documentation](workshop-20230927.md) +2. **User Token Lifespan Workshop** + - Date: October 5, 2023 + - **Documentation Link**: [User Token Lifespan Workshop Documentation](workshop-20231005.md) + ## NOTICE This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). diff --git a/docs/workshops/workshop-20230927.md b/docs/user/workshops/workshop-20230927.md similarity index 100% rename from docs/workshops/workshop-20230927.md rename to docs/user/workshops/workshop-20230927.md diff --git a/docs/workshops/workshop-20231005.md b/docs/user/workshops/workshop-20231005.md similarity index 100% rename from docs/workshops/workshop-20231005.md rename to docs/user/workshops/workshop-20231005.md From 9e3cc011224d196560e9461f75756dcd2e2fe986 Mon Sep 17 00:00:00 2001 From: "margi.shah1" Date: Tue, 15 Oct 2024 10:08:18 +0530 Subject: [PATCH 04/17] docs: add README.md file --- CHANGELOG.md | 4 +- docs/README.md | 69 +++++++++++++++++++++++++++++ docs/admin/portal-iam-helm-chart.md | 2 +- 3 files changed, 72 insertions(+), 3 deletions(-) create mode 100644 docs/README.md diff --git a/CHANGELOG.md b/CHANGELOG.md index a331a4b6..213de5a6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -40,7 +40,7 @@ New features, fixed bugs, known defects and other noteworthy changes to each rel The following issues were discovered: * 403 error when accessing the Partner Network in the Portal Frontend [#132](https://github.com/eclipse-tractusx/portal-iam/pull/132) -* Refresh token rotation causes page reload in frontend apps when using multiple tabs, see [User Token Lifespan](docs/workshops/workshop-20231005.md#user-token-lifespan) +* Refresh token rotation causes page reload in frontend apps when using multiple tabs, see [User Token Lifespan](docs/user/workshops/workshop-20231005.md#user-token-lifespan) * Custom login themes break when inserting HTML/CSS/JavaScript code in the IdP display name ## 3.0.0 @@ -431,7 +431,7 @@ sharedidp: The following issues were recently discovered: -* Refresh token rotation causes page reload in frontend apps when using multiple tabs, see [User Token Lifespan](docs/workshops/workshop-20231005.md#user-token-lifespan) +* Refresh token rotation causes page reload in frontend apps when using multiple tabs, see [User Token Lifespan](docs/user/workshops/workshop-20231005.md#user-token-lifespan) * Custom login themes break when inserting HTML/CSS/JavaScript code in the IdP display name ## 1.2.0 diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 00000000..fd5b534f --- /dev/null +++ b/docs/README.md @@ -0,0 +1,69 @@ +# Portal IAM Documentation + +This documentation provides a comprehensive overview of the **Portal IAM** system, covering various aspects such as architecture, user management, security, and deployment instructions. + +## 1. Introduction + +This repository contains the documentation for the **Portal IAM** platform, an Identity and Access Management (IAM) solution. The documentation is organized into the following sections to help users, administrators, and developers understand and work with the system effectively. + +## 2. Documentation Structure + +### [Technical Documentation](./admin/technical-documentation/) + +The `technical-documentation` folder includes the following guides and manuals: + +- [External Identity Provider](./admin/technical-documentation/00.%20External%20Identity%20Provider.md): Guide on integrating external identity providers. +- [Introduction](./admin/technical-documentation/01.%20Introduction.md): Overview of Portal IAM. +- [Generic Setup](./admin/technical-documentation/02.%20Generic%20Setup.md): Instructions on the basic setup. +- [User Management](./admin/technical-documentation/04.%20User%20Management.md): How to manage users within the Portal IAM. +- [Roles & Rights Concept](./admin/technical-documentation/06.%20Roles%20&%20Rights%20Concept.md): Overview of role-based access control. +- [Password Policy](./admin/technical-documentation/07.%20Password%20Policy.md): Password requirements and guidelines. +- [Email Configuration](./admin/technical-documentation/08.%20Email%20Configuration.md): Email server and notification configuration. +- [Event Logging](./admin/technical-documentation/09.%20Event%20Logging.md): How events and logs are managed. +- [Generic Security](./admin/technical-documentation/10.%20Generic%20Security.md): General security guidelines. +- [FAQ](./admin/technical-documentation/11.%20FAQ.md): Frequently asked questions. +- [Upgrade Details](./admin/technical-documentation/12.%20Upgrade%20Details.md): Information on system upgrades. +- [Operational Notes](./admin/technical-documentation/13.%20Operational%20Notes.md): Additional operational considerations. + +### [Workshops](./user/workshops/) + +The `workshops` folder includes practical resources for learning and deploying Portal IAM: + +- [Workshop 20230927](./user/workshops/workshop-20230927.md): Materials and steps covered during the September 27, 2023 workshop. +- [Workshop 20231005](./user/workshops/workshop-20231005.md): Materials and steps from the October 5, 2023 workshop. + +### [Architecture](./architecture/) + +The `architecture` folder includes high-level architectural details: + +- [Consultation Document](./architecture/consultation.md): Key architectural consultation notes and decisions. + +### [Known-Knowns](./user/known-knowns/) + +The `known-knowns` folder highlights known limitations, issues, or considerations regarding the Portal IAM: + +- [Known-Knowns](./user/known-knowns/Known-Knowns.md): A list of known issues and solutions. + +### [Charts](./admin/charts/) + +The `charts` folder contains Helm charts for deploying the Portal IAM system. Refer to the following for detailed usage: + +- [Portal IAM Helm Chart](./admin/portal-iam-helm-chart.md): Instructions on using the Helm chart for deploying Portal IAM on Kubernetes. + +### [Admin Documentation](./admin/) + +The `admin` folder includes documentation for system administrators: + +- [How to Contribute](./admin/dev-process/How%20to%20contribute.md): Steps for contributing to the project. + +### [Assets](./static/) + +The `static` folder contains assets used in the documentation. + +## 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: 2024 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-iam diff --git a/docs/admin/portal-iam-helm-chart.md b/docs/admin/portal-iam-helm-chart.md index fb64161c..bd4d1866 100644 --- a/docs/admin/portal-iam-helm-chart.md +++ b/docs/admin/portal-iam-helm-chart.md @@ -31,7 +31,7 @@ there is a [hook](./charts/portal-iam/templates/hooks/check-variable.yaml) creat The Helm Chart can be extended to add more detailed objects, but it was not part of this Proof of Concept. -The chart is implemented [here](../admin/charts/). +The chart is implemented [here](./charts/). ### How to use - Example of usage From 7be4815a8d8ae0904a8eda78203f2c0715e7298b Mon Sep 17 00:00:00 2001 From: "margi.shah1" Date: Tue, 15 Oct 2024 10:28:37 +0530 Subject: [PATCH 05/17] docs: add link to dev flow and release process file in README file --- docs/README.md | 17 +++++++++++++---- .../17. Dev Flow.md => dev-process/Dev Flow.md} | 0 .../Release Process.md} | 0 3 files changed, 13 insertions(+), 4 deletions(-) rename docs/admin/{technical-documentation/17. Dev Flow.md => dev-process/Dev Flow.md} (100%) rename docs/admin/{technical-documentation/18. Release Process.md => release-process/Release Process.md} (100%) diff --git a/docs/README.md b/docs/README.md index fd5b534f..c4938c43 100644 --- a/docs/README.md +++ b/docs/README.md @@ -44,18 +44,27 @@ The `known-knowns` folder highlights known limitations, issues, or consideration - [Known-Knowns](./user/known-knowns/Known-Knowns.md): A list of known issues and solutions. -### [Charts](./admin/charts/) + +### [Admin Documentation](./admin/) + +The `admin` folder includes documentation for system administrators: + +### 1. [Charts](./admin/charts/) The `charts` folder contains Helm charts for deploying the Portal IAM system. Refer to the following for detailed usage: - [Portal IAM Helm Chart](./admin/portal-iam-helm-chart.md): Instructions on using the Helm chart for deploying Portal IAM on Kubernetes. -### [Admin Documentation](./admin/) - -The `admin` folder includes documentation for system administrators: +### 2. [Developer Process](./admin/dev-process/) +- [Dev Flow](./dev-process/dev-flow.md): This document outlines the development flow, using a git-based diagram to show the process of feature development, bug fixes, and release candidates. - [How to Contribute](./admin/dev-process/How%20to%20contribute.md): Steps for contributing to the project. + +### 3. [Release Process](./admin/release-process/) + +- [Release Process](./release-process/release-process.md) : This document explains the release process, detailing steps from creating a release branch, updating versions, and generating changelogs to merging release candidates into the main branch. It follows semantic versioning practices and provides links to automated workflows used in the release cycle. + ### [Assets](./static/) The `static` folder contains assets used in the documentation. diff --git a/docs/admin/technical-documentation/17. Dev Flow.md b/docs/admin/dev-process/Dev Flow.md similarity index 100% rename from docs/admin/technical-documentation/17. Dev Flow.md rename to docs/admin/dev-process/Dev Flow.md diff --git a/docs/admin/technical-documentation/18. Release Process.md b/docs/admin/release-process/Release Process.md similarity index 100% rename from docs/admin/technical-documentation/18. Release Process.md rename to docs/admin/release-process/Release Process.md From 36850107b0ff5bd9c8634612bbfc83aac6a34e21 Mon Sep 17 00:00:00 2001 From: "margi.shah1" Date: Tue, 15 Oct 2024 10:37:02 +0530 Subject: [PATCH 06/17] docs: change path to known-known file in README file --- README.md | 2 +- charts/sharedidp/README.md.gotmpl | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a7732bff..70ced0b7 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ For further information please refer to the chart specific README files, availab ## Known Issues and Limitations -See [Known Knowns](/docs/known-knowns/Known-Knowns.md). +See [Known Knowns](/docs/user/known-knowns/Known-Knowns.md). ## Notice for Docker images diff --git a/charts/sharedidp/README.md.gotmpl b/charts/sharedidp/README.md.gotmpl index ee34b6ce..4552e33d 100644 --- a/charts/sharedidp/README.md.gotmpl +++ b/charts/sharedidp/README.md.gotmpl @@ -4,7 +4,7 @@ This helm chart installs the {{ template "chart.description" . }}. -For further information please refer to the [technical documentation](../../docs/admin/technical-documentation6). +For further information please refer to the [technical documentation](../../docs/admin/technical-documentation). The referenced container images are for demonstration purposes only. From d2d33ad52176664a55e3baa2ab351a7dd6803c0e Mon Sep 17 00:00:00 2001 From: "margi.shah1" Date: Tue, 15 Oct 2024 10:57:29 +0530 Subject: [PATCH 07/17] chore: update path of reference doc in release process.md --- docs/admin/release-process/Release Process.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/admin/release-process/Release Process.md b/docs/admin/release-process/Release Process.md index 150a7025..eca79616 100644 --- a/docs/admin/release-process/Release Process.md +++ b/docs/admin/release-process/Release Process.md @@ -11,7 +11,7 @@ The release process for a new version can roughly be divided into the following - [RC: provide successive rc branch and change base of open PRs](#rc-provide-successive-rc-branch-and-change-base-of-open-prs) - [NOTICE](#notice) -The process builds on the [Development Flow](./17.%20Dev%20Flow.md) which, usually, takes place within forks and leads to merged pull requests in the repositories of the eclipse-tractusx organization. +The process builds on the [Development Flow](../dev-process/Dev%20Flow.md) which, usually, takes place within forks and leads to merged pull requests in the repositories of the eclipse-tractusx organization. For assigning and incrementing **version** numbers [Semantic Versioning](https://semver.org) is followed. @@ -24,15 +24,15 @@ On the release branch the following steps are executed: Bump the chart and app version in the `Chart.yaml` files. -- [centralidp/Chart.yaml](../../charts/centralidp/Chart.yaml) -- [sharedidp/Chart.yaml](../../charts/sharedidp/Chart.yaml) +- [centralidp/Chart.yaml](/charts/centralidp/Chart.yaml) +- [sharedidp/Chart.yaml](/charts/sharedidp/Chart.yaml) And bump the version of the images for the init container and realm seeding job in the `values.yaml` files: -- [centralidp/values.yaml](../../charts/centralidp/values.yaml) -- [sharedidp/values.yaml](../../charts/sharedidp/values.yaml) +- [centralidp/values.yaml](/charts/centralidp/values.yaml) +- [sharedidp/values.yaml](/charts/sharedidp/values.yaml) -_environment relevant: Update the version of the targetRevision tag in the [argocd-app-templates](../../environments/argocd-app-templates/), used for hosted environments._ +_environment relevant: Update the version of the targetRevision tag in the [argocd-app-templates](/environments/argocd-app-templates/), used for hosted environments._ Example for commit message: @@ -53,7 +53,7 @@ _build: update readme for vx.x.x_ ## Update CHANGELOG.md The changelog file tracks all notable changes since the last released version. -Once a new version is ready to be released, the changelog can get updated via an automatically created pull request using the [release-please workflow](../../.github/workflows/release-please.yml) which can be triggered manually or by pushing a _changelog/v*.*.*_ branch. +Once a new version is ready to be released, the changelog can get updated via an automatically created pull request using the [release-please workflow](/.github/workflows/release-please.yml) which can be triggered manually or by pushing a _changelog/v*.*.*_ branch. Please see: @@ -70,7 +70,7 @@ Example for PR titles: _build(1.2.0): merge release into main_ -> Be aware that the merge into main triggers the workflow with the [helm chart releaser action](../../.github/workflows/release.yaml). +> Be aware that the merge into main triggers the workflow with the [helm chart releaser action](/.github/workflows/release.yaml). > > The workflow creates a 'centralidp-x.x.x' and 'sharedidp-x.x.x' tags and according releases. The release contains the new chart. > From 6efc92a00b3daf4fb72421295fb76fc24280b89f Mon Sep 17 00:00:00 2001 From: "margi.shah1" Date: Tue, 15 Oct 2024 11:56:58 +0530 Subject: [PATCH 08/17] chore: update path of files --- charts/centralidp/README.md | 6 +++--- charts/centralidp/README.md.gotmpl | 4 ++-- charts/sharedidp/README.md | 2 +- charts/sharedidp/README.md.gotmpl | 2 +- docs/admin/dev-process/How to contribute.md | 2 +- docs/admin/release-process/Release Process.md | 2 +- docs/admin/technical-documentation/11. FAQ.md | 4 ++-- 7 files changed, 11 insertions(+), 11 deletions(-) diff --git a/charts/centralidp/README.md b/charts/centralidp/README.md index b3e4793e..88bcf5f3 100644 --- a/charts/centralidp/README.md +++ b/charts/centralidp/README.md @@ -4,7 +4,7 @@ This helm chart installs the Helm chart for Central Keycloak Instance. -For further information please refer to the [technical documentation](../../docs/admin/technical-documentation/). +For further information please refer to the [technical documentation](/docs/admin/technical-documentation/). The referenced container images are for demonstration purposes only. @@ -152,14 +152,14 @@ No specific upgrade notes. This major changes from the Keycloak version from 16.1.1 to version 22.0.3. -Please have a look at the [CHANGELOG](../../CHANGELOG.md#200) for a more detailed description. +Please have a look at the [CHANGELOG](/CHANGELOG.md#200) for a more detailed description. We also recommend checking out the [Keycloak Upgrading Guide](https://www.keycloak.org/docs/latest/upgrading/index.html). To be explicitly mentioned: this major adds the production mode with default value false and the reverse proxy mode with default value passthrough. Please check the description of those parameters and decide if they're suitable for you. -Please also refer to [Upgrade Details](../../docs/admin/technical-documentation/12.%20Upgrade%20Details.md#v200). +Please also refer to [Upgrade Details](/docs/admin/technical-documentation/12.%20Upgrade%20Details.md#v200). #### Upgrade approach diff --git a/charts/centralidp/README.md.gotmpl b/charts/centralidp/README.md.gotmpl index ec391353..bd619f26 100644 --- a/charts/centralidp/README.md.gotmpl +++ b/charts/centralidp/README.md.gotmpl @@ -4,7 +4,7 @@ This helm chart installs the {{ template "chart.description" . }}. -For further information please refer to the [technical documentation](../../docs/admin/technical-documentation). +For further information please refer to the [technical documentation](/docs/admin/technical-documentation). The referenced container images are for demonstration purposes only. @@ -84,7 +84,7 @@ We also recommend checking out the [Keycloak Upgrading Guide](https://www.keyclo To be explicitly mentioned: this major adds the production mode with default value false and the reverse proxy mode with default value passthrough. Please check the description of those parameters and decide if they're suitable for you. -Please also refer to [Upgrade Details](../../docs/admin/technical-documentation/12.%20Upgrade%20Details.md#v200). +Please also refer to [Upgrade Details](/docs/admin/technical-documentation/12.%20Upgrade%20Details.md#v200). #### Upgrade approach diff --git a/charts/sharedidp/README.md b/charts/sharedidp/README.md index 876caec8..c16f77fa 100644 --- a/charts/sharedidp/README.md +++ b/charts/sharedidp/README.md @@ -4,7 +4,7 @@ This helm chart installs the Helm chart for Shared Keycloak Instance. -For further information please refer to the [technical documentation](../../docs/admin/technical-documentation/). +For further information please refer to the [technical documentation](/docs/admin/technical-documentation/). The referenced container images are for demonstration purposes only. diff --git a/charts/sharedidp/README.md.gotmpl b/charts/sharedidp/README.md.gotmpl index 4552e33d..6cabbb77 100644 --- a/charts/sharedidp/README.md.gotmpl +++ b/charts/sharedidp/README.md.gotmpl @@ -4,7 +4,7 @@ This helm chart installs the {{ template "chart.description" . }}. -For further information please refer to the [technical documentation](../../docs/admin/technical-documentation). +For further information please refer to the [technical documentation](/docs/admin/technical-documentation). The referenced container images are for demonstration purposes only. diff --git a/docs/admin/dev-process/How to contribute.md b/docs/admin/dev-process/How to contribute.md index 3fa8f39e..246657c3 100644 --- a/docs/admin/dev-process/How to contribute.md +++ b/docs/admin/dev-process/How to contribute.md @@ -98,7 +98,7 @@ What was changed, why was it changed (e.g. which issue was fixed or which requir ### Additional information -Please refer to the [Development Flow](./17.%20Dev%20Flow.md). +Please refer to the [Development Flow](./Dev%20Flow.md). ## NOTICE diff --git a/docs/admin/release-process/Release Process.md b/docs/admin/release-process/Release Process.md index eca79616..5a042275 100644 --- a/docs/admin/release-process/Release Process.md +++ b/docs/admin/release-process/Release Process.md @@ -74,7 +74,7 @@ _build(1.2.0): merge release into main_ > > The workflow creates a 'centralidp-x.x.x' and 'sharedidp-x.x.x' tags and according releases. The release contains the new chart. > -> This workflow also pushes the version tag that triggers the [release workflow](../../.github/workflows/release.yaml) which creates the versioned docker image/s. +> This workflow also pushes the version tag that triggers the [release workflow](/.github/workflows/release.yaml) which creates the versioned docker image/s. _environment relevant: The 'vx.x.x' tag is used to install (with the convenience of the argocd-app-templates) or upgrade the version via AgroCD on the hosted K8s clusters._ diff --git a/docs/admin/technical-documentation/11. FAQ.md b/docs/admin/technical-documentation/11. FAQ.md index 63a399c4..99dfd6e1 100644 --- a/docs/admin/technical-documentation/11. FAQ.md +++ b/docs/admin/technical-documentation/11. FAQ.md @@ -79,7 +79,7 @@ To transform the created "role" to an actual role, since currently its a single 3. Update keycloak base image -The [CX-Central realm file](../../../import/realm-config/generic/catenax-central/CX-Central-realm.json) needs to be updated with role changes (export from Keycloak) to provide the configuration in the init container for the realm import and seeding. +The [CX-Central realm file](/import/realm-config/generic/catenax-central/CX-Central-realm.json) needs to be updated with role changes (export from Keycloak) to provide the configuration in the init container for the realm import and seeding. 4. Update documentation @@ -130,7 +130,7 @@ For the scenario of sql, the relevant sql can get found below: 3. Update Keycloak base image -The [CX-Central realm file](../../../import/realm-config/generic/catenax-central/CX-Central-realm.json) needs to be updated with role changes (export from Keycloak) to provide the configuration in the init container for the realm import and seeding. +The [CX-Central realm file](/import/realm-config/generic/catenax-central/CX-Central-realm.json) needs to be updated with role changes (export from Keycloak) to provide the configuration in the init container for the realm import and seeding. 4. Update documentation From cde435df92d3ef4dc912da45ec3299c13fadd896 Mon Sep 17 00:00:00 2001 From: "margi.shah1" Date: Fri, 18 Oct 2024 11:58:34 +0530 Subject: [PATCH 09/17] docs: update protal-iam-hel-chart.md file path in workshop file --- docs/user/workshops/workshop-20231005.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user/workshops/workshop-20231005.md b/docs/user/workshops/workshop-20231005.md index bf371008..fabbd9de 100644 --- a/docs/user/workshops/workshop-20231005.md +++ b/docs/user/workshops/workshop-20231005.md @@ -61,7 +61,7 @@ Again, there are no-recommended values (only default ones). The final values wil ## One IAM Helm chart: POC -This topic is described in [this file](portal-iam-helm-chart.md). +This topic is described in [this file](/docs/admin/portal-iam-helm-chart.md). ## Hands on Blue/Green Deployment from v16.1.1 to v22.0.3 with prepared instances From 8b0a41b92d55659c40b049f1397c05ac7795229c Mon Sep 17 00:00:00 2001 From: "margi.shah1" Date: Fri, 25 Oct 2024 10:04:30 +0530 Subject: [PATCH 10/17] chore: exclude .yaml file inside docs folder in sonarcloud analysis --- .sonarcloud copy.properties | 1 + 1 file changed, 1 insertion(+) create mode 100644 .sonarcloud copy.properties diff --git a/.sonarcloud copy.properties b/.sonarcloud copy.properties new file mode 100644 index 00000000..ed03b039 --- /dev/null +++ b/.sonarcloud copy.properties @@ -0,0 +1 @@ +sonar.exclusions = docs/**/*.yaml \ No newline at end of file From 83f74db414c86dbbf75946aa84aa02ff01026aa5 Mon Sep 17 00:00:00 2001 From: "margi.shah1" Date: Mon, 28 Oct 2024 11:04:26 +0530 Subject: [PATCH 11/17] chore: exclude .yaml file inside docs folder in sonarcloud analysis --- .sonarcloud copy.properties | 1 - .sonarcloud.properties | 3 ++- 2 files changed, 2 insertions(+), 2 deletions(-) delete mode 100644 .sonarcloud copy.properties diff --git a/.sonarcloud copy.properties b/.sonarcloud copy.properties deleted file mode 100644 index ed03b039..00000000 --- a/.sonarcloud copy.properties +++ /dev/null @@ -1 +0,0 @@ -sonar.exclusions = docs/**/*.yaml \ No newline at end of file diff --git a/.sonarcloud.properties b/.sonarcloud.properties index 71f3f8cf..e9211228 100644 --- a/.sonarcloud.properties +++ b/.sonarcloud.properties @@ -1 +1,2 @@ -sonar.cpd.exclusions = import/keycloak-themes/**/*.* \ No newline at end of file +sonar.cpd.exclusions = import/keycloak-themes/**/*.* +sonar.exclusions = docs/**/*.yaml \ No newline at end of file From a6cdf6c5d8c4912a38d243425522d1e35787e7db Mon Sep 17 00:00:00 2001 From: "margi.shah1" Date: Thu, 7 Nov 2024 10:04:42 +0530 Subject: [PATCH 12/17] docs: restructure workshop and charts, environment folder --- docs/{user => admin}/known-knowns/Known-Knowns.md | 0 docs/{admin => consultation}/charts/portal-iam/.helmignore | 0 docs/{admin => consultation}/charts/portal-iam/Chart.yaml | 0 docs/{admin => consultation}/charts/portal-iam/LICENSE | 0 .../charts/portal-iam/templates/_helpers.tpl | 0 .../charts/portal-iam/templates/hooks/check-variable.yaml | 0 .../charts/portal-iam/templates/hooks/seeding-job.yaml | 0 .../charts/portal-iam/templates/secret-external-db.yaml | 0 .../charts/portal-iam/templates/secret-instancetype.yaml | 0 .../charts/portal-iam/templates/secret-kc-admin.yaml | 0 docs/{admin => consultation}/charts/portal-iam/values.yaml | 0 docs/{architecture => consultation}/consultation.md | 0 .../environments/centralidp/blue/kc-central-blue-values.yaml | 0 .../centralidp/blue/postgresql-db-central-blue-statefulset.yaml | 0 .../environments/sharedidp/blue/kc-shared-blue-values.yaml | 0 .../sharedidp/blue/postgresql-db-shared-blue-statefulset.yaml | 0 docs/{admin => consultation}/portal-iam-helm-chart.md | 0 docs/{user => consultation}/workshops/README.md | 0 docs/{user => consultation}/workshops/workshop-20230927.md | 0 docs/{user => consultation}/workshops/workshop-20231005.md | 0 20 files changed, 0 insertions(+), 0 deletions(-) rename docs/{user => admin}/known-knowns/Known-Knowns.md (100%) rename docs/{admin => consultation}/charts/portal-iam/.helmignore (100%) rename docs/{admin => consultation}/charts/portal-iam/Chart.yaml (100%) rename docs/{admin => consultation}/charts/portal-iam/LICENSE (100%) rename docs/{admin => consultation}/charts/portal-iam/templates/_helpers.tpl (100%) rename docs/{admin => consultation}/charts/portal-iam/templates/hooks/check-variable.yaml (100%) rename docs/{admin => consultation}/charts/portal-iam/templates/hooks/seeding-job.yaml (100%) rename docs/{admin => consultation}/charts/portal-iam/templates/secret-external-db.yaml (100%) rename docs/{admin => consultation}/charts/portal-iam/templates/secret-instancetype.yaml (100%) rename docs/{admin => consultation}/charts/portal-iam/templates/secret-kc-admin.yaml (100%) rename docs/{admin => consultation}/charts/portal-iam/values.yaml (100%) rename docs/{architecture => consultation}/consultation.md (100%) rename docs/{admin => consultation}/environments/centralidp/blue/kc-central-blue-values.yaml (100%) rename docs/{admin => consultation}/environments/centralidp/blue/postgresql-db-central-blue-statefulset.yaml (100%) rename docs/{admin => consultation}/environments/sharedidp/blue/kc-shared-blue-values.yaml (100%) rename docs/{admin => consultation}/environments/sharedidp/blue/postgresql-db-shared-blue-statefulset.yaml (100%) rename docs/{admin => consultation}/portal-iam-helm-chart.md (100%) rename docs/{user => consultation}/workshops/README.md (100%) rename docs/{user => consultation}/workshops/workshop-20230927.md (100%) rename docs/{user => consultation}/workshops/workshop-20231005.md (100%) diff --git a/docs/user/known-knowns/Known-Knowns.md b/docs/admin/known-knowns/Known-Knowns.md similarity index 100% rename from docs/user/known-knowns/Known-Knowns.md rename to docs/admin/known-knowns/Known-Knowns.md diff --git a/docs/admin/charts/portal-iam/.helmignore b/docs/consultation/charts/portal-iam/.helmignore similarity index 100% rename from docs/admin/charts/portal-iam/.helmignore rename to docs/consultation/charts/portal-iam/.helmignore diff --git a/docs/admin/charts/portal-iam/Chart.yaml b/docs/consultation/charts/portal-iam/Chart.yaml similarity index 100% rename from docs/admin/charts/portal-iam/Chart.yaml rename to docs/consultation/charts/portal-iam/Chart.yaml diff --git a/docs/admin/charts/portal-iam/LICENSE b/docs/consultation/charts/portal-iam/LICENSE similarity index 100% rename from docs/admin/charts/portal-iam/LICENSE rename to docs/consultation/charts/portal-iam/LICENSE diff --git a/docs/admin/charts/portal-iam/templates/_helpers.tpl b/docs/consultation/charts/portal-iam/templates/_helpers.tpl similarity index 100% rename from docs/admin/charts/portal-iam/templates/_helpers.tpl rename to docs/consultation/charts/portal-iam/templates/_helpers.tpl diff --git a/docs/admin/charts/portal-iam/templates/hooks/check-variable.yaml b/docs/consultation/charts/portal-iam/templates/hooks/check-variable.yaml similarity index 100% rename from docs/admin/charts/portal-iam/templates/hooks/check-variable.yaml rename to docs/consultation/charts/portal-iam/templates/hooks/check-variable.yaml diff --git a/docs/admin/charts/portal-iam/templates/hooks/seeding-job.yaml b/docs/consultation/charts/portal-iam/templates/hooks/seeding-job.yaml similarity index 100% rename from docs/admin/charts/portal-iam/templates/hooks/seeding-job.yaml rename to docs/consultation/charts/portal-iam/templates/hooks/seeding-job.yaml diff --git a/docs/admin/charts/portal-iam/templates/secret-external-db.yaml b/docs/consultation/charts/portal-iam/templates/secret-external-db.yaml similarity index 100% rename from docs/admin/charts/portal-iam/templates/secret-external-db.yaml rename to docs/consultation/charts/portal-iam/templates/secret-external-db.yaml diff --git a/docs/admin/charts/portal-iam/templates/secret-instancetype.yaml b/docs/consultation/charts/portal-iam/templates/secret-instancetype.yaml similarity index 100% rename from docs/admin/charts/portal-iam/templates/secret-instancetype.yaml rename to docs/consultation/charts/portal-iam/templates/secret-instancetype.yaml diff --git a/docs/admin/charts/portal-iam/templates/secret-kc-admin.yaml b/docs/consultation/charts/portal-iam/templates/secret-kc-admin.yaml similarity index 100% rename from docs/admin/charts/portal-iam/templates/secret-kc-admin.yaml rename to docs/consultation/charts/portal-iam/templates/secret-kc-admin.yaml diff --git a/docs/admin/charts/portal-iam/values.yaml b/docs/consultation/charts/portal-iam/values.yaml similarity index 100% rename from docs/admin/charts/portal-iam/values.yaml rename to docs/consultation/charts/portal-iam/values.yaml diff --git a/docs/architecture/consultation.md b/docs/consultation/consultation.md similarity index 100% rename from docs/architecture/consultation.md rename to docs/consultation/consultation.md diff --git a/docs/admin/environments/centralidp/blue/kc-central-blue-values.yaml b/docs/consultation/environments/centralidp/blue/kc-central-blue-values.yaml similarity index 100% rename from docs/admin/environments/centralidp/blue/kc-central-blue-values.yaml rename to docs/consultation/environments/centralidp/blue/kc-central-blue-values.yaml diff --git a/docs/admin/environments/centralidp/blue/postgresql-db-central-blue-statefulset.yaml b/docs/consultation/environments/centralidp/blue/postgresql-db-central-blue-statefulset.yaml similarity index 100% rename from docs/admin/environments/centralidp/blue/postgresql-db-central-blue-statefulset.yaml rename to docs/consultation/environments/centralidp/blue/postgresql-db-central-blue-statefulset.yaml diff --git a/docs/admin/environments/sharedidp/blue/kc-shared-blue-values.yaml b/docs/consultation/environments/sharedidp/blue/kc-shared-blue-values.yaml similarity index 100% rename from docs/admin/environments/sharedidp/blue/kc-shared-blue-values.yaml rename to docs/consultation/environments/sharedidp/blue/kc-shared-blue-values.yaml diff --git a/docs/admin/environments/sharedidp/blue/postgresql-db-shared-blue-statefulset.yaml b/docs/consultation/environments/sharedidp/blue/postgresql-db-shared-blue-statefulset.yaml similarity index 100% rename from docs/admin/environments/sharedidp/blue/postgresql-db-shared-blue-statefulset.yaml rename to docs/consultation/environments/sharedidp/blue/postgresql-db-shared-blue-statefulset.yaml diff --git a/docs/admin/portal-iam-helm-chart.md b/docs/consultation/portal-iam-helm-chart.md similarity index 100% rename from docs/admin/portal-iam-helm-chart.md rename to docs/consultation/portal-iam-helm-chart.md diff --git a/docs/user/workshops/README.md b/docs/consultation/workshops/README.md similarity index 100% rename from docs/user/workshops/README.md rename to docs/consultation/workshops/README.md diff --git a/docs/user/workshops/workshop-20230927.md b/docs/consultation/workshops/workshop-20230927.md similarity index 100% rename from docs/user/workshops/workshop-20230927.md rename to docs/consultation/workshops/workshop-20230927.md diff --git a/docs/user/workshops/workshop-20231005.md b/docs/consultation/workshops/workshop-20231005.md similarity index 100% rename from docs/user/workshops/workshop-20231005.md rename to docs/consultation/workshops/workshop-20231005.md From 1d8ca4d08b7b303888428b58c4031c87c9364976 Mon Sep 17 00:00:00 2001 From: "margi.shah1" Date: Thu, 7 Nov 2024 10:50:38 +0530 Subject: [PATCH 13/17] docs: update document path --- CHANGELOG.md | 4 +- README.md | 2 +- docs/README.md | 44 +++++++++---------- docs/admin/known-knowns/Known-Knowns.md | 2 +- .../workshops/workshop-20231005.md | 2 +- 5 files changed, 26 insertions(+), 28 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 11aeb202..a58a4d29 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -57,7 +57,7 @@ New features, fixed bugs, known defects and other noteworthy changes to each rel The following issues were discovered: * 403 error when accessing the Partner Network in the Portal Frontend [#132](https://github.com/eclipse-tractusx/portal-iam/pull/132) -* Refresh token rotation causes page reload in frontend apps when using multiple tabs, see [User Token Lifespan](docs/user/workshops/workshop-20231005.md#user-token-lifespan) +* Refresh token rotation causes page reload in frontend apps when using multiple tabs, see [User Token Lifespan](docs/consultation/workshops/workshop-20231005.md#user-token-lifespan) * Custom login themes break when inserting HTML/CSS/JavaScript code in the IdP display name ## 3.0.0 @@ -448,7 +448,7 @@ sharedidp: The following issues were recently discovered: -* Refresh token rotation causes page reload in frontend apps when using multiple tabs, see [User Token Lifespan](docs/user/workshops/workshop-20231005.md#user-token-lifespan) +* Refresh token rotation causes page reload in frontend apps when using multiple tabs, see [User Token Lifespan](docs/consultation/workshops/workshop-20231005.md#user-token-lifespan) * Custom login themes break when inserting HTML/CSS/JavaScript code in the IdP display name ## 1.2.0 diff --git a/README.md b/README.md index 70ced0b7..b48679f1 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ For further information please refer to the chart specific README files, availab ## Known Issues and Limitations -See [Known Knowns](/docs/user/known-knowns/Known-Knowns.md). +See [Known Knowns](/docs/admin/known-knowns/Known-Knowns.md). ## Notice for Docker images diff --git a/docs/README.md b/docs/README.md index c4938c43..cf0f5bfc 100644 --- a/docs/README.md +++ b/docs/README.md @@ -8,7 +8,11 @@ This repository contains the documentation for the **Portal IAM** platform, an I ## 2. Documentation Structure -### [Technical Documentation](./admin/technical-documentation/) +### [Admin Documentation](./admin/) + +The `admin` folder includes documentation for system administrators: + +### 1. [Technical Documentation](./admin/technical-documentation/) The `technical-documentation` folder includes the following guides and manuals: @@ -25,45 +29,39 @@ The `technical-documentation` folder includes the following guides and manuals: - [Upgrade Details](./admin/technical-documentation/12.%20Upgrade%20Details.md): Information on system upgrades. - [Operational Notes](./admin/technical-documentation/13.%20Operational%20Notes.md): Additional operational considerations. -### [Workshops](./user/workshops/) - -The `workshops` folder includes practical resources for learning and deploying Portal IAM: +### 2. [Developer Process](./admin/dev-process/) -- [Workshop 20230927](./user/workshops/workshop-20230927.md): Materials and steps covered during the September 27, 2023 workshop. -- [Workshop 20231005](./user/workshops/workshop-20231005.md): Materials and steps from the October 5, 2023 workshop. +- [Dev Flow](./dev-process/dev-flow.md): This document outlines the development flow, using a git-based diagram to show the process of feature development, bug fixes, and release candidates. +- [How to Contribute](./admin/dev-process/How%20to%20contribute.md): Steps for contributing to the project. -### [Architecture](./architecture/) +### 3. [Release Process](./admin/release-process/) -The `architecture` folder includes high-level architectural details: +- [Release Process](./release-process/release-process.md) : This document explains the release process, detailing steps from creating a release branch, updating versions, and generating changelogs to merging release candidates into the main branch. It follows semantic versioning practices and provides links to automated workflows used in the release cycle. -- [Consultation Document](./architecture/consultation.md): Key architectural consultation notes and decisions. - -### [Known-Knowns](./user/known-knowns/) +### 4. [Known-Knowns](./admin/known-knowns/) The `known-knowns` folder highlights known limitations, issues, or considerations regarding the Portal IAM: -- [Known-Knowns](./user/known-knowns/Known-Knowns.md): A list of known issues and solutions. +- [Known-Knowns](./admin/known-knowns/Known-Knowns.md): A list of known issues and solutions. +### [Consultation Documentation](./consultation/) -### [Admin Documentation](./admin/) - -The `admin` folder includes documentation for system administrators: - -### 1. [Charts](./admin/charts/) +### 1. [Charts](./consultation/charts/) The `charts` folder contains Helm charts for deploying the Portal IAM system. Refer to the following for detailed usage: -- [Portal IAM Helm Chart](./admin/portal-iam-helm-chart.md): Instructions on using the Helm chart for deploying Portal IAM on Kubernetes. +- [Portal IAM Helm Chart](./consultation/portal-iam-helm-chart.md): Instructions on using the Helm chart for deploying Portal IAM on Kubernetes. -### 2. [Developer Process](./admin/dev-process/) +### 2. [Workshops](./consultation/workshops/) -- [Dev Flow](./dev-process/dev-flow.md): This document outlines the development flow, using a git-based diagram to show the process of feature development, bug fixes, and release candidates. -- [How to Contribute](./admin/dev-process/How%20to%20contribute.md): Steps for contributing to the project. +The `workshops` folder includes practical resources for learning and deploying Portal IAM: +- [Workshop 20230927](./consultation/workshops/workshop-20230927.md): Materials and steps covered during the September 27, 2023 workshop. +- [Workshop 20231005](./consultation/workshops/workshop-20231005.md): Materials and steps from the October 5, 2023 workshop. -### 3. [Release Process](./admin/release-process/) -- [Release Process](./release-process/release-process.md) : This document explains the release process, detailing steps from creating a release branch, updating versions, and generating changelogs to merging release candidates into the main branch. It follows semantic versioning practices and provides links to automated workflows used in the release cycle. +### 3. - [Consultation Document](./consultation/consultation.md): Key architectural consultation notes and decisions. + ### [Assets](./static/) diff --git a/docs/admin/known-knowns/Known-Knowns.md b/docs/admin/known-knowns/Known-Knowns.md index 415dc1cd..7f567a90 100644 --- a/docs/admin/known-knowns/Known-Knowns.md +++ b/docs/admin/known-knowns/Known-Knowns.md @@ -1,6 +1,6 @@ # Known Issues and Limitations -- Refresh token rotation causes page reload in frontend apps when using multiple tabs, see [User Token Lifespan](../workshops/workshop-20231005.md#user-token-lifespan) +- Refresh token rotation causes page reload in frontend apps when using multiple tabs, see [User Token Lifespan](/docs/consultation/workshops/workshop-20231005.md#user-token-lifespan) - Custom login themes break when inserting HTML/CSS/JavaScript code in the IdP display name ## NOTICE diff --git a/docs/consultation/workshops/workshop-20231005.md b/docs/consultation/workshops/workshop-20231005.md index fabbd9de..c9b9be03 100644 --- a/docs/consultation/workshops/workshop-20231005.md +++ b/docs/consultation/workshops/workshop-20231005.md @@ -61,7 +61,7 @@ Again, there are no-recommended values (only default ones). The final values wil ## One IAM Helm chart: POC -This topic is described in [this file](/docs/admin/portal-iam-helm-chart.md). +This topic is described in [this file](../portal-iam-helm-chart.md). ## Hands on Blue/Green Deployment from v16.1.1 to v22.0.3 with prepared instances From 582f881b31d6d55d6e6f934b0f8de0385b23e3cd Mon Sep 17 00:00:00 2001 From: "margi.shah1" Date: Thu, 7 Nov 2024 11:23:39 +0530 Subject: [PATCH 14/17] docs: update document path --- docs/README.md | 7 ++++--- .../{04 User Management.md => 04. User Management.md} | 0 docs/admin/technical-documentation/11. FAQ.md | 2 +- 3 files changed, 5 insertions(+), 4 deletions(-) rename docs/admin/technical-documentation/{04 User Management.md => 04. User Management.md} (100%) diff --git a/docs/README.md b/docs/README.md index cf0f5bfc..57649de0 100644 --- a/docs/README.md +++ b/docs/README.md @@ -31,12 +31,12 @@ The `technical-documentation` folder includes the following guides and manuals: ### 2. [Developer Process](./admin/dev-process/) -- [Dev Flow](./dev-process/dev-flow.md): This document outlines the development flow, using a git-based diagram to show the process of feature development, bug fixes, and release candidates. +- [Dev Flow](./admin/dev-process/Dev%20Flow.md): This document outlines the development flow, using a git-based diagram to show the process of feature development, bug fixes, and release candidates. - [How to Contribute](./admin/dev-process/How%20to%20contribute.md): Steps for contributing to the project. ### 3. [Release Process](./admin/release-process/) -- [Release Process](./release-process/release-process.md) : This document explains the release process, detailing steps from creating a release branch, updating versions, and generating changelogs to merging release candidates into the main branch. It follows semantic versioning practices and provides links to automated workflows used in the release cycle. +- [Release Process](./admin/release-process/Release%20Process.md) : This document explains the release process, detailing steps from creating a release branch, updating versions, and generating changelogs to merging release candidates into the main branch. It follows semantic versioning practices and provides links to automated workflows used in the release cycle. ### 4. [Known-Knowns](./admin/known-knowns/) @@ -60,7 +60,8 @@ The `workshops` folder includes practical resources for learning and deploying P - [Workshop 20231005](./consultation/workshops/workshop-20231005.md): Materials and steps from the October 5, 2023 workshop. -### 3. - [Consultation Document](./consultation/consultation.md): Key architectural consultation notes and decisions. +### 3. [Consultation Document](./consultation/consultation.md) +- Key architectural consultation notes and decisions. ### [Assets](./static/) diff --git a/docs/admin/technical-documentation/04 User Management.md b/docs/admin/technical-documentation/04. User Management.md similarity index 100% rename from docs/admin/technical-documentation/04 User Management.md rename to docs/admin/technical-documentation/04. User Management.md diff --git a/docs/admin/technical-documentation/11. FAQ.md b/docs/admin/technical-documentation/11. FAQ.md index 99dfd6e1..aa61a58f 100644 --- a/docs/admin/technical-documentation/11. FAQ.md +++ b/docs/admin/technical-documentation/11. FAQ.md @@ -137,7 +137,7 @@ The [CX-Central realm file](/import/realm-config/generic/catenax-central/CX-Cent - [Roles&Rights Matrix](/docs/admin/technical-documentation/06.%20Roles%20&%20Rights%20Concept.md#253b-technical-user-accounts) - [Technical User Creation - End User documentation](https://github.com/eclipse-tractusx/portal-assets/blob/main/docs/user/03.%20User%20Management/03.%20Technical%20User/02.%20Create%20Technical%20User.md#available-technical-user-roles) -- [User Management](/docs/admin/technical-documentation/04%20User%20Management.md) +- [User Management](/docs/admin/technical-documentation/04.%20User%20Management.md) ## What is the difference between roles & permission From 9af91f906de6f6f8710032dc146bee6ad3d2cc27 Mon Sep 17 00:00:00 2001 From: shahmargi12 <124675506+shahmargi12@users.noreply.github.com> Date: Thu, 7 Nov 2024 14:30:17 +0530 Subject: [PATCH 15/17] docs: update docs/README.md Co-authored-by: Evelyn Gurschler --- docs/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/README.md b/docs/README.md index 57649de0..27100826 100644 --- a/docs/README.md +++ b/docs/README.md @@ -54,10 +54,10 @@ The `charts` folder contains Helm charts for deploying the Portal IAM system. Re ### 2. [Workshops](./consultation/workshops/) -The `workshops` folder includes practical resources for learning and deploying Portal IAM: +The `workshops` folder includes minutes and topics for two workshops: -- [Workshop 20230927](./consultation/workshops/workshop-20230927.md): Materials and steps covered during the September 27, 2023 workshop. -- [Workshop 20231005](./consultation/workshops/workshop-20231005.md): Materials and steps from the October 5, 2023 workshop. +- [Workshop 20230927](./consultation/workshops/workshop-20230927.md): topics covered during the session of September 27, 2023 workshop. +- [Workshop 20231005](./consultation/workshops/workshop-20231005.md): topics covered during the session of October 5, 2023 workshop. ### 3. [Consultation Document](./consultation/consultation.md) From 1991b3320fc785ffc9797067109ea93cb9414350 Mon Sep 17 00:00:00 2001 From: shahmargi12 <124675506+shahmargi12@users.noreply.github.com> Date: Thu, 7 Nov 2024 14:31:09 +0530 Subject: [PATCH 16/17] docs: update docs/README.md Co-authored-by: Evelyn Gurschler --- docs/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/README.md b/docs/README.md index 27100826..67ce1db8 100644 --- a/docs/README.md +++ b/docs/README.md @@ -46,11 +46,11 @@ The `known-knowns` folder highlights known limitations, issues, or consideration ### [Consultation Documentation](./consultation/) -### 1. [Charts](./consultation/charts/) +### 1. [charts](./consultation/charts/) and [environments](./consultation/environments/) -The `charts` folder contains Helm charts for deploying the Portal IAM system. Refer to the following for detailed usage: +The `charts` and `environments` folder contain an **example** helm chart and configuration for a potential deployment improvement discussed during workshops. -- [Portal IAM Helm Chart](./consultation/portal-iam-helm-chart.md): Instructions on using the Helm chart for deploying Portal IAM on Kubernetes. +- [Portal IAM Helm Chart](./consultation/portal-iam-helm-chart.md): instructions on using this **example** helm chart. ### 2. [Workshops](./consultation/workshops/) From ed2421a713b9e3768d74d95feb20f3797d21b94a Mon Sep 17 00:00:00 2001 From: shahmargi12 <124675506+shahmargi12@users.noreply.github.com> Date: Thu, 7 Nov 2024 14:31:38 +0530 Subject: [PATCH 17/17] docs: update docs/README.md Co-authored-by: Evelyn Gurschler --- docs/README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index 67ce1db8..274b72db 100644 --- a/docs/README.md +++ b/docs/README.md @@ -61,7 +61,8 @@ The `workshops` folder includes minutes and topics for two workshops: ### 3. [Consultation Document](./consultation/consultation.md) -- Key architectural consultation notes and decisions. + +- Consultation notes and decisions. ### [Assets](./static/)