BEACHSIDE BLOG

MicrosoftとかC#を好むレンジャーの個人メモ

Azure DevOps の Tips : Overview に Readme.md または Wiki を表示させる

Azure DevOps の OverviewSummary に「About this project」という部分があります。「About this project」では Description を書くことができるほか、以下のどちらかを表示することができます。

  • 指定したリポジトリーの直下にある Readme.md
  • Wiki のトップページ(Wiki の一番上のページ)

f:id:beachside:20190110140004p:plain

※ 「About this project」は、特定の条件(Azure Repo にリポジトリーがひとつも無いとか)の場合、表示がないこともあります。その場合は、最低限だと、Azure Repos に空のリポジトリーを作れば表示されます。

設定

上図のように「About this project」内の+ Add Project Description ボタン(ボタンの表示がなければ、右上のペンのアイコンをした Edit ボタン)をクリックすると、プロジェクト直下の Readme.md または Wiki のトップページを表示するか選択できます。

f:id:beachside:20190110140640p:plain

  • Readme file を指定する場合、すぐ下のドロップダウンで指定するリポジトリーの直下に Readme.md ファイルがないと設定できません。
  • Wiki を指定した場合、例えば以下のような Wiki だと、一番上のページ「badge sample」のリンクが表示されます。

    f:id:beachside:20190110135417p:plain

    このWiki をリンクさせると、「About this project」は以下のようになります。この例だとちょっと意味が分からんですが、仕事では Wiki が納品ドキュメントであり、トップにはプロジェクトの概要や Wiki の目次が書いてあるので、それを二重管理せず表示できるのは便利と感じてます。

    f:id:beachside:20190110135739p:plain

    また、「Publish code as wiki」で作った Wiki をリンクさせることはできません。



お仕事の納品ドキュメントは基本的に全て Wiki のみを断固貫き、納品は Azure DevOps の Owner を移譲するスタイルなので、こういう機能は地味に便利で好きです。