From 2d2b1ef77cfe33b807a41f335f91b7d415838e81 Mon Sep 17 00:00:00 2001 From: Christian Lechner <22294087+lechnerc77@users.noreply.github.com.> Date: Fri, 9 May 2025 14:18:08 +0200 Subject: [PATCH 1/4] docs: enhance modules section --- sample-setups/README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/sample-setups/README.md b/sample-setups/README.md index 3504c4d..efafcc9 100644 --- a/sample-setups/README.md +++ b/sample-setups/README.md @@ -31,7 +31,9 @@ The folder `basic-setup/subaccount-setup` contains the setup of subaccounts. For ## Modules -We have created a set of modules to encapsulate the reusable parts of the setup. You find the modules in the folder modules. Learn about the modules and their usage in their respective `README` files. +We want to keep our Terraform configuration as simple and concise as possible. To achieve this we encapsulate resusable parts of the setup in [modules](https://developer.hashicorp.com/terraform/language/modules). This allows us to reuse the modules in different setups and to keep the configuration DRY (*Don't repeat yourself*). A benefit of this approach is that we can centrally manage governance topics like naming conventions and labeling strategies for all setups. + +You find the modules in the folder "modules". Learn about the modules and their usage in their respective `README` files. ### Naming Conventions and Labeling From 63c2b9a0ba5fedd9f58c77145b5c75dd78262c65 Mon Sep 17 00:00:00 2001 From: Christian Lechner <22294087+lechnerc77@users.noreply.github.com.> Date: Fri, 9 May 2025 14:20:19 +0200 Subject: [PATCH 2/4] docs: fix typos --- README.md | 2 +- sample-setups/README.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 507d878..28f7df2 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ The samples are available in the folder `sample-setups`. We provide each scenari You find further details in the [`READEME.md`](./sample-setups/README.md) file of the `sample-setups` folder and in the `README.md` files of the individual sample setups -In addition, we have a folder `modules` containing reusable Terraform modules. These modules are used in the sample setups. +In addition, we have a folder `modules` containing reuseable Terraform modules. These modules are used in the sample setups. ## Getting Support diff --git a/sample-setups/README.md b/sample-setups/README.md index efafcc9..a385272 100644 --- a/sample-setups/README.md +++ b/sample-setups/README.md @@ -5,7 +5,7 @@ We follow the paradigms of a simple and clear Terraform configuration as laid out in [Simple, Clear, Maintainable](https://rosesecurity.dev/2024/11/24/terraform-proverbs.html); especially: - Clear is better than clever. -- Modules should be reusable, not rigid. +- Modules should be reuseable, not rigid. - Outputs are for sharing. - Labels are free; use them liberally. - Descriptions are for users. @@ -49,7 +49,7 @@ The module [base-directory-setup](./modules/base-directory-setup/README.md) is u ### Subaccount Setup -The reusable parts of the subaccount setup are: +The reuseable parts of the subaccount setup are: - The module [SAP BTP - Default Subaccount Entitlements](./modules/sap-btp-subaccount-default-entitlements/README.md) encapsulates the default entitlements for SAP BTP subaccounts. It distinguishes between the different development stages of the environment (Dev, Test, Prod, Shared) and provides the default data of entitlements for each stage. The entitlement is executed in the configuration of the [basic setup of the subaccount](./basic-setup/directory-setup/README.md) - The creation of the different SAP BTP environments are encapsulated in modules for [Cloud Foundry](./modules/sap-btp-environment/cloudfoundry/README.md) and [Kyma](./modules/sap-btp-environment/kyma/README.md). From b66c94a3ae5bd45a124dd34155e9f3307b51ed4c Mon Sep 17 00:00:00 2001 From: Christian Lechner <22294087+lechnerc77@users.noreply.github.com.> Date: Fri, 9 May 2025 14:24:15 +0200 Subject: [PATCH 3/4] docs: typos ... again --- .wordlist.txt | 1 + README.md | 2 +- sample-setups/README.md | 4 ++-- 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/.wordlist.txt b/.wordlist.txt index a3546a9..42f1a94 100644 --- a/.wordlist.txt +++ b/.wordlist.txt @@ -65,6 +65,7 @@ PowerShell powershell README readme +reusable runtime spf SSO diff --git a/README.md b/README.md index 28f7df2..507d878 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ The samples are available in the folder `sample-setups`. We provide each scenari You find further details in the [`READEME.md`](./sample-setups/README.md) file of the `sample-setups` folder and in the `README.md` files of the individual sample setups -In addition, we have a folder `modules` containing reuseable Terraform modules. These modules are used in the sample setups. +In addition, we have a folder `modules` containing reusable Terraform modules. These modules are used in the sample setups. ## Getting Support diff --git a/sample-setups/README.md b/sample-setups/README.md index a385272..efafcc9 100644 --- a/sample-setups/README.md +++ b/sample-setups/README.md @@ -5,7 +5,7 @@ We follow the paradigms of a simple and clear Terraform configuration as laid out in [Simple, Clear, Maintainable](https://rosesecurity.dev/2024/11/24/terraform-proverbs.html); especially: - Clear is better than clever. -- Modules should be reuseable, not rigid. +- Modules should be reusable, not rigid. - Outputs are for sharing. - Labels are free; use them liberally. - Descriptions are for users. @@ -49,7 +49,7 @@ The module [base-directory-setup](./modules/base-directory-setup/README.md) is u ### Subaccount Setup -The reuseable parts of the subaccount setup are: +The reusable parts of the subaccount setup are: - The module [SAP BTP - Default Subaccount Entitlements](./modules/sap-btp-subaccount-default-entitlements/README.md) encapsulates the default entitlements for SAP BTP subaccounts. It distinguishes between the different development stages of the environment (Dev, Test, Prod, Shared) and provides the default data of entitlements for each stage. The entitlement is executed in the configuration of the [basic setup of the subaccount](./basic-setup/directory-setup/README.md) - The creation of the different SAP BTP environments are encapsulated in modules for [Cloud Foundry](./modules/sap-btp-environment/cloudfoundry/README.md) and [Kyma](./modules/sap-btp-environment/kyma/README.md). From 0e18656448ea37a44e0706152ec861627e966d5a Mon Sep 17 00:00:00 2001 From: Christian Lechner <22294087+lechnerc77@users.noreply.github.com.> Date: Fri, 9 May 2025 14:28:41 +0200 Subject: [PATCH 4/4] docs: fix --- sample-setups/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sample-setups/README.md b/sample-setups/README.md index efafcc9..63e33f8 100644 --- a/sample-setups/README.md +++ b/sample-setups/README.md @@ -31,7 +31,7 @@ The folder `basic-setup/subaccount-setup` contains the setup of subaccounts. For ## Modules -We want to keep our Terraform configuration as simple and concise as possible. To achieve this we encapsulate resusable parts of the setup in [modules](https://developer.hashicorp.com/terraform/language/modules). This allows us to reuse the modules in different setups and to keep the configuration DRY (*Don't repeat yourself*). A benefit of this approach is that we can centrally manage governance topics like naming conventions and labeling strategies for all setups. +We want to keep our Terraform configuration as simple and concise as possible. To achieve this we encapsulate reusable parts of the setup in [modules](https://developer.hashicorp.com/terraform/language/modules). This allows us to reuse the modules in different setups and to keep the configuration DRY (*Don't repeat yourself*). A benefit of this approach is that we can centrally manage governance topics like naming conventions and labeling strategies for all setups. You find the modules in the folder "modules". Learn about the modules and their usage in their respective `README` files.