私が取り組んでいるプロジェクトの合流ウィキにドキュメンテーションを置きたいのですが、javadocs からドキュメンテーションの一部を自動的に生成したいと考えています。これを簡単にするコンフルエンス用のプラグインはありますか (予備検索では見られませんでした)、代わりに Javadocs に基づいてウィキページをコンフルエンスに投稿するスクリプトを書いた人はいますか? Ant タスクがクールな場合は、wiki をターゲットにすることができます。
3 に答える
Confluence JavaDocs Macrosは、javadocsからwikiページを生成するプラグインです。欠点は、zipアーカイブをjavadocsで作成し、スペースの最初のページに配置する必要があり、複数のjavadocsを同じスペースに共存させることができないことです。
プラグインは、Confluenceのすべてのバージョンと互換性があるわけではありません。
また、ドキュメントをホストするためのConfluenceサーバー(またはConfluenceサーバーがドキュメントの主要な場所)しかない場合は、javadocsをconfluenceに追加することをお勧めします...これは以前に発生したことがあります。
Docs プラグインを使用できます: https://marketplace.atlassian.com/plugins/net.meixxi.confluence.docs.docs-plugin。このプラグインを使用すると、JavaDocs やその他の HTML および JavaScript ベースのコンテンツを Confluence にアップロードして公開できます。
Docs は、公開プロセスを自動化するために REST インターフェイスも提供します。そのため、JavaDoc の公開は、継続的統合プロセスの一部になることができます。技術文書とサンプル コードは、https ://ricebean.net/confluence-docs にあります。
javadoc を編集システムにアップロードするのはなぜですか? これは奇妙に聞こえます。プロジェクト ドキュメントがアップロードされる apache サーバーを作成しました (これは Java から javadoc として作成され、一部のプロジェクト ドキュメント (プロジェクト (SCM 内) にも保存されます) から作成されます)。
その隣には Wiki システムがあり、誰もがあらゆる種類のものを書くことができます。ほとんどの wiki では、外部参照 (Apache Web サーバー、プロジェクト ドキュメント / javadoc ページ) を簡単に作成できます。
これの良いところは、ant / maven / などを介してプロジェクト ドキュメントを再生成し、Web サーバーに自動的にアップロードできることです。赤のみで変更できません。これは、プロジェクト ソースを介してのみ行うことができます。そうでなければ、人々は wiki ページを編集し始め、新しいビルド/リリースが作成されるため、時々置き換えられるため、これは良いことです。