Create sphinx elements for markdown detail design
Maintainer thường phản hồi trong vòng 2 ngày
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức phù hợp với người mới
- 65/100
- Loại issue
- Tài liệu
- Độ rõ ràng
- Khá rõ ràng
- Mức độ hoạt động
- Sôi nổi
- Công nghệ
- markdown
- Lĩnh vực
- documentation
Hướng nghiên cứu
Start with score/datarouter/doc/design/logging_architecture.md and inspect the repository's Sphinx documentation entry points to see how existing design documents become linkable elements. Determine whether the markdown should be converted to RST or linked through the current Sphinx setup, then verify that the detailed design is included and traceable from Sphinx.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
What
There are currently some markdown files that explain the detailed design (e.g. https://github.com/eclipse-score/logging/blob/236ae6142efc5f1a2bc34b17a0dc331c5b46f002/score/datarouter/doc/design/logging_architecture.md)
These do not create sphinx elements that can be linked so no architecture traceability.
Acceptance Criteria (DoD)
- Sphinx detailed design is linked.
- Either the markdown is converted to rst or some way of linking sphinx element is done.
How
No response
- Ngôn ngữ chính
- C++
- Star
- 2
- Fork
- 33
- Merge trung bình
- 4 ngày 20 giờ
- Pull request đã merge (30 ngày)
- 23
Chuẩn bị môi trường
Khởi chạy dev container của dự án ngay trên trình duyệt, bằng tài khoản GitHub của bạn.
- Không có Dockerfile hay tệp Docker Compose
- Có mẫu pull request
- Không có hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- 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.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của eclipse-score/logging
-
Outdated documentation of shared memory API usageCó thể đã có người làm @uwe-martin đã nhận 6 ngày trước. Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 76/100
eclipse-score/logging#372 ·
Maintainer thường phản hồi trong vòng 2 ngày
-
Update to Docs-As-Code 8.3.0Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
eclipse-score/logging#339 ·
Maintainer thường phản hồi trong vòng 2 ngày
-
wp:architecture
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
eclipse-score/logging#314 ·
Maintainer thường phản hồi trong vòng 2 ngày
-
wp:architecture
Độ khó 2/5 Nửa ngày Mức phù hợp với người mới 68/100
eclipse-score/logging#312 ·
Maintainer thường phản hồi trong vòng 2 ngày
-
wp:architecture
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
eclipse-score/logging#310 ·
Maintainer thường phản hồi trong vòng 2 ngày
Tất cả issue của eclipse-score/logging
Issue tương tự
-
bug priority: low
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 86/100
chipsalliance/verible#2644 ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 74/100
grafana/pyroscope-dotnet#470 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
documentation P5 XS
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
open-astro/AlpacaBridge#1848 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
DiskANN AnnIterator returns unconverted IP distances after the graph walk runs out of candidatesĐang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
zilliztech/knowhere#1933 ·
Maintainer thường phản hồi trong vòng 1 ngày