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

オープン
#2,263 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

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

調査の方向性

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

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

説明

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

主要言語
Java
スター
105
フォーク
249
30日以内にマージされた PR はありません

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

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

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

elastic/stack-docs のほかの issue

elastic/stack-docs の issue をすべて見る

似ている issue

Java の issue をもっと見る

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

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