オントロジー提案

オントロジー提案では、オントロジーのメインバージョンに基づいたブランチでオントロジーに変更を加えることができます。このプロセスにより、すべての変更がレビューされ、承認されるまでメインのオントロジーに組み込まれないことが保証されます。

Foundry でのブランチについて詳しく知る。

定義

• ブランチ：オントロジーの ブランチ は、そのオントロジーの別バージョンであり、メインバージョンから派生し、実験や変更を行ってもメインブランチに影響を与えないように設計されています。これにより、ユーザーはオントロジーに対する調整を分離した環境でテストし、洗練させることができます。

• 提案：提案 は、オントロジーのブランチに特化したバージョン管理システムのプルリクエストに相当します。提案はブランチと共に自動的に作成され、メインブランチにマージされる変更のレビュー、名前、説明などのメタデータが含まれます。提案は、別のブランチで行われた変更をレビューし、承認するための仕組みとして機能します。

提案のワークフロー

1. ブランチを作成する

ブランチを作成 を選択してダイアログを開き、提案のタイトルと説明を選択することで、ブランチを作成できます。

また、オントロジーに既に変更がある場合で、それらを提案に含めたい場合は、保存を選択し、保存ダイアログから 変更を提案する を切り替えることができます。

メインブランチにいる場合で、変更がない場合は、ブランチ選択コンポーネントを選択して、新しいブランチに名前を入力することで、ブランチを作成できます。

提案のブランチは、メインのオントロジー設定でのみ作成できます。他の提案に基づいて新しいブランチを作成することはできません。

ブランチにいる間、ワークスペースインターフェースの上部にあるブランチナビゲーショントップバーに現在のブランチが表示されます。

2. レビューのために提案を準備する

この時点で、提案を作成した方法によっては、ブランチにすでにいくつかの変更があるかもしれません。ブランチにいる間、オントロジーのリソースに変更を加えることができます。これには、作成や削除も含まれます。

変更されたオントロジーのエンティティは、提案内の別々の タスク として構成され、レビューが可能になります。

オントロジーの役割 に移行したリソースでは、ビューアは提案のリソースに対して変更を加えることができます。リソースがデータソースから派生した権限にある場合、提案ではエディタまたはオーナーのみがそれらに変更を加えることができます。

3. レビューをリクエストする

ブランチに変更を加えた後、提案にレビュアーを追加することができます。これを行うには、提案ビュー に移動し、トップバーにある 提案の詳細を開く を選択します。

ブランチを終了した場合、提案 タブに移動して提案を選択するか、ブランチ選択コンポーネントを使用して提案の概要にアクセスできます。

そこから、レビュアー セクションでレビュアーを割り当てます。

提案が In review の段階になるまで、レビュアーに通知されません。

4. 提案をレビューする

レビュアーは、レビュー タブで個々のタスクを承認または拒否し、レビューをサポートするためにコメントを追加することができます。

変更を承認するには、レビュアーはリソースのオーナーまたはエディタである必要があります。

権限のないユーザーは、タスクをレビューすることはできますが、例えば、変更に対する意見を伝えるためにレビューを行うことができますが、これはタスクの承認状態に影響を与えません。

提案の作成者がすべての編集済みリソースにオーナーまたはエディタの権限を持っている場合、自分の変更を承認することができます。

5. 提案をリリースする

変更がレビューされ、承認された後、提案はオントロジーにマージすることができます。

提案がマージされると、レビュー中 セクションからサイドバーの マージ済み セクションに移動します。

提案をマージする前の任意の時点で、サイドバーから 削除 を選択して提案を閉じることができます。

提案は、メインのオントロジー設定にのみマージできます。

提案は自動的に元に戻すことはできません。提案を元に戻すには、それに含まれるさまざまな変更を元に戻す必要があります。

提案のナビゲーション

• ブランチナビゲーションバー：ブランチを編集しているときにワークスペースの上部に表示されます。ここから次の操作ができます。

  • メインブランチに戻る (1)
  • 提案の詳細を表示する (2)
  • ブランチセレクタを使用して特定のブランチに移動する (3)

• ブランチの選択：オントロジーマネージャーのホームページのブランチセレクターセクションから、編集や表示するブランチを選択できます。

• 提案タブ： 提案タブからは、異なるステータスの提案を表示することができます。ステータスの定義は以下の通りです。

  • 自分が作成した提案：あなたが作成した提案。
  • 自分に割り当てられた提案：あなたがレビュアーとして割り当てられた提案。
  • レビュー中の提案：進行中または承認された提案。
  • マージされた提案：オントロジーにマージされた提案。
  • 閉じられた提案：閉じられ、マージされなかった提案。

  

• 提案ビュー：概要、レビュー、チェンジログのタブを選択して、提案に関する詳細情報を確認できます。

提案ビュー

提案の概要では、提案に関する情報が一元化されており、現在の段階、行われた変更、レビューが必要なタスク、選択されたレビュアーが表示されます。現在編集中の提案のこのビューにアクセスするには、トップバーにある 提案の概要に移動 を選択します。任意の提案の概要ページにアクセスするには、提案 タブに移動し、表示したい提案を選択します。

• 提案の段階：提案の最初の段階は、準備段階です。レビューを依頼する を選択して、提案を レビュー中 の段階に移動させます。すべてのタスクがレビューされ、承認された後、提案は最後の段階である 提案をマージする に移ります。この時点から、同じオプションを使用してメインのオントロジーに変更をマージできます。

• ブランチ上の変更を表示する：編集内容は、概要ページの下部に表示されます。編集は、作成者とタスクによってカテゴライズされ、タスクはオントロジーのリソースに対応します。変更を表示し、リソースに移動するか、その変更を破棄することができます。変更の履歴は、チェンジログ タブからもアクセスできます。ここでは、変更が行われた正確なタイミングも表示されます。

• レビュアーを表示および追加する：特定の同僚を提案のレビューに割り当てます。レビュアーは、提案がレビュー段階に移動した後にのみ通知されます。

• 注意が必要なタスクを表示する：このセクションでは、レビュー段階で拒否されたすべてのタスクが表示されます。

提案のリンクをコピーして、簡単に仲間と共有できます。

レビュー

レビュータブには、提案内のすべてのタスクが表示されます。 ここから、次の操作ができます。

• 各タスクの詳細を展開して、変更された内容を確認する
• タスクレベルでコメントを残し、仲間と協力する
• タスクレベルでタスクを承認または拒否する、またはすべての対象タスクに対して一括で承認または拒否する
• 追加のレビュアーをリクエストする

チェンジログ

チェンジログタブには、ブランチ上の変更履歴が詳細に表示されます。特定のユーザーが特定の時点で行った編集を明らかにするために、タスクを展開することができます。また、関連するオントロジーのリソースに直接移動することもできます。

提案の権限

• 提案を表示する：提案のタイトルと説明は、オントロジーにアクセスできるすべてのユーザーによって検索可能です。提案内のリソースに少なくともビューアアクセスがあるユーザーは、それらのリソースに関連する変更を表示できます。

• 提案を作成する：オントロジーにアクセスできるすべてのユーザーは、提案を作成できます。

• ブランチを編集する：作成者と、提案内の編集済みリソースのいずれかにエディタまたはオーナーの権限を持つユーザーは、ブランチを編集できます。

• ブランチ上のエンティティを編集する：ブランチを編集できる人（上記参照）で、以下のいずれかの条件を満たす人は、ブランチ上のリソースを編集できます。

  • リソースに対して編集またはそれ以上の権限がある。
  • リソースに対してビューアの権限があり、リソースがオントロジーの役割を使用している。

• 提案内のタスクを承認または拒否する：誰でも変更を承認または拒否したり、提案にコメントを残すことができます。タスクが承認されたとしてカウントされるためには、承認者はリソースのオーナーまたはエディタである必要があります。

• 提案をリリースする：提案が承認された後、ブランチを編集できる人は誰でも、提案をリリースできます。

提案の設定

オントロジー提案は、デフォルトでは無効になっています。組織の管理者は、コントロールパネルのオントロジー設定で、組織にこの機能を有効にすることができます。