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

Open
#2,263 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
css
Domain
documentation

Research direction

Start with filebeat/docs/inputs/input-filestream-reader-options.asciidoc at the ndjson section and compare its GitHub rendering with the Elastic Docs version at the linked filebeat-input-filestream page. Trace the documentation CSS responsible for parser and parser-option formatting; done means parser options render bold italic mono while parsers remain bold mono.

Written by the indexing model from the issue text.

Description

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

Dominant language
Java
Stars
105
Forks
249
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from elastic/stack-docs

All issues in elastic/stack-docs

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.