no mention of project deprecation in the docs

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

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

評価

難易度
1/5
見積もり時間
1時間未満
初心者へのやさしさ
55/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
停滞
技術スタック
elixir
領域
documentation

調査の方向性

https://hexdocs.pm/distillery/home.html の Distillery ドキュメントを開き、メインのランディングページまたは導入セクションを特定します。プロジェクトがアーカイブ済みまたは非推奨であることを示す、短く目立つ注記を追加し、その注記がドキュメントのホームページからアクセスした人に表示されることを確認します。

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

説明

Steps to reproduce

Go to the distillery docs at https://hexdocs.pm/distillery/home.html, note that the docs look very much alive and make no mention of the project being archived.

Description of issue

Some people (like me today, for instance) are likely to waste a lot of time reading the docs, only to find that Distillery isn't working anymore. It might be benefitial to add a short mention about deprecation to the docs, since the docs are the first place where people land after searching.

主要言語
Elixir
スター
3k
フォーク
397
PR マージ指標
30日以内にマージされた PR はありません

環境構築

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

はじめの一歩

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

bitwalker/distillery のほかの issue

bitwalker/distillery の issue をすべて見る

似ている issue

Elixir の issue をもっと見る

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

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