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

未关闭
#2,263 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
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. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

elastic/stack-docs 的其他 Issue

查看 elastic/stack-docs 的全部 Issue

相似的 Issue

更多 Java Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。