On Thu, Apr 10, 2014 at 11:43 PM, Radu Gheorghe <[email protected]>wrote:
> Hi, > > Here's a tentative ToC, that we can iterate on (because I'm 100% I'm > missing some important stuff): > > TOC page should contain an overview of what rsyslog is and does. For the > "does" part, I think the important bits are: gather data from various > sources, parse, modify, buffer it and send it to various destinations. > > Now for the actual ToC: > * Overview and installation > ** Message flow in rsyslog > ** Legacy configuration format and RainerScript > ** Properties > ** Templates > ** Installation > *** Packages > *** Installing from sources > * Input modules > [list of modules here] > * Message modifier modules > [list of mm* here; maybe also include parsers and string generators? or > should they have their own sections?] > * Queues > ** Overview of how queues work (explain in-memory vs disk vs disk-assisted) > ** Main message queue (options go here) > ** Action queues > * Controlling the flow > ** RainerScript (Data types, expressions, functions go here) > ** Filter conditions > ** Variables > ** Rulesets > * General Options > ** the global() object > ** dropping privileges > * Extending rsyslog > ** native plugins (probably with subsections here) > ** external plugins (probably with subsections here) > * Tutorials > Thanks a lot. I have uploaded it to the repo, where I think it can stick until a TOC is finally implemented. It's easier to discuss IMHO that way than via mail. I've also created a related tracker item: https://github.com/rsyslog/rsyslog-doc/issues/68 I added an "What's rsyslog" chapter. We probably also need to go down into what syslog in general is, as well as other core things. > There are tons of tutorials in the rsyslog doc; there are some on the > rsyslog site and they're not in the doc; and then some in the Wiki. IMO we > should centralize them and organize by use-case (eg: databases, encryption, > reliability...) and put them in one place. Where would that place be? My > initial thought was the rsyslog-doc project, because people can easily > contribute there. But then we might bloat the rsyslog package with > tutorials (which are also harder to maintain, like the Wiki currently looks > ancient). So maybe we should have them as blog posts on the website and > have people contribute them to GitHub? > https://github.com/rsyslog/rsyslog-website > > Then someone can always pull from GitHub and put on the website or > something like that. Any thoughts? > > I need to digest that a bit, but my initial reaction is that this sounds like a good idea. Rainer > > On Tue, Apr 8, 2014 at 9:34 PM, David Lang <[email protected]> wrote: > > > On Tue, 8 Apr 2014, Rainer Gerhards wrote: > > > > Hi all, > >> > >> while I think it is nice to have a toc functionality inside the new doc, > >> the current structure does not look very appealing to me. Probably a > core > >> problem is that we try to squeeze in the existing content and build to > toc > >> out of it. > >> > >> Wouldn't it make sense to sit back a bit and think about how a > >> user-friendly toc would look like, then create it, then move existing > >> content into it (and leave empty spaces empty) and then see if someone > >> fills in the empty spaces? > >> > >> Is someone interested in participating in this work? Any alternatives? > >> > > > > The current ordering of topics and therefor the ToC is definatly 'odd' > > > > setting out a desired ToC is probably a good idea, and will probably show > > us areas that we need to improve on. > > > > David Lang > > > > _______________________________________________ > > 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. > > > > > > -- > Performance Monitoring * Log Analytics * Search Analytics > Solr & Elasticsearch Support * http://sematext.com/ > _______________________________________________ > 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.
