|
1 | | -# SAP Cloud SDK documentation and support portal |
| 1 | +# SAP Cloud SDK documentation portal |
2 | 2 |
|
3 | 3 | [](https://api.reuse.software/info/github.com/SAP/cloud-sdk) |
4 | 4 |
|
5 | | -This repository contains: |
| 5 | +This repository contains sources for the [SAP Cloud SDK Documentation](https://sap.github.io/cloud-sdk/). |
6 | 6 |
|
7 | | -- Sources for the [SAP Cloud SDK Documentation](https://sap.github.io/cloud-sdk/). |
8 | | -- SAP Cloud SDK for Java [Support Issues](https://github.com/SAP/cloud-sdk/issues). |
| 7 | +## Looking for the repository of the SAP Cloud SDK? |
9 | 8 |
|
10 | | -For the [Support](https://github.com/SAP/cloud-sdk-js/issues) on SAP Cloud SDK for JavaScript us this [repository](https://github.com/SAP/cloud-sdk-js). |
| 9 | +Find it here: |
11 | 10 |
|
12 | | -## Looking for the repository of the SAP Cloud SDK for JavaScript / TypeScript? |
| 11 | +- [JavaScript/TypeScript](https://github.com/SAP/cloud-sdk-js). |
| 12 | +- [Java](https://github.com/SAP/cloud-sdk-java). |
13 | 13 |
|
14 | | -Find it [here](https://github.com/SAP/cloud-sdk-js). |
| 14 | +🆕 Documentation portal for the [SAP Cloud SDK for AI](https://sap.github.io/ai-sdk/). |
| 15 | + |
| 16 | +## Requirements and Setup |
| 17 | + |
| 18 | +- [Node.js](https://nodejs.org/en/download/). |
| 19 | + We recommend the latest LTS version of node.js. |
| 20 | + Check your version with `node -v`. |
| 21 | + You can use [`nvm`](https://github.com/nvm-sh/nvm) for managing multiple Node versions on a single machine. |
| 22 | +- Run `npm install` |
| 23 | +- Run `npm start` |
| 24 | +- The SAP Cloud SDK documentation portal should open in a new browser window |
| 25 | + |
| 26 | +### How To Document |
| 27 | + |
| 28 | +The markdown files for the documentation are in the `docs` directory. |
| 29 | +Add or change an article and create a pull request. |
15 | 30 |
|
16 | 31 | ## Getting Support |
17 | 32 |
|
18 | | -- [SAP Cloud SDK for Java](https://github.com/SAP/cloud-sdk/issues) |
19 | | -- [SAP Cloud SDK for JavaScript / TypeScript](https://github.com/SAP/cloud-sdk-js/issues/new/choose) |
| 33 | +- [SAP Cloud SDK Java](https://github.com/SAP/cloud-sdk/issues) |
| 34 | +- [SAP Cloud SDK JavaScript / TypeScript](https://github.com/SAP/cloud-sdk-js/issues) |
20 | 35 | - [Documentation portal](https://sap.github.io/cloud-sdk/) |
21 | 36 |
|
22 | 37 | ## Contributing |
23 | 38 |
|
24 | 39 | Feel free to contribute to the SAP Cloud SDK documentation. |
25 | 40 | Check out our [contribution guide](./CONTRIBUTING.md) and follow our [code of conduct](./CODE_OF_CONDUCT.md). |
26 | 41 |
|
27 | | -## License |
| 42 | +## Security / Disclosure |
| 43 | + |
| 44 | +If you find any bug that may be a security problem, please follow the instructions [in our security policy](https://github.com/SAP/cloud-sdk/security/policy) on how to report it. |
| 45 | +Please do not create GitHub issues for security-related doubts or problems. |
| 46 | + |
| 47 | +## Code of Conduct |
| 48 | + |
| 49 | +We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone. |
| 50 | +By participating in this project, you agree to abide by its [Code of Conduct](https://github.com/SAP/.github/blob/main/CODE_OF_CONDUCT.md) at all times. |
| 51 | + |
| 52 | +## Licensing |
28 | 53 |
|
29 | | -This project is licensed under Apache 2.0 except as noted otherwise in the [license file](./LICENSES/Apache-2.0.txt). |
| 54 | +Copyright 2025 SAP SE or an SAP affiliate company and cloud-sdk contributors. |
| 55 | +Please see our [LICENSE](LICENSE) for copyright and license information. |
| 56 | +Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/SAP/cloud-sdk). |
0 commit comments