Current State
Design documentation for plugins is embedded in the binary artifact within an adoc folder. During build, this folder is extracted so the AsciiDoc files can be incorporated into the generated matala-design.pdf.
Problem
This approach creates adds adoc documentation to the binary artifacts which are not strictly necessary at runtime.
Suggestions
Option 1: Link to plugin documentation
- Reference plugin docs via hyperlinks instead of embedding
Option 2: Reference source artifacts instead of binary
- Extract documentation from source repositories rather than binaries
Option 3: Do nothing
Next Steps
- Evaluate which approach best fits the workflow
- Update build process accordingly
- Document the new way of working
Current State
Design documentation for plugins is embedded in the binary artifact within an
adocfolder. During build, this folder is extracted so the AsciiDoc files can be incorporated into the generatedmatala-design.pdf.Problem
This approach creates adds adoc documentation to the binary artifacts which are not strictly necessary at runtime.
Suggestions
Option 1: Link to plugin documentation
Option 2: Reference source artifacts instead of binary
Option 3: Do nothing
Next Steps