Skip to content

Commit ccea093

Browse files
chore: prepare open source (#10)
* chore: update REUSE * chore: update CONTRIBUTING guidelines * feat: add PR template * chore: reuse workflow * chore: update package-lock.json * docs: add Get Started section * Update README.md --------- Co-authored-by: Valentin Gerlach <valentin.gerlach@sap.com>
1 parent c674d0c commit ccea093

File tree

7 files changed

+1975
-534
lines changed

7 files changed

+1975
-534
lines changed

.github/pull_request_template.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
**What this PR does / why we need it**:
2+
3+
**Which issue(s) this PR fixes**:
4+
Fixes #
5+
6+
**Special notes for your reviewer**:
7+
8+
**Release note**:
9+
<!-- Write your release note:
10+
1. Enter your release note in the below block.
11+
2. If no release note is required, just write "NONE" within the block.
12+
13+
Format of block header: <category> <target_group>
14+
Possible values:
15+
- category: breaking|feature|bugfix|doc|other
16+
- target_group: user|operator|developer|dependency
17+
-->
18+
```feature user
19+
20+
```

.github/workflows/reuse.yaml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
name: REUSE Compliance Check
2+
3+
on: [push, pull_request]
4+
5+
permissions:
6+
contents: read
7+
8+
jobs:
9+
run_reuse:
10+
uses: openmcp-project/build/.github/workflows/reuse.lib.yaml@main
11+
secrets: inherit

.reuse/dep5

Lines changed: 0 additions & 29 deletions
This file was deleted.

CONTRIBUTING.md

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

33
## Code of Conduct
44

5-
All members of the project community must abide by the [SAP Open Source Code of Conduct](https://github.com/SAP/.github/blob/main/CODE_OF_CONDUCT.md).
5+
All members of the project community must abide by the [SAP Open Source Code of Conduct](https://github.com/openmcp-project/.github/blob/main/CODE_OF_CONDUCT.md).
66
Only by respecting each other we can develop a productive, collaborative community.
7-
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting [a project maintainer](.reuse/dep5).
7+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [ospo@sap.com](mailto:ospo@sap.com) (SAP Open Source Program Office). All complaints will be reviewed and investigated promptly and fairly.
88

99
## Engaging in Our Project
1010

@@ -30,7 +30,7 @@ The following rule governs code contributions:
3030

3131
* Contributions must be licensed under the [Apache 2.0 License](./LICENSE).
3232
* Due to legal reasons, contributors will be asked to accept a Developer Certificate of Origin (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/).
33-
* Contributions must follow our [guidelines on AI-generated code](https://github.com/SAP/.github/blob/main/CONTRIBUTING_USING_GENAI.md) in case you are using such tools.
33+
* Contributions must follow our [guidelines on AI-generated code](https://github.com/openmcp-project/.github/blob/main/CONTRIBUTING_USING_GENAI.md) in case you are using such tools.
3434

3535
## Issues and Planning
3636

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,40 @@
66

77
Documentation and Architecture for the openmcp-project.
88

9+
## Getting Started
10+
11+
This site is built with [Docusaurus 3](https://docusaurus.io/).
12+
13+
### 🚧 Prerequisites
14+
15+
Make sure that you have installed the following tools on your local machine:
16+
17+
- [Node.js](https://nodejs.org/en/download/) version 18.0 or above
18+
19+
### 🧑‍💻 Local Development
20+
21+
```sh
22+
# Install the latest packages.
23+
$ npm install
24+
25+
# Start the development server.
26+
$ npm start
27+
```
28+
29+
The local development server should start and open up a browser window. Most changes are reflected live without having to restart the server or reload the website.
30+
31+
Changes to the documentation must be done via pull requests. A GitHub Actions [workflow](.github/workflows/test-deploy.yml) will check if the website can be built.
32+
33+
### 🌍 Deployment
34+
35+
Deployment is done using a GitHub Actions [workflow](.github/workflows/deploy.yml) when there are new commits on the `main` branch.
36+
937
## Support, Feedback, Contributing
1038

1139
This project is open to feature requests/suggestions, bug reports etc. via [GitHub issues](https://github.com/openmcp-project/docs/issues). Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our [Contribution Guidelines](CONTRIBUTING.md).
1240

1341
## Security / Disclosure
42+
1443
If you find any bug that may be a security problem, please follow our instructions at [in our security policy](https://github.com/openmcp-project/docs/security/policy) on how to report it. Please do not create GitHub issues for security-related doubts or problems.
1544

1645
## Code of Conduct

REUSE.toml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
version = 1
2+
SPDX-PackageName = "docs"
3+
SPDX-PackageDownloadLocation = "https://github.com/openmcp-project/docs"
4+
SPDX-PackageComment = "The code in this project may include calls to APIs (\"API Calls\") of\n SAP or third-party products or services developed outside of this project\n (\"External Products\").\n \"APIs\" means application programming interfaces, as well as their respective\n specifications and implementing code that allows software to communicate with\n other software.\n API Calls to External Products are not licensed under the open source license\n that governs this project. The use of such API Calls and related External\n Products are subject to applicable additional agreements with the relevant\n provider of the External Products. In no event shall the open source license\n that governs this project grant any rights in or to any External Products, or\n alter, expand or supersede any terms of the applicable additional agreements.\n If you have a valid license agreement with SAP for the use of a particular SAP\n External Product, then you may make use of any API Calls included in this\n project's code for that SAP External Product, subject to the terms of such\n license agreement. If you do not have a valid license agreement for the use of\n a particular SAP External Product, then you may only make use of any API Calls\n in this project for that SAP External Product for your internal, non-productive\n and non-commercial test and evaluation of such API Calls. Nothing herein grants\n you any rights to use or access any SAP External Product, or provide any third\n parties the right to use of access any SAP External Product, through API Calls."
5+
6+
[[annotations]]
7+
path = "**"
8+
precedence = "closest"
9+
SPDX-FileCopyrightText = "2025 SAP SE or an SAP affiliate company and docs contributors"
10+
SPDX-License-Identifier = "Apache-2.0"

0 commit comments

Comments
 (0)