rsyslog / rsyslog-doc

documentation for the rsyslog project
Other
98 stars 250 forks source link

Format issue: Documentation text overflows horizontally in certain pages #993

Open ar-daniel opened 1 year ago

ar-daniel commented 1 year ago

Issue - Some pages in https://www.rsyslog.com/doc/v8-stable/ the text overflows horizontally beyond the screen and it is very difficult to scroll sideways back & forth to read content.

setup - Using Firefox (106.x) in Linux, with zoom level 200 (for good font size.)

Expected behaviour - pages to be only vertically scroll-able for comfortable read by setting the max width of html page to browser window size with some padding and wrap the content within this max width. need to horizontally scroll (sideways ) to be avoided

Specific pages that has overflowing content are searched and listed below for easy reference.

In configuration section https://www.rsyslog.com/doc/v8-stable/configuration/converting_to_new_format.html https://www.rsyslog.com/doc/v8-stable/configuration/templates.html https://www.rsyslog.com/doc/v8-stable/configuration/filters.html

https://www.rsyslog.com/doc/v8-stable/rainerscript/variable_property_types.html https://www.rsyslog.com/doc/v8-stable/rainerscript/queue_parameters.html (?)

https://www.rsyslog.com/doc/v8-stable/configuration/parser.html https://www.rsyslog.com/doc/v8-stable/configuration/dyn_stats.html https://www.rsyslog.com/doc/v8-stable/configuration/lookup_tables.html (?) https://www.rsyslog.com/doc/v8-stable/configuration/percentile_stats.html

In tutorials section https://www.rsyslog.com/doc/v8-stable/tutorials/tls_cert_ca.html https://www.rsyslog.com/doc/v8-stable/tutorials/tls_cert_machine.html https://www.rsyslog.com/doc/v8-stable/tutorials/tls_cert_errmsgs.html

https://www.rsyslog.com/doc/v8-stable/tutorials/tls.html https://www.rsyslog.com/doc/v8-stable/tutorials/high_database_rate.html https://www.rsyslog.com/doc/v8-stable/tutorials/recording_pri.html https://www.rsyslog.com/doc/v8-stable/tutorials/log_rotation_fix_size.html (?) https://www.rsyslog.com/doc/v8-stable/tutorials/gelf_forwarding.html https://www.rsyslog.com/doc/v8-stable/tutorials/hash_sampling.html

reference page which is center balanced, and is easier to read https://www.rsyslog.com/doc/v8-stable/configuration/conf_formats.html

Possible root cause - I believe the problem could be with the code snippets section - the pages that have long single line codes in their code block section, makes the width of the webpage also equal to the max length of this code. to have code blocks to be internally scroll-abe horizontally if need be or simply wrap lines to fit to page width.

Please fix the same, I tired to check if i could fix this, but don't know how.

JLCarveth commented 10 months ago

Adding this CSS with my browser devtools seems to fix the width issue:

.highlight {
    max-width: 75vw;
}