update OBS UMN according to helpcenter 2.0.17#103
update OBS UMN according to helpcenter 2.0.17#103MrGourd wants to merge 1 commit intoopentelekomcloud:masterfrom
Conversation
MrGourd
commented
Sep 30, 2020
- Added the description about the SMN message structure: smn-enabled-event-notification.md
- Fixed some descriptive and ease-of-use issues.
- Deleted unnecessary .rst files.
gtema
left a comment
There was a problem hiding this comment.
Thanks for the update. There are however some critical issues with it:
- not a single rst file in the project is currently unnecessary. The whole documentation tree is build on those rst files. They replace index.md and other md files simply including other files. This is required to be able to properly render complete otc documentation
- due to dropping of rst files the build is now broken, see https://swift.eu-de.otc.t-systems.com/v1/AUTH_73733c21728443609ee0b47f64b5ce0b/zuul_logs/e3b/103/719244eae3219e0a35337c1749ea59ad6ac13f33/check/tox-docs/e3bb074/job-output.txt for details
- you reintroduce public_sys-resources for the images common between all services. Due to the overall size of documentation and trying to improve maintenance we moved those into common doc/source/images
|
Hi, @gtema
|
They are not built automatically, but manually. If you look at index.rst in the doc/source/index.rst you will see what it includes and so on and so on. rst files are currently describing the whole skeleton of the documentation, while the text itself remains in md files
When a "leaf" .md file is introduced it must be included in the .rst file of the corresponding documentation level. |
|
I think I see what you mean. My colleagues and I need to analyze this requirement before communicating with you. Thank you. |