Skip to content

Commit b4661f7

Browse files
committed
docs: fix typos
1 parent 74ec9d6 commit b4661f7

File tree

5 files changed

+32
-14
lines changed

5 files changed

+32
-14
lines changed

.wordlist.txt

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,32 @@
1-
APIs
1+
API
2+
api
23
autocompletion
34
APIs
45
backend
56
Backend
67
breakpoint
78
BTP
89
btp
10+
carte
911
CLA
1012
CLI
1113
CLIs
14+
cloudfoundry
15+
Cloudfoundry
1216
CodeQL
1317
config
1418
Copilot
19+
costcenter
20+
Costcenter
1521
customizations
1622
DCO
1723
dependabot
24+
Dev
25+
dev
1826
devcontainer
1927
devcontainers
2028
dir
29+
EMEA
2130
faq
2231
Github
2332
github
@@ -32,8 +41,11 @@ JSON
3241
js
3342
JS
3443
jq
44+
Kyma
3545
macOS
3646
md
47+
namings
48+
Namings
3749
NextSteps
3850
OAuth
3951
OpenSSF
@@ -70,6 +82,12 @@ TOML
7082
toolchain
7183
UIs
7284
UI
85+
Unmanaged
86+
unmanaged
87+
URL
88+
url
89+
uuid
90+
UUID
7391
VS
7492
workspace
7593
workspaces

sample-setups/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Paradigms
44

5-
We follow the paradigms of a simpel and clear Terraform configuration as laid out in the [Simple, Clear, Maintainable](https://rosesecurity.dev/blog/2024/11/24/terraform-proverbs) blog post of the [Development Log](https://rosesecurity.dev/) especially:
5+
We follow the paradigms of a simple and clear Terraform configuration as laid out in the [Simple, Clear, Maintainable](https://rosesecurity.dev/blog/2024/11/24/terraform-proverbs) blog post of the [Development Log](https://rosesecurity.dev/) especially:
66

77
- Clear is better than clever.
88
- Modules should be reusable, not rigid.
@@ -15,9 +15,9 @@ We follow the paradigms of a simpel and clear Terraform configuration as laid ou
1515

1616
## Naming Conventions and Tagging
1717

18-
Ensuring naming conventions is one import aspect when provisioing and managing your SAP BTP account. We will align our samples in accordance to the [Naming Conventions for SAP BTP Accounts](https://help.sap.com/docs/btp/btp-admin-guide/naming-conventions-for-sap-btp-accounts).
18+
Ensuring naming conventions is one import aspect when provisioning and managing your SAP BTP account. We will align our samples in accordance to the [Naming Conventions for SAP BTP Accounts](https://help.sap.com/docs/btp/btp-admin-guide/naming-conventions-for-sap-btp-accounts).
1919

20-
To ensure consistent naming of your resources, we encapsulate the guidlines in dedicated module. Besides the naming we will also include the labels that can be attached to some resources on SAP BTP.
20+
To ensure consistent naming of your resources, we encapsulate the guidelines in dedicated module. Besides the naming we will also include the labels that can be attached to some resources on SAP BTP.
2121

2222
We have created one module for the level of the [directory](./modules/sap-btp-naming-conventions-directory/README.md) and one for the level of the [subaccount](./modules/sap-btp-naming-conventions-subaccount/README.md).
2323

sample-setups/basic-setup/directory-setup/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22

33
## Assumptions
44

5-
- We assume that we use the directories as structuring element for the subaccounts i.e., un an unmanaged fashion.
5+
- We assume that we use the directories as structuring element for the subaccounts i.e., in an unmanaged fashion.
66
- We assume that we do the directory setup in one run for all involved departments.
77

88
## Design Decisions
99

10-
We decouple the directory creation i.e., the setup of the basic structure from the creation of the operational units namely the subaccounts inside of the directories. The changes on directory level are probably a rare sceanrio compared to changes in the subaccounts additionally depending on their stage. We want to avoid side effects as well as lengthy state refreshes and keep the state of the directories seperate.
10+
We decouple the directory creation i.e., the setup of the basic structure from the creation of the operational units namely the subaccounts inside of the directories. The changes on directory level are probably a rare scenario compared to changes in the subaccounts additionally depending on their stage. We want to avoid side effects as well as lengthy state refreshes and keep the state of the directories separate.
1111

1212
## Directory Setup
1313

sample-setups/basic-setup/subaccount-setup/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,29 +2,29 @@
22

33
## Assumptions
44

5-
- We assume a bsaic setup of a subaccount is executed by the platform team/ SAP BTP administrator team
6-
- We assume that the responsibility of the platform team is restricted to a basic setup of a subacount leaving out app subscriptions and service instance creation.
5+
- We assume a basic setup of a subaccount is executed by the platform team/ SAP BTP administrator team
6+
- We assume that the responsibility of the platform team is restricted to a basic setup of a subaccount leaving out app subscriptions and service instance creation.
77

8-
## Design Decsions
8+
## Design Decisions
99

10-
To keep the Terraform state files clearly seperated the setup is done per subaccount i.e. per stage.
10+
To keep the Terraform state files clearly separated the setup is done per subaccount i.e. per stage.
1111

1212
## Subaccount Setup
1313

1414
The setup of the subaccount comprises:
1515

16-
- The setup of a subaccount in accordance to the naming conventions and labeling startegy of the company
16+
- The setup of a subaccount in accordance to the naming conventions and labeling strategy of the company
1717
- The trust configuration to a custom IdP is configured by default.
1818
- Default entitlements are added depending on the stage. In addition the requesting team can add additional project specific entitlements ("à la carte entitlements")
1919
- Optionally a Cloud Foundry Environment is created
2020

2121
### Naming Conventions and Labels
2222

23-
The naming conventions and labels are centralized in the module [sap-btp-naming-conventions-subaccount](../../modules/sap-btp-naming-conventions-subaccount/README.md). The names and labels are drived based on input variables defined in the [variables.tf](./variables.tf) file.
23+
The naming conventions and labels are centralized in the module [sap-btp-naming-conventions-subaccount](../../modules/sap-btp-naming-conventions-subaccount/README.md). The names and labels are derived based on input variables defined in the [variables.tf](./variables.tf) file.
2424

2525
### Validations for Geographies and BTP Regions
2626

27-
According to the SAP BTP Administrators Guide one part of the naming is the geographical region. To ensure that this region fits to the subaccount region, a validation is implemented in the [variables.tf](./variables.tf) file. The validation checks if the region of the subaccount is part of the geographical region. The geographical regions are defined in a local variable sdefined in the [main.tf](main.tf) file.
27+
According to the SAP BTP Administrators Guide one part of the naming is the geographical region. To ensure that this region fits to the subaccount region, a validation is implemented in the [variables.tf](./variables.tf) file. The validation checks if the region of the subaccount is part of the geographical region. The geographical regions are defined in a local variables defined in the [main.tf](main.tf) file.
2828

2929
### Setup of Entitlements
3030

sample-setups/modules/sap-btp-environment/CloudFoundry/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# SAP BTP - Environment Setup
22

3-
This module encapsulates the creation of a Cloud Foundry environment in a subaccounton SAP BTP.
3+
This module encapsulates the creation of a Cloud Foundry environment in a subaccount on SAP BTP.
44

55
## Requirements
66

0 commit comments

Comments
 (0)