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

[Docs] modify CSS to show "parser options" in italic in the Elastic Docs, similar to Github #2263

Open
toby-sutor opened this issue Nov 16, 2022 · 0 comments

Comments

@toby-sutor
Copy link

In our documentation in Github at https://github.com/elastic/beats/blob/8.5/filebeat/docs/inputs/input-filestream-reader-options.asciidoc#ndjson. we can see that the parser (e.g., ndjson) is formatted in a bold mono font.

The parser options (e.g., target) are formatted as a bold italic mono font.

This makes it easy to distinguish between the Parser and the Parser options.

Looking at the resulting document in our docs at https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-input-filestream.html#_ndjson, we can see that the Parser and the Parser Options have the same formatting. They are both bold mono font with the parser options missing the italic formatting.

This makes it harder to read the official document compared to the GitHub document. A customer complained and asked if we can make the Parser Options in our doc italic, too, for easy readability.

GitHub (good formatting):
2022-11-14 13_49_48-github

Elastic Docs (bad formatting):
2022-11-14 13_47_58-Program Manager

Originally filed at https://github.com/elastic/website-requests/issues/840

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

1 participant