-
Notifications
You must be signed in to change notification settings - Fork 4
Description
Jekyll Open Hub theme does not advocate duplicating full specification texts into Open Project sites. This is not DRY, manually maintaining copies of content in sync is unnecessary friction.
(While it seems definitely not strictly necessary, if it is desirable for some reason to include a copy of content such as spec contents or software package docs into Open Project sites, a feature for Jekyll Open Hub theme, or build/CI configurations, should be requested to enable this sort of content to be pulled automatically from third-party sources such as IETF or RTD.)
However, design mock-ups at hand seem to offer the space for software/spec content. Jekyll Open Hub theme recommends to provide a description or useful summary in that case, which would include high-level information about the purpose, and exclude any changeable specifics such as installation instructions.
Some specs on currently implemented sites (RNP and Metanorma) include full contents instead of summary. That should be changed, options:
- Include custom-crafted original spec description just for Ribose Open side (ideal option)
- Copy IETF abstract, if available
- Copy introduction part of specβs GitHub README, if available
For the time being, going with the non-ideal options.