Skip to content

Commit ab7bc35

Browse files
authored
Merge pull request #2 from SAP-samples/readme
docs: first draft of README
2 parents 07c6180 + 822f95d commit ab7bc35

File tree

2 files changed

+22
-25
lines changed

2 files changed

+22
-25
lines changed

.wordlist.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,8 @@ Terraform's
6363
Terramate
6464
tf
6565
TLS
66+
TODO
67+
todo
6668
toml
6769
TOML
6870
toolchain

README.md

Lines changed: 20 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,36 @@
1-
# SAP-samples/repository-template
2-
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.
1+
<!--- Register repository https://api.reuse.software/register, then add REUSE badge:
2+
[![REUSE status](https://api.reuse.software/badge/github.com/SAP-samples/REPO-NAME)](https://api.reuse.software/info/github.com/SAP-samples/REPO-NAME)
3+
-->
34

4-
# Containing Files
5+
# SAP BTP - Administrator's Guide Samples
56

6-
1. The LICENSE file:
7-
In most cases, the license for SAP sample projects is `Apache 2.0`.
7+
## Description
88

9-
2. The REUSE.toml file:
10-
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.
9+
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/).
1110

12-
3. The README.md file (this file):
13-
Please edit this file as it is the primary description file for your project. You can find some placeholder titles for sections below.
11+
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.
1412

15-
# [Title]
16-
<!-- Please include descriptive title -->
13+
## Content Structure
1714

18-
<!--- Register repository https://api.reuse.software/register, then add REUSE badge:
19-
[![REUSE status](https://api.reuse.software/badge/github.com/SAP-samples/REPO-NAME)](https://api.reuse.software/info/github.com/SAP-samples/REPO-NAME)
20-
-->
15+
TODO
2116

22-
## Description
23-
<!-- Please include SEO-friendly description -->
17+
## How to obtain support
2418

25-
## Requirements
19+
❓ - 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).
2620

27-
## Download and Installation
21+
🐞 - 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).
2822

29-
## Known Issues
30-
<!-- You may simply state "No known issues. -->
23+
💡 - 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).
3124

32-
## How to obtain support
33-
[Create an issue](https://github.com/SAP-samples/<repository-name>/issues) in this repository if you find a bug or have questions about the content.
34-
35-
For additional support, [ask a question in SAP Community](https://answers.sap.com/questions/ask.html).
3625

3726
## Contributing
27+
3828
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/).
3929

30+
## Code of Conduct
31+
32+
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).
33+
4034
## License
41-
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.
35+
36+
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.

0 commit comments

Comments
 (0)