On Sat, 6 Jan 2024, Rainer Gerhards via rsyslog wrote:
Hi all,
thanks for the great feedback!
Any help is appreciated. I am actually looking for four kind of things
right now in regard to the core doc:
* how would a beginner's guide structure best be? What do we need to
describe for someone new to rsyslog and syslog?
* suggestions for restructuring the reference manual
I think in general, the per-module pages are fairly good. (listing each option,
it's defaults, the legacy format and a brief description)
I think we need to add (either as a link, or as a block) the options that are
inherited (i.e. the things that every action has, queues, name, etc)
I think the other thing is to have multiple pages that link to the per-module
pages, one in simple alpha order and one or more that do so by category
I think it would be good to bring back some of the legacy examples to the pages
(they were purged a few revisions ago in an effort to encourage the new format,
but that puts people in a bit of a bind when looking at old configs and
understanding them)
the properties/variables pages need to be re-written. They are currently several
pages based on how the variables/properties evolved in rsyslog, I think a
re-write that starts off with an explination that ignores that history and talks
about how they are used (and then has a history section at the bottom or as a
link) would be better
I'll comment more as I think of things
David Lang
* what would be good FAQ items?
* thinking about news-/blog-like content: what type of postings would
you like to see on rsyslog.com
As a side-note, we have run into an issue with our wordpress theme,
which is currently under evaluation: That's a show stopper for further
web site updates. I assume we'll solve that early next week.
Thanks again,
Rainer
El vie, 5 ene 2024 a las 19:57, Johan Ryberg (<jo...@securit.se>) escribió:
Wonderful! It was hard to navigate and I think I had to reach out for help a
couple of times just because of the documentation.
You will benefit from this in the end 😀
Best regards Johan Ryberg
Den tors 4 jan. 2024 18:01Peter Portante via rsyslog
<rsyslog@lists.adiscon.com> skrev:
On Thu, Jan 4, 2024 at 11:31 AM Rainer Gerhards via rsyslog
<rsyslog@lists.adiscon.com> wrote:
>
> Hi all,
>
> happy new year to everyone!
>
> I think I have some good news. I have initiated a new project to
> enhance doc and rsyslog website. Initial announcement is here:
>
> https://www.rsyslog.com/improving-the-rsyslog-documentation/
Happy New Year!
This is great news!
-Peter
>
> More details follow in further postings. As you may guess, some
> generative AI will be involved. I tested it in regard to doc writing
> etc the past weeks and there are good results. But there is a lot to
> tell, and this is a topic for upcoming postings. Just so that you
> know: I do not intend to let it automatically generate the doc - that
> would fail miserably. :-)
>
> Rainer
> _______________________________________________
> rsyslog mailing list
> https://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
https://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
https://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
https://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.
