You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Please make it easier for distributors (like myself) to include documentation with packaged code.
Currently documentation exist online, with source tracked in a separate branch of the project git.
Please consider mention directly on the user documentation page the version(s) covered by said documentation. That's a useful information in itself, and (especially when expressed fully written out, not abbreviated like 0.7.x-0.9) is useful for packagers to make the packaging fail if manually extracted documentation does not match version of code.
Also, please consider including the source of documentation together with the source of code. One way I can imagine that done without too much interruption of current workflow is by registering the website branch as a git submodule at the master branch - e.g. at subdir "docs" or "website", and then sync and include that submodule when finalizing release tarballs.
liZe
changed the title
mention version(s) covered on user documentation and/or ship with source
Mention version(s) covered on user documentation and/or ship with source
Aug 5, 2016
Please make it easier for distributors (like myself) to include documentation with packaged code.
Currently documentation exist online, with source tracked in a separate branch of the project git.
Please consider mention directly on the user documentation page the version(s) covered by said documentation. That's a useful information in itself, and (especially when expressed fully written out, not abbreviated like 0.7.x-0.9) is useful for packagers to make the packaging fail if manually extracted documentation does not match version of code.
Also, please consider including the source of documentation together with the source of code. One way I can imagine that done without too much interruption of current workflow is by registering the website branch as a git submodule at the master branch - e.g. at subdir "docs" or "website", and then sync and include that submodule when finalizing release tarballs.
Here is a related bugreport in Debian: https://bugs.debian.org/730044
The text was updated successfully, but these errors were encountered: