Investigate how to build other REST API generated docs

オープン
  • 何か問題がありますか？
#3,428 コメント 2 件 リアクション 0 件 担当者 0 名 GitHub で見る

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

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

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
25/100
issue の種類
ドキュメント
明瞭さ
説明が足りない
活発さ
停滞
技術スタック
openapi
領域
documentation

調査の方向性

リンクされているKCページのOpenAPI REST APIドキュメントとautogen epic (#2615)をまず確認し、Batch REST APIsとJMX REST Connector REST APIsが現在どのように構築されているかを判断します。調査結果についてMichalおよびAlasdairと話し合います。完了条件は、構築方法を文書化し、これらのドキュメントをOpen Libertyのドキュメントに統合するための優先順位付けされたフォローアップissueを作成することです。

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

説明

As well as the Liberty API/SPI docs that we've discussed previously (and mentioned in the autogen epic), there are some OpenAPI REST API docs in the KC that Alasdair has previously said do need to come over the OL docs. These are API docs generated by OpenAPI for APIs that are provided to use with Liberty (Batch REST APIs, and JMX REST Connector REST APIs) (so, to be clear, this has nothing to do with the OL support for MicroProfile OpenAPI etc).

Alasdair's comment when we first audited the KC, was that we need to start by finding out how the KC is currently building these docs. Then, talk to Michal about how we get these docs built into the OL docs, and will probably need an issue creating then like we have for the API/SPI docs. That issue should probably be added to the autogen epic and prioritised with Alasdair against the other issues listed there.

主要言語
言語のデータがありません
スター
14
フォーク
58
平均マージ
1時間
マージ済み PR（30日）
25

環境構築

はじめの一歩

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

OpenLiberty/docs のほかの issue

OpenLiberty/docs の issue をすべて見る

似ている issue

Documentation の issue をもっと見る

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

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