Improve QoS Documentation

OpenDDS / OpenDDS

OpenDDS is an open source C++ implementation of the Object Management Group (OMG) Data Distribution Service (DDS). OpenDDS also supports Java bindings through JNI.

http://www.opendds.org

Other

1.29k stars 465 forks source link

Improve QoS Documentation #4520

Closed iguessthislldo closed 2 months ago

iguessthislldo commented 3 months ago

Quality of Service
- Rearranged to remove large default value tables.
- Added Data Representation and Type Consistency Enforcement.
- Every policy now has a box that says if it's mutable, if it affects writer-reader association, its default values, and links to the spec definition.
- Added many links to QoS policies
Move fnmatch expressions into an "annex" file so it can be common between security and partitions QoS.
Add definitions for "instance", "unregister", and "dispose" to the glossary.

iguessthislldo commented 3 months ago

The main change, the info boxes for the QoS, can be seen here https://opendds--4520.org.readthedocs.build/en/4520/devguide/quality_of_service.html#reliability-qos

iguessthislldo commented 3 months ago

Links to all the changes here: https://opendds--4520.org.readthedocs.build/en/4520/news.html#documentation