Documentation structure draft - Githubissues

ros-realtime / rtwg_documentation

Deprecated RTWG docs repository

https://real-time-working-group.readthedocs.io/en/latest/

Creative Commons Attribution 4.0 International

9 stars 4 forks source link

Documentation structure draft #1

Closed carlossvg closed 3 years ago

carlossvg commented 3 years ago

This is a draft for the RTWG documentation structure:

Guides
- Real-time Operating System setup
  - Real Time Linux
  - Build a kernel using Preempt-RT
  - Configure kernel
  - Additional settings (ulimits, interrupt threads, network, cgroups, ....)
  - Configuring VXworks => https://github.com/Wind-River/vxworks7-layer-for-ros2
  - Configuring QNX => https://github.com/ros-realtime/community/issues/5
- How to configure rmw implementations
  - FastDDS
  - CycloneDDS
  - ConnextMicro/Pro
  - Iceoryx
  - ...
- How to run a ROS 2 real-time application
- Best practices
ROS 2 real-time buildfarm
- Test environment
- How to run the tests locally
Concepts
- Memory management
- Exceptions
- Logging
- ...
External resources (articles, guides, ....)
Roadmap
Contributing
Feature ideas
Subprojects
Related projects

carlossvg commented 3 years ago

I added an additional item to configure DDS and other rmw implementations. This would include vendor specific guidelines, such as configuring XML QoS profiles, using static memory support, memory pools, thread priority, etc.