diff --git a/.wordlist.txt b/.wordlist.txt index dff76d1..42dd981 100644 --- a/.wordlist.txt +++ b/.wordlist.txt @@ -63,6 +63,8 @@ Terraform's Terramate tf TLS +TODO +todo toml TOML toolchain diff --git a/README.md b/README.md index 2010bb1..fea3a1c 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,36 @@ -# SAP-samples/repository-template -This default template for SAP Samples repositories includes files for README, LICENSE, and REUSE.toml. All repositories on github.com/SAP-samples will be created based on this template. + -# Containing Files +# SAP BTP - Administrator's Guide Samples -1. The LICENSE file: -In most cases, the license for SAP sample projects is `Apache 2.0`. +## Description -2. The REUSE.toml file: -The [Reuse Tool](https://reuse.software/) must be used for your samples project. You can find the REUSE.toml in the project initial. Please replace the parts inside the single angle quotation marks < > by the specific information for your repository. +This repository provides tangible samples based on the good practices and examples 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/). -3. The README.md file (this file): -Please edit this file as it is the primary description file for your project. You can find some placeholder titles for sections below. +The provided samples show the implementation of the guidelines using Infrastructure as Code namely [Terraform](https://www.terraform.io/)/[OpenTofu](https://opentofu.org/). This should support in getting started with a sustainable setup of your SAP BTP accounts following our recommendations. -# [Title] - +## Content Structure - +TODO -## Description - +## How to obtain support -## Requirements +❓ - If you have a *question* you can ask it here in [GitHub Discussions](https://github.com/SAP/btp-admin-guide-samples/discussions/) or in the [SAP Community](https://answers.sap.com/questions/ask.html). -## Download and Installation +🐞 - If you find a bug, feel free to create a [bug report](https://github.com/SAP/btp-admin-guide-samples/issues/new?assignees=&labels=bug%2Cneeds-triage&projects=&template=bug_report.yml&title=%5BBUG%5D). -## Known Issues - +💡 - If you have an idea for improvement or a feature request, please open a [feature request](https://github.com/SAP/btp-admin-guide-samples/issues/new?assignees=&labels=enhancement%2Cneeds-triage&projects=&template=feature_request.yml&title=%5BFEATURE%5D). -## How to obtain support -[Create an issue](https://github.com/SAP-samples//issues) in this repository if you find a bug or have questions about the content. - -For additional support, [ask a question in SAP Community](https://answers.sap.com/questions/ask.html). ## Contributing + If you wish to contribute code, offer fixes or improvements, please send a pull request. Due to legal reasons, contributors will be asked to accept a DCO when they create the first pull request to this project. This happens in an automated fashion during the submission process. SAP uses [the standard DCO text of the Linux Foundation](https://developercertificate.org/). +## Code of Conduct + +Members, contributors, and leaders pledge to make participation in our community a harassment-free experience. By participating in this project, you agree to always abide by its [Code of Conduct](https://github.com/SAP/.github/blob/main/CODE_OF_CONDUCT.md). + ## License -Copyright (c) 2024 SAP SE or an SAP affiliate company. All rights reserved. This project is licensed under the Apache Software License, version 2.0 except as noted otherwise in the [LICENSE](LICENSE) file. + +Copyright (c) 2025 SAP SE or an SAP affiliate company. All rights reserved. This project is licensed under the Apache Software License, version 2.0 except as noted otherwise in the [LICENSE](LICENSE) file.