Support preview of REST api docs from local instance
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 38/100
- issue の種類
- 機能追加
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- html
- 領域
- api, documentation
調査の方向性
Start by locating the build step that fetches the api-spec from pulp-docs' docs-data branch and the generated website entry point; no file is named in the issue. Define how a local Pulp instance on port 5001 is selected, then verify the served site renders API docs from that local instance.
索引モデルが issue の本文から書いたものです。
説明
Currently the REST Api docs are build from the api-spec fetched from pulp-docs "docs-data" branch.
We should add an option (or automatic behavior) of trying to fetch from a local Pulp instance (like the one on port 5001), so the developer can preview the generated API docs from the pulp-docs served website.
- 主要言語
- HTML
- スター
- 2
- フォーク
- 17
- 平均マージ
- 1時間 8分
- マージ済み PR（30日）
- 1
環境構築
- Dockerfile または Docker Compose ファイルあり
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
pulp/pulp-docs のほかの issue
-
epic
難易度 5/5 1週間以上 初心者へのやさしさ 25/100
-
bug
難易度 3/5 1〜2日 初心者へのやさしさ 48/100
-
documentation
難易度 3/5 1〜2日 初心者へのやさしさ 45/100
-
Add issue templatesオープンenhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 55/100
-
enhancement
難易度 3/5 1〜2日 初心者へのやさしさ 45/100
似ている issue
-
area::tern-sync kind::cleanup triage::ready
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
メンテナーはふだん 1 日以内に返信
-
Atomic append fails to create a missing file対応中かも @harbinresearcher が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
fabiocaccamo/python-fsutil#201 ·
-
Access-request approve silently discards the decider's note (decision_note written only on deny)オープンbug
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
Uuriko/project-room#3378 ·
メンテナーはふだん 1 日以内に返信
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
ENTERPILOT/GoModel#1183 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
cmlarsen/writemorebetter#158 ·
メンテナーはふだん 1 日以内に返信