Docs: Autogenerate threats into docs

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

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

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

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
48/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
静か
技術スタック
python
領域
documentation

調査の方向性

まず pytm/threatlib/threats.json と docs/threats.md を読み、続いてリンクされている MkDocs のディスカッションと関連する issue #279 を確認します。対応済みの脅威データからドキュメントが生成され、脅威エントリを手動で重複して記述する必要がなくなれば、作業は完了です。

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

説明

If we#d use mkdocs for generating docs we could use the approach represented in https://github.com/mkdocs/mkdocs/discussions/3487#discussioncomment-7681213 potentially to free our self from manually updating supported threats defined in https://github.com/OWASP/pytm/blob/master/pytm/threatlib/threats.json into https://github.com/OWASP/pytm/blob/master/docs/threats.md .

Would this be helpful @Dakes @nineinchnick ?

This idea would align with other ideas like #279 .

主要言語
Python
スター
1.2k
フォーク
237
平均マージ
4日 2時間
マージ済み PR(30日)
9

環境構築

Codespaces で開く

このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。

はじめの一歩

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

OWASP/pytm のほかの issue

OWASP/pytm の issue をすべて見る

似ている issue

Python の issue をもっと見る

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

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