Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
ar-daniel opened this issue Nov 18, 2022 · 1 comment

Comments

@ar-daniel
Copy link

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
Copy link

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

.highlight {
    max-width: 75vw;
}

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants