This Git repository provides you with Open Telekom Cloud (OTC) service documents, including user guides and API references, to help you better understand and use OTC services.
Documents are stored according to the following rules:
- The level-1 directory (Github.com/OpenTelekomCloud/docs) is the main entry for OTC service documents.
- Level-2 directories are named after service abbreviations such as "ecs" and "vpc".
- Level-3 directories are named after document names such as "user-guide".
- Level-4 and sub -directories contain topics and graphs of a document. A .md file contains content of each topic and is named after a topic name. Words are separated by hyphens (-) in a .md file name. Among the .md files, index.md is the directory index file of a document.
Example:
Github.com/OpenTelekomCloud/docs
├README.md
├LICENSE
├ecs
│ ├user-guide
│ ├index.md
│ ├XXX.md
│ └figures
├vpc
│ ├user-guide
│ ├index.md
│ ├XXX.md
│ └figures
We appreciate contributed documents from all OTC users, partners, developers, and document engineers, which enrich our repository and help us improve continuously. To make a contribution, you need to register with GitHub. Then you can log in to GitHub to find the wanted document in a Git repository. If you need to download PDF documents or preview a full document online, go to the help center of OTC at https://docs.otc.t-systems.com/
Using the index.md file in the Git repository can help you quickly locate the topic that you want to read. If you want to make changes to a topic, submit the content to the project owner of OTC by forking, using pull requests, or other methods.
All documents in the GitHub community must be written in the Markdown language. For more information about writing and formatting on GitHub, visit https://help.github.com/articles/getting-started-with-writing-and-formatting-on-github/
For details, see the LICENSE file.