Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mention version(s) covered on user documentation and/or ship with source #157

Closed
jonassmedegaard opened this issue May 8, 2014 · 1 comment
Milestone

Comments

@jonassmedegaard
Copy link

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

@liZe
Copy link
Member

liZe commented Jul 28, 2014

Oh yeah. It's definitely time to find a solution about that.

@liZe liZe added this to the 1.0 milestone Jul 28, 2014
@liZe liZe mentioned this issue Apr 4, 2016
39 tasks
@liZe 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
@liZe liZe closed this as completed May 27, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants