elastic / elastic/stack-docs

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

Đang mở
#2,263 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Ngôn ngữ chính
Java
Star
105
Fork
249
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Mô tả

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

Hướng dẫn đóng góp

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

Bắt đầu với filebeat/docs/inputs/input-filestream-reader-options.asciidoc tại phần ndjson và so sánh cách hiển thị trên GitHub với phiên bản Elastic Docs trên trang filebeat-input-filestream được liên kết. Truy vết CSS của tài liệu chịu trách nhiệm định dạng parser và parser-option; hoàn tất nghĩa là các tùy chọn parser được hiển thị bằng kiểu chữ mono đậm nghiêng, trong khi các parser vẫn giữ kiểu chữ mono đậm.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
css
Lĩnh vực
documentation
Loại issue
Tài liệu
Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
35/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.