kkamegawa's weblog

Visual Studio,TFS,ALM関係のことについていろいろと書いていきます。Google Analyticsで解析を行っています

インサイドWiki(TFS/VSTS)

はじめに

TFSとVSTSにはmarkdown形式で記述できるWikiがサポートされました。ドキュメントはあるのですが、私もいくつか勘違いしているところがあったので、ちょっとまとめてみます。

Wikiを作る

f:id:kkamegawa:20170929043533p:plain
Wiki初期ページ

チームプロジェクトのWikiをクリックすると、このような空白ページになります。Create Wikiから作っていきます。

Wikiは階層構造になるので、最初は全体のトップページを作ることになります。

f:id:kkamegawa:20170929043519p:plain
Wiki作成開始

Markdownが使えます。余談ですが、"Markdown supported"のリンクページで解説されているmarkdownの書式は英語ですがとても分かりやすくまとまっています。Saveをクリックすると保存されます。

ちなみに私が使っているVSTSにはまだ来ていないのですが、現在展開中のSprint 123ではプレビューがサイドバイサイドで表示されるようになります。

f:id:kkamegawa:20170929043520p:plain
Wiki更新コメント

保存するとき必ずコメントが入っています。Wikiは内部的にはGitで管理されているので、コメントは必須のようです。

f:id:kkamegawa:20170929043521p:plain
Wiki保存後

保存するとこんな風に表示されます。

ブラウザからのペースト

ちょっとしたTIPSですが、EdgeやChrome(たぶんFirefoxも)などのモダンなブラウザではクリップボードにある画像をサイト側がサポートしていればそのままペーストできます。ちなみにFacebookやTwitterもこの機能に対応しています。

f:id:kkamegawa:20170929043524p:plain
Wikiにブラウザから画像をペースト

Wikiのスクリーンショットをコピーして、ペーストすると、こんな風に自動的に添付ファイルが生成されて、リンクも作られます。

f:id:kkamegawa:20170929043525p:plain
Wiki画像貼り付け結果

保存すると、こんな風にインラインで表示されます。

Gitクライアントで更新する

さっきWikiはGitで管理されていると書きました。ということは、Clone URLもあります。

f:id:kkamegawa:20170929043523p:plain
Wiki Clone URL表示

"More"からCloneをクリックします。ちなみに日本語版TFSでは「複製」となっているので、最初"Copy and Paste"のことかと思っていました。Gitだと理解していないとちょっと思いつかないかもしれません。

f:id:kkamegawa:20170929043522p:plain
Wiki Clone URL

Clone URLが表示されるので、コピーします。

f:id:kkamegawa:20170929043526p:plain
Wiki clone

git クライアントでcloneすると、こんな風にダウンロードされます。これでオフラインで編集して、pushすれば反映されます。リモートブランチはなく、wikiMasterのみのようなので、ローカルブランチ作ってwikiMasterにマージしてプッシュすることになるでしょう。

f:id:kkamegawa:20170929213115p:plain
wikiのブランチ

日本語で作ってしまうと、(当然)日本語のファイル名になるので、macOSの人とやり取りするときは気を付けてください。

.orderというファイルでWikiの階層構造を管理しているようです。これは編集しないでください。

.gitignoreは空っぽでした。画像ファイルとかgit-lfsで管理したくなるかもしれませんが、やらないほうがいいかと思います。

更新履歴

Gitで管理されているということは更新履歴も見えます。

f:id:kkamegawa:20170929043528p:plain
Wiki編集結果

こんな風に段落を追加して、保存します。保存時のコメントももちろん入力必須です(キャプチャとり忘れ…)。

f:id:kkamegawa:20170929043527p:plain
Wiki履歴

Revisiounsをクリックすると履歴が表示されます。

階層構造

Wikiで階層構造も管理できます。

f:id:kkamegawa:20170929222042p:plain
サブページ作成メニュー

ページの横の…リーダーをクリックすると、メニューが表示されます。"Add sub-page"をクリックすると、子階層のページが作成されます。

f:id:kkamegawa:20170929043529p:plain
Wiki子階層のページ

編集もできます。

f:id:kkamegawa:20170929043532p:plain
Wikiサブページ作成

"Set as wiki homepage"をクリックすると、サブページをホームページにできます。

f:id:kkamegawa:20170929043530p:plain
Wiki入れ替え時の警告

リンクがある場合、入れ替えるとリンクが壊れるため、このような警告が表示されます。

f:id:kkamegawa:20170929043531p:plain
Wikiデッドリンク

入れ替えた後、デッドリンクになったアンカーをクリックすると、もちろんリンク先がないので、404ページの代わりに「新しく作るか?」と問い合わせページになります。

まとめ

Wiki便利ですね。ドキュメントをOffice 365とかにおいてストーリーボードでシェアするのもいいですが、内部でバージョン管理されたドキュメントがあると、ファイル消失もないですし、外部と共有しないような簡単なものならこちらでいいでしょう。

さらにほしい機能はまだまだあります。

  • Wikiのコミットを作業項目と関連付けたい(作業項目にコミットハッシュつけてもだめ)
  • Gitで出力できるけど、PDFなどでエクスポートしたい

この辺はフィードバックしているので、実現されるのを期待しています。