testcontainers / testcontainers/testcontainers-python

Bug: No link to new docs from this repo?

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

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

主要言語
Python
スター
2.3k
フォーク
386
平均マージ
4時間 40分
マージ済み PR(30日)
1

説明

Describe the bug

Pull request #822 created a nice-looking docs site. But coming to this repo, I see links to the now almost-empty old docs: https://testcontainers-python.readthedocs.io/en/latest/

Shouldn't we be sending people to the new docs?

I see python.testcontainers.org isn't live yet. I used to be able to see a list of containers: https://testcontainers-python.readthedocs.io/en/testcontainers-v4.2.0/

Now I don't see them: https://testcontainers-python.readthedocs.io/en/testcontainers-v4.12.0/modules/index.html

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

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

はじめの一歩

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

調査の方向性

Pull request #822 とリポジトリの現在のドキュメントリンクを確認し、issue で参照されている古い Read the Docs ページと比較します。新しいサイトをどこにリンクすべきか、またコンテナ一覧をそこに配置する必要があるかを確認します。訪問者が新しいドキュメントに誘導され、想定されるコンテナ一覧が利用可能になっているか、または残っている制限が文書化されていれば完了です。

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

評価

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

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

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