Improve installation page to simplify and direct users to installation method

オープン
#960 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 2 日以内に返信

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
35/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
停滞
領域
documentation

調査の方向性

The issue discusses the installation page but does not name its file or tests. Find the page that presents the Python and bundle/app installation routes, then read its surrounding navigation and content. Update the page to make Python the primary route and the bundle/app a clear alternative; done when users can tell which route is recommended.

索引モデルが issue の本文から書いたものです。

説明

content

I mean that to very few people reading this page are the two options of equal value.
So to me it makes more sense to be opinionated and pick one route -- the Python one right now -- and then provide the other route -- the bundle/app right now -- as the clear alternative.

Having two tiles like that makes sense on the homepage or in on a quick-start page or some other page where other content will continue (so the tiles are the "go install, here's two options, come back when done"). But this is already the installation page that the user actively selected, so I think having a tile that does nothing is just weird. In general I think sometimes we try to present too many options at once, each as equivalent, rather than a clear main way, with perhaps an alternative.

(I love the admonitions because I love color. In Caldeum color means wealth!)

Originally posted by @psobolewskiPhD in https://github.com/napari/docs/issues/958#issuecomment-4087454247

主要言語
Makefile
スター
13
フォーク
71
平均マージ
3日 11時間
マージ済み PR(30日)
30

環境構築

  • Dockerfile・Docker Compose ファイルなし
  • プルリクエストのテンプレートあり
  • コントリビューションガイドなし

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

napari/docs のほかの issue

napari/docs の issue をすべて見る

似ている issue

Documentation の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。