Document_Conductor_models_and_relationships

Document Conductor models and relationships

Summary

Documentation of our model code is needed for developers to be able to efficiently understand and support Conductor. This feature aims to provide this through a combination of custom-written documentation, tailored to hit key features and points; and through in-line code documentation, which will be gathered up and deployed automatically, using a tool such as rDoc. Finally, since our model code is necessarily fluid, a process for updating documentation will be created, outlining expectations for both developers and reviewers.

Owner

Tzu-Mainn Chen (tzumainn)

Current status

• Targeted release: Conductor 1.1 Release

Implementation tasks

• #3041 - Detail the Conductor model, including the intended purpose of each component and the relationships between components

High-level implementation details

• Write custom documentation that summarizes the purpose and relationships of Conductor models.
• Use rDoc or something similar to provide HTML documentation of model code.
• Ensure that the above documentation is auto-generated during builds.
• Create a process to migrate that auto-generated documentation to the Aeolus website.
• Create a developer process that outlines the expected documentation that should accompany code changes.

Future plan

After performing the tasks above, we will need to continuously monitor patches to ensure that they follow the specified procedure and include the proper documentation updates.

References

• None yet