Skip to content
This repository was archived by the owner on Dec 9, 2021. It is now read-only.

Conversation

@MrGourd
Copy link
Contributor

@MrGourd 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.

Copy link
Contributor

@gtema gtema left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the update. There are however some critical issues with it:

@MrGourd
Copy link
Contributor Author

MrGourd commented Sep 30, 2020

Hi, @gtema
Since the overall structure of the Git repository has changed, I still have some questions about this. I hope you can answer thme so that I can synchronize the update request to my colleagues.

  1. Does this mean that all .rst files in the current repository are built automatically and that we only need to update the .md file when updating the document?
    2.If a new .md file is added during the update, how can the system identify the location of the new file in the document directory structure? Is the document tree built based on the Help Center production environment? If so, then I understand the logic here.

@gtema
Copy link
Contributor

gtema commented Sep 30, 2020

1. Does this mean that all .rst files in the current repository are built automatically and that we only need to update the .md file when updating the document?

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

2. If a new .md file is added during the update, how can the system identify the location of the new file in the document directory structure? Is the document tree built based on the Help Center production environment? If so, then I understand the logic here.

When a "leaf" .md file is introduced it must be included in the .rst file of the corresponding documentation level.
When a index like .md file is introduced (what previously was used for creating sections of the documentation) a corresponding .rst file pointing to the leaf .md files should be introduced. It (in turn) is then included in the index.rst of the upper level - See like obs/UG/cors.rst is including cors-overview-(console).md and configuring-cors.md while being itself included in obs_console_operation_guide.rst (included in index.rst). The best way of file structuring is currently implemented in vpcep service where the dirctory structure stricktly follows expected documentation structure what makes it really easy to navigate in the repo. It would be really great if every service starts using this structure to make all our lives easier.
And yes, the tree is based on the current documentation structure

@MrGourd
Copy link
Contributor Author

MrGourd commented Sep 30, 2020

I think I see what you mean. My colleagues and I need to analyze this requirement before communicating with you. Thank you.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants