rsyslog / rsyslog-doc

documentation for the rsyslog project
Other
97 stars 248 forks source link

improve doc on rsyslog website #1022

Open rgerhards opened 9 months ago

rgerhards commented 9 months ago

Make the rsyslog doc a better experience on the main web site. This involves a number of steps, most importantly:

In any case, we should still try to blend the doc into the main website header and menu, as this helps to keep consistent.

One way might be to create a sphinx template/theme - but we have no prior experience with that (nor are we sphinx experts).

@alorbach will help with the web integeration

@davidelang FYI

nyov commented 7 months ago

The docs page linked for the current version on the home page (https://www.rsyslog.com/doc/v8-stable/) returns a 404 at this time. Actually, it seems all the pages under /doc/ have been removed?

alorbach commented 7 months ago

Thanks for letting us know, the issue has been fixed.

rgerhards commented 7 months ago

Efforts gains momentum: https://www.rsyslog.com/improving-the-rsyslog-documentation/

More details follow in further postings.