python / python/docs-community
Improve documentation search from python.org
まだ誰も着手していません。
- 主要言語
- Makefile
- スター
- 55
- フォーク
- 26
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
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
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず、python.org/search/?q=json.dumps で現在の Django の検索動作を再現し、docs.python.org の検索体験と比較します。提案された選択肢を PSF およびそのインフラストラクチャチームと検討してください。完了とみなされるには、独立したドキュメントコミュニティの変更ではなく、合意され PSF に支持されたスコープが必要です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- django
- 領域
- documentation, search
- issue の種類
- 機能追加
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 18/100