docs: refinement after review comments #14
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
the
documentation
NHingerl
reviewed
May 5, 2025
| ## Description | ||
|
|
||
| This repository provides samples based on the recommendations given in the [SAP BTP Administrator's Guide](https://help.sap.com/docs/btp/btp-admin-guide/btp-admin-guide) on [help.sap.com](https://help.sap.com/docs/). | ||
| This repository provides samples based on the recommendations given in the [SAP BTP Administrator's Guide](https://help.sap.com/docs/btp/btp-admin-guide/btp-admin-guide) specifically the section ["Setting Up Your Account Model"](https://help.sap.com/docs/btp/btp-admin-guide/setting-up-your-account-model). |
There was a problem hiding this comment.
No need for the quotation marks; it'll be formatted as link anyway.
NHingerl
reviewed
May 5, 2025
| - Using locals makes code descriptive and maintainable. | ||
|
|
||
| ## Naming Conventions and Labeling | ||
| Another important paradigm is avoiding a monolithic Terraform state (*"Terralith"*). Hence, there is no single Terraform configuration for a complete SAP BTP account. Instead, we split the setup in configurations that are provisioned and managed separately. |
There was a problem hiding this comment.
I suggest:
"It's important to avoid a monolithic Terraform state ("Terralith"). Because of that, we don't provide a single Terraform configuration for a complete SAP BTP account. (...)"
NHingerl
reviewed
May 5, 2025
|
|
||
| ## Modules | ||
|
|
||
| We have created a set of modules to encapsulate the reusable parts of the setup. The modules are located in the folder `modules`. Each module has its own README file that describes the module and its usage. |
There was a problem hiding this comment.
I suggest more user-centric voice:
"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."
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Purpose
Pull Request Type
What kind of change does this pull request introduce?
Other Information
n/a