2017-07-25 49 views
3

DocFxを使用して公開されたすべてのAPIドキュメントの中央リポジトリを作成したいと考えています。私はTFSを使って自分のビルドを使ってドキュメントを自動生成し、私のリリース(Octopusを使って)を公開して、複数の個別のサイトに対してうまくいっています。しかし、私は1つの場所でそれを全部引っ張りたい。考えてみると、親サイトを通じて、個々のサイトのいずれかのコンテンツをドリルダウンすることなくフィルタリングできます。これを行う方法についての推奨事項はありますか?DocFxを使用して検索可能なコードドキュメントの中央リポジトリを作成する方法

また、このドキュメントリポジトリでは、私たちのポートフォリオの何百ものプロジェクト全体のすべてのメタデータ(プロジェクトレベルのドキュメント)を検索する機能を提供したいと考えています。これにより、私たちのBA、DEV、およびQAチームは、すべてのシステムがより簡単にアクセスできるようになります。私はDocFxに組み込まれた "フィルタリング"機能が好きですが、私はすべてのメタデータにわたって全文検索をしたいと思っています。この機能についての推奨もありますか?あなたの最初の質問については

+0

DocFXはhttps://lunrjs.comを検索に使用するため、すべての「サブサイト」にわたって検索が機能するように、DocFXを拡張することができます。 – bitbonk

答えて

0

:私はあなたが期待するものだと思う

.NET API Browserのようなものです。このページの背後にあるソースコードは公開されていないため、このページを自分で作成し、複数のサイトからxrefmap.ymlを収集し、必要なデータをこのページに抽出する必要があります。あなたの2番目の質問については

DocFXは、すべての出力ファイルをスキャンし、後で検索用index.jsonと呼ばれるインデックスファイルを生成するLunaを使用しています。あなたの場合、定義したメタデータでのみ検索範囲を制限する必要があります。これはデフォルトでDocFXでもサポートされていません。また、中央の場所にあるLunaを使って、これらのメタを検索することもできます。それぞれのプロジェクトに対して具体的なindex.jsonを作成し、検索ページ用にそれらを収集するセントラルの場所を作成することができます。

関連する問題