python / python/docs-community
Improve documentation search from python.org
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Makefile
- Star
- 55
- Fork
- 26
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Mô tả
Use case
A new user makes a good point that searching python.org is unhelpful: https://www.python.org/search/?q=json.dumps . The search returns "No results found." The current Django python.org search only searches the site's content itself.
Goal
Improve the user experience.
Considerations
The python.org site is a PSF asset and changes to the site would need to be supported by PSF and their infra team.
Possible solutions from least effort to most effort
- Do nothing. Keep the status quo.
- Make the PSF aware of this behavior and ask what they would like to do
- Work with PSF to implement an addition to the search results page on python.org: "If you don't find what you need here, try searching at https://docs.python.org/"
- Add an explicit documentation search button that redirects to docs.python.org's search.
- Develop integrated search on python.org site. This would be a PSF effort.
Summary
For now this is a bit out of scope for the docs-community to tackle alone. Any change would be a joint PSF and CPython docs effort with the PSF taking the lead. cc/ @python/editorial-board
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
- Đọ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.
Hướng nghiên cứu
Bắt đầu bằng việc tái hiện hành vi tìm kiếm Django hiện tại tại python.org/search/?q=json.dumps và so sánh với trải nghiệm tìm kiếm trên docs.python.org. Xem xét các phương án được đề xuất với PSF và nhóm hạ tầng của PSF; công việc chỉ được coi là hoàn tất khi có một phạm vi được thống nhất và được PSF hỗ trợ, chứ không phải khi một thay đổi độc lập của cộng đồng tài liệu được thực hiện.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- django
- Lĩnh vực
- documentation, search
- Loại issue
- Tính năng
- Độ khó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Cần làm rõ
- Mức phù hợp với người mới
- 18/100