elastic / elastic/stack-docs

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

オープン
#2,263 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る
主要言語
Java
スター
105
フォーク
249
PR マージ指標
30日以内にマージされた PR はありません

説明

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](https://user-images.githubusercontent.com/55087308/201930442-71a31585-160c-439f-bc6e-ad377342759d.png)

Elastic Docs (bad formatting):
![2022-11-14 13_47_58-Program Manager](https://user-images.githubusercontent.com/55087308/201930406-d7386c88-6f96-4092-8fcd-598aaaf06bd3.png)

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

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

調査の方向性

filebeat/docs/inputs/input-filestream-reader-options.asciidoc の ndjson セクションから始め、GitHub でのレンダリングを、リンク先の filebeat-input-filestream ページにある Elastic Docs 版と比較します。parser と parser-option のフォーマットを担っているドキュメント用 CSS を追跡します。完了条件は、parser のオプションが太字斜体の等幅フォントで表示され、parser は太字の等幅フォントのままになることです。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
css
領域
documentation
issue の種類
ドキュメント
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
35/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。