Git Product home page Git Product logo

Comments (7)

mbiebl avatar mbiebl commented on June 2, 2024

Thinking about this a bit more "Compatibility" seems to more about compatibility to other syslog implementations, namely the old, venerable sysklogd.

The v_compatiblity.html pages are more like an upgrade checklist when doing upgrades from older *rsyslog_ versions. Maybe a dedicated section titles something like "Upgrades" would be a better fit.

from rsyslog-doc.

mbiebl avatar mbiebl commented on June 2, 2024

I think this is pretty important.
Could those compat notes please be hooked up in the new documentation?

from rsyslog-doc.

rgerhards avatar rgerhards commented on June 2, 2024

You mean the old sysklogd stuff should be moved to the vXcompatibility notrs section?

from rsyslog-doc.

mbiebl avatar mbiebl commented on June 2, 2024

If you look at the current http://www.rsyslog.com/doc/master/#sponsors-and-community web page, it has "If you are upgrading from rsyslog v2 or stock sysklogd, be sure to read the rsyslog v3 compatibility notes, and if you are upgrading from v3, read the rsyslog v4 compatibility notes and if you upgrade from v4, read the rsyslog v5 compatibility notes."

That information does not belong there, but someplace else, e.g. under http://www.rsyslog.com/doc/master/#compatibility or a new section.

Also, the list is incomplete for v8. it misses v6, v7 and v8 compat notes.

For better readability, I'd also suggest to use an itemized list then a single sentence.

from rsyslog-doc.

rgerhards avatar rgerhards commented on June 2, 2024

That's a left-over, will remove it. The compatibility docs live here: http://www.rsyslog.com/doc/master/compatibility/index.html

from rsyslog-doc.

rgerhards avatar rgerhards commented on June 2, 2024

The whole "compatibilty" section on that main page was also junk. The import seems to have merged wildly... Have removed that as well.

from rsyslog-doc.

mbiebl avatar mbiebl commented on June 2, 2024

Ok, the http://www.rsyslog.com/doc/master/compatibility/index.html page looks certainly a lot better structured.

The only complaint/remark I'd have is that it's a bit hard to spot/find in the TOC or start page and it's a bit oddly named.
It's listed under Reference : Compatibility

I would be looking for such a document under "what to consider when updating the software".
E.g. owncloud uses
http://doc.owncloud.org/server/6.0/admin_manual/maintenance/update.html
I think a structure like this would be more intuitive

from rsyslog-doc.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.