Possibly incorrect link to main page from "Templates generator"?
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 2/5
- Thời gian dự kiến
- 1-3 giờ
- Mức phù hợp với người mới
- 35/100
- Loại issue
- Tài liệu
- Độ rõ ràng
- Đặc tả rõ ràng
- Mức độ hoạt động
- Đình trệ
- Lĩnh vực
- documentation
Hướng nghiên cứu
Bắt đầu với docs/source/utilities/yaml_generator.rst và kiểm tra tham chiếu :backends_content:, sau đó so sánh vị trí của tham chiếu này trong docs/source/index.rst với docs/source/utilities/templates.rst. Xác minh rằng tham chiếu trỏ đến các YAML templates thay vì trang chính; hoàn tất khi liên kết Templates generator được render mở đúng tài liệu templates dự kiến.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
The use of the reference :backends_content in this line: https://github.com/DiamondLightSource/httomo-backends/blob/a34bf5802fc541ef5a0c541377b000ce596882aa/docs/source/utilities/yaml_generator.rst?plain=1#L5
appears to be wanting to link to the YAML templates that have been generated.
However, while the text of the link is what is expected for a link to YAML templates:
it actually links to the main page, which doesn't seem like what would be intended?
The linking to the main page is likely due to the reference being put in index.rst: https://github.com/DiamondLightSource/httomo-backends/blob/a34bf5802fc541ef5a0c541377b000ce596882aa/docs/source/index.rst?plain=1#L3-L9
and should instead be moved to somewhere in the templates.rst file.
- Ngôn ngữ chính
- Python
- Star
- 0
- Fork
- 1
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Chuẩn bị môi trường
Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.
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 DiamondLightSource/httomo-backends
-
Unnecessary `toml` dependencyĐang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 65/100
-
documentation
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 35/100
-
documentation question
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 25/100
DiamondLightSource/httomo-backends#10 · 2 bình luận ·
-
documentation
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 45/100
Tất cả issue của DiamondLightSource/httomo-backends
Issue tương tự
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
PolicyEngine/policyengine-us#10262 ·
Maintainer thường phản hồi trong vòng 2 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 74/100
kellyjonbrazil/jc#788 ·
Maintainer thường phản hồi trong vòng 2 ngày
-
bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
Maintainer thường phản hồi trong vòng 1 ngày
-
`/search.json` ignores the documented `editions.sort` parameterCó thể đã có người làm @PranavD2905 đã nhận hôm nay. Đang mởAffects: Server Good First Issue Module: Solr Needs: Triage Theme: Public APIs Theme: Search
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 74/100
internetarchive/openlibrary#13989 · 1 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày
-
bug P2: misleading query
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 62/100
jeffknupp/association#478 ·