Link to changelogs in docs instead of doing blog posts on each release

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

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

評価

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

調査の方向性

まず、ウェブサイト内でリリースに関するブログ投稿と変更履歴のインデックスページを見つけます。リリースへのリンクがどこで管理されているかを確認し、そのうえで、関連するページを更新して、各リリースごとにブログ投稿を必要とするのではなく、変更履歴のインデックスを指すようにします。リリースのドキュメントが変更履歴のインデックスに明確にリンクし、リリースごとのブログ更新が不要になれば完了です。

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

説明

It's been pretty common for us me to forget to do the blog posts for the releases. If we have a feature release cadence of ∼3–4 months, we would end up needing to do this pretty often. The blog posts from the releases often repeat information from the changelog. I'm thinking that instead of having blog posts on each release, we should link to the changelog index page such that we won't need to update the webpage with each release.

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

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

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

PlasmaPy/plasmapy.github.io のほかの issue

PlasmaPy/plasmapy.github.io の issue をすべて見る

似ている issue

Python の issue をもっと見る

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

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