branches per version seems like the best way to track it, but the resulting
large mass of versions seems like it's going to be hard to manage (although the
doc maintainers may come up with scripts to do this)
in git it's very efficient to hae the same thing in many branches, so space
there isn't an issue, but www.rsyslog.com/doc will be interesting.
for the web version, take a look at what Splunk does for their documentation
with the pull-down to select the version you are looking at.
David Lang
On Sun, 15 Dec 2013, Rainer Gerhards
wrote:
Date: Sun, 15 Dec 2013 15:25:11 +0100
From: Rainer Gerhards <[email protected]>
Reply-To: rsyslog-users <[email protected]>
To: rsyslog-users <[email protected]>
Subject: Re: [rsyslog] [doc] versioning
Branches also make maintaining multiple versions really easy. I'll blog
tomorrow how i do it for rsyslog.
Sent from phone, thus brief.
Am 15.12.2013 15:20 schrieb "Pavel Levshin" <[email protected]>:
The best way of doing this is just using branches, just like they are used
in rsyslog repo. Directories are mess, because they will contain many
duplicates.
Remember that you'll need to make releases to build into rsyslog packages.
So, development patterns should be similar.
--
Pavel Levshin
15.12.2013 18:00, Boylan, James:
If it is decided to have the documentation locked to a version, I can
easily arrange it so that the specific version of the Rsyslog is detailed
in the generated documentation. Plus I would likely break the source
documentation into directories like rsyslog-docs/v7.4.7-stable,
rsyslog-docs/v7.5.7-devel, rsyslog-docs/v8.1.0-devel, etc.
I will likely focus on 7.4.7-stable as it is the current stable release
and it would be best to start there as it also seems to be the most heavily
used version as well. But coming to a conclusion on how it needs to be
broken down would help a lot in plotting out tasks to complete.
-- James
________________________________________
From: [email protected] [rsyslog-bounces@lists.
adiscon.com] On Behalf Of Pavel Levshin [[email protected]]
Sent: Sunday, December 15, 2013 6:40 AM
To: [email protected]
Subject: Re: [rsyslog] [doc] versioning
15.12.2013 15:51, Boylan, James:
I agree. There is a strong need to identify versions in the
documentation. They question is where to draw the line. David has pointed
out that in the past its just been a matter of noting that certain
functions are available 7.5.8+, etc. Do we want to keep working from that
position? ie Break the documentation out to v7(-stable/-devel)
v8(-stable/-devel) and then do the same 'available in 7.5.8+' syntax? Or do
we want to hard lock the documentation versions to a specific release
version.
The latter is more precise from a documentation perspective and less
work, but the former offers less confusion on what you can and can not do
with a specific version. I can see benefits to both methods, so feedback
on that would definitely be helpful.
As I've said before, latter is best for most documents. What does
"7.5.8+" mean? Is is supported in 7.4.133? Is it present in 8.1.0? The
answers are always not so trivial. Moreover, it is too easy to forget to
write such a tag everywhere. Not every feature has this tag now, right?
By the way, each document (when it is read by an user) should note which
version it describes. It should be a part of template.
--
Pavel Levshin
_______________________________________________
rsyslog mailing list
http://lists.adiscon.net/mailman/listinfo/rsyslog
http://www.rsyslog.com/professional-services/
What's up with rsyslog? Follow https://twitter.com/rgerhards
NOTE WELL: This is a PUBLIC mailing list, posts are ARCHIVED by a myriad
of sites beyond our control. PLEASE UNSUBSCRIBE and DO NOT POST if you
DON'T LIKE THAT.
_______________________________________________
rsyslog mailing list
http://lists.adiscon.net/mailman/listinfo/rsyslog
http://www.rsyslog.com/professional-services/
What's up with rsyslog? Follow https://twitter.com/rgerhards
NOTE WELL: This is a PUBLIC mailing list, posts are ARCHIVED by a myriad
of sites beyond our control. PLEASE UNSUBSCRIBE and DO NOT POST if you
DON'T LIKE THAT.
_______________________________________________
rsyslog mailing list
http://lists.adiscon.net/mailman/listinfo/rsyslog
http://www.rsyslog.com/professional-services/
What's up with rsyslog? Follow https://twitter.com/rgerhards
NOTE WELL: This is a PUBLIC mailing list, posts are ARCHIVED by a myriad
of sites beyond our control. PLEASE UNSUBSCRIBE and DO NOT POST if you
DON'T LIKE THAT.
_______________________________________________
rsyslog mailing list
http://lists.adiscon.net/mailman/listinfo/rsyslog
http://www.rsyslog.com/professional-services/
What's up with rsyslog? Follow https://twitter.com/rgerhards
NOTE WELL: This is a PUBLIC mailing list, posts are ARCHIVED by a myriad of
sites beyond our control. PLEASE UNSUBSCRIBE and DO NOT POST if you DON'T LIKE
THAT.
_______________________________________________
rsyslog mailing list
http://lists.adiscon.net/mailman/listinfo/rsyslog
http://www.rsyslog.com/professional-services/
What's up with rsyslog? Follow https://twitter.com/rgerhards
NOTE WELL: This is a PUBLIC mailing list, posts are ARCHIVED by a myriad of
sites beyond our control. PLEASE UNSUBSCRIBE and DO NOT POST if you DON'T LIKE
THAT.
