Ontology Proposals

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

Foundry でのブランチングについて詳しくはこちらをご覧ください。

定義

• ブランチ: オントロジーのブランチは、メインバージョンから派生したオントロジーの別バージョンであり、メインブランチに影響を与えずに実験や変更を可能にします。これにより、ユーザーはオントロジーに対する調整を隔離された環境でテストし、改良することができます。

• 提案: 提案は、バージョン管理システムのプルリクエストに類似しており、特にオントロジーのブランチ用に調整されています。提案はブランチと共に自動的に作成され、レビュー、名前、変更の説明などのメタデータを含みます。提案は、別のブランチで行われた変更をメインのオントロジーに統合する前にレビューおよび承認するためのメカニズムとして機能します。

提案のワークフロー

1. ブランチを作成

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

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

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

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

ブランチ上では、ワークスペースインターフェースの上部にあるブランチナビゲーショントップバーが現在のブランチを反映します。

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

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

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

Ontology roles を使用するように移行されたリソースについては、ビューアーが提案内のリソースに変更を加えることができます。リソースがデータソース由来の権限を持っている場合、編集者または所有者のみが提案内でそれらに変更を加えることができます。

3. レビューを依頼

ブランチに変更を加えた後、提案にレビュアーを追加できます。これを行うには、トップバーにある Open proposal details を選択して Proposal view に移動します。

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

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

提案が In review ステージになるまでレビュアーには通知されません。

4. 提案をレビュー

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

レビュアーは変更を承認するために所有者または編集権限を持っている必要があります。

権限を持っていないユーザーもタスクをレビューできますが、変更に対する意見を伝えるためのものであり、タスクの承認ステータスには影響を与えません。

提案の作成者が編集されたすべてのリソースに所有者または編集者の権限を持っている場合、自分の変更を承認することができます。

5. 提案をリリース

変更がレビューおよび承認されたら、提案をオントロジーにマージできます。

提案がマージされると、サイドバーの In Review セクションから Merged セクションに移動します。

提案をマージする前であれば、いつでもサイドバーから delete を選択して提案を閉じることができます。

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

提案は自動的に元に戻すことはできません。提案を元に戻すには、提案内の異なる変更を元に戻す必要があります。

提案のナビゲーション

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

• メインブランチに戻る (1)

• 提案の詳細を表示 (2)

• ブランチセレクターを使用して特定のブランチに移動 (3)

• ブランチの選択: Ontology Manager のホームページのブランチセレクターセクションから、直接編集または表示するブランチを選択します。

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

  • My proposals: ユーザーが作成した提案。
  • Assigned to me: ユーザーがレビュアーとして割り当てられた提案。
  • In review: 進行中または承認された提案。
  • Merged proposals: オントロジーにマージされた提案。
  • Closed proposals: 閉じられた提案で、マージされなかったもの。

  

• Proposal View: 提案に関する情報を表示するための Overview、Reviews、および Changelog タブにアクセスします。

Proposal view

Proposal Overview は、提案に関する情報を集約し、そのステージ、行われた変更、レビューが必要なタスク、および選択されたレビュアーを含みます。現在編集している提案のこのビューにアクセスするには、トップバーにある Go to proposal overview を選択します。任意の提案の概要ページにアクセスするには、Proposals タブに移動し、表示したい提案を選択します。

• 提案のステージ: 提案の最初のステージは Preparing ステージです。Ask for review を選択して提案を In Review ステージに移動します。すべてのタスクがレビューおよび承認されると、提案は最終ステージ Merge proposal に移動します。このポイントから、同じオプションを使用して変更をメインのオントロジーにマージできます。

• ブランチ上の変更を表示: 編集は Overview ページの下部に表示されます。編集は著者およびタスクごとに分類され、タスクはオントロジーリソースに対応します。変更を表示し、リソースに移動するか、その変更を破棄できます。変更の履歴は Changelog タブからもアクセスでき、変更の正確なタイミングも表示されます。

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

• 注意が必要なタスクの表示: このセクションには、レビュー段階で却下されたすべてのタスクが表示されます。

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

Reviews

Reviews タブには提案内のすべてのタスクが表示されます。 ここから、以下の操作を行うことができます。

• 各タスクの詳細を展開して変更内容を確認
• タスクレベルでコメントを残し、同僚と共同作業
• タスクをタスクレベルで、またはすべての適格タスクに対して一括で承認または却下
• 追加のレビュアーを要求

Changelog

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

提案の権限

• 提案の表示: 提案のタイトルと説明はオントロジーにアクセスできるすべての人に表示されます。提案内のリソースに少なくともビューアーアクセスを持つユーザーは、それらのリソースに関連する変更を確認できます。

• 提案の作成: オントロジーにビューアーアクセスを持つ誰でも提案を作成できます。

• ブランチの編集: 提案の作成者、および提案内の編集されたリソースに対して編集者または所有者の権限を持つユーザーは、ブランチを編集できます。

• ブランチ上のエンティティの編集: ブランチを編集できる人（上記参照）は、そのエンティティに少なくともビューアーアクセスを持っている場合、そのブランチ上のエンティティを編集できます。

• 提案内のタスクの承認または却下: 誰でも提案の変更を承認または却下したり、コメントを残したりできます。タスクが承認されたと見なされるには、承認者が基礎となるリソースの編集者または所有者である必要があります。

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

提案の設定

Ontology Proposals はデフォルトで無効になっています。組織の管理者は、Control Panel のオントロジー設定でこの機能を組織に対して有効にできます。

Ontology Proposals は以下の場合にユーザーに利用可能になります。

1. ユーザーの主要な組織に対して Ontology Proposals が有効化されている。
2. 主要な組織が Control Panel のスペースアクセス要件を使用してオントロジーに追加されている。
3. ユーザーがオントロジーにアクセスできる。

ユーザーの主要な組織が Ontology Proposals を無効にしている場合、組織のゲストユーザーには Ontology Proposals は利用できません。これは、ユーザーがゲストである組織が Ontology Proposals を有効にしている場合でも同様です。

例えば:

• User A は Org X を主要な組織としている。
• User B は Org Y を主要な組織としている。
• Org X は Ontology Proposals を有効にしている。
• Org Y は Ontology Proposals を有効にしていない。
• Space Z は Control Panel のアクセス要件に Org X と Org Y の両方をリストしている。
• User A は Space Z オントロジー、Ontology Z で Ontology Proposals を見ることができる。
• User B は Ontology Z で Ontology Proposals を見ることが できない。
• User B が Org X のゲストであっても、Ontology Z で Ontology Proposals を見ることはできない。