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.

Reply via email to