Drake: Drake From-Source Installation Instructions Should be Updated to be Linear

Created on 24 Jun 2016  路  5Comments  路  Source: RobotLocomotion/drake

It currently involves bouncing between from_source.rst to various platform-specific instructions and then back to from_source.rst. This makes it unnecessarily difficult to follow. Having a linear sequence of instructions, one for each platform configuration, is more scalable as we spin up support for additional platforms like Ubuntu 16.04.

medium cleanup documentation

Most helpful comment

To be clear: this should definitely not be a copy-paste of the existing content into a bunch of separate files. That would be epically disastrous.

We should write a small amount of tooling to output well-factored linear instructions from separate general and specific pieces -- either conditional guards in some preprocessor-like language on an all-in linear document (my preference), or using several smaller files that are unified as part of the sphinx build process (might be simpler to implement).

All 5 comments

Is that example linear only because it is single-platform?

Yes, I think there should be a separate linear sequence of instructions for each supported platform and configuration. This will result in greater replication across instruction sequences but I think that tradeoff is OK.

To be clear: this should definitely not be a copy-paste of the existing content into a bunch of separate files. That would be epically disastrous.

We should write a small amount of tooling to output well-factored linear instructions from separate general and specific pieces -- either conditional guards in some preprocessor-like language on an all-in linear document (my preference), or using several smaller files that are unified as part of the sphinx build process (might be simpler to implement).

Good enough? Sure.

Was this page helpful?
0 / 5 - 0 ratings