Skip to content

Commit

Permalink
Add new view service home pages
Browse files Browse the repository at this point in the history
Signed-off-by: Mandy Chessell <mandy.e.chessell@gmail.com>
  • Loading branch information
mandy-chessell committed Apr 16, 2024
1 parent 7727e07 commit 2be9166
Show file tree
Hide file tree
Showing 17 changed files with 444 additions and 221 deletions.
13 changes: 13 additions & 0 deletions site/docs/concepts/digital-product.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
hide:
- toc
---

<!-- SPDX-License-Identifier: CC-BY-4.0 -->
<!-- Copyright Contributors to the Egeria project. -->

# Digital Product

A *digital product* is a [collection](/concepts/collection) of [assets](/concepts/asset) that describe a collection of resources that have been designed to meet a specific consumer need.

--8<-- "snippets/abbr.md"
1 change: 1 addition & 0 deletions site/docs/concepts/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@
- [Design Model OMAS](/services/omas/design-model/overview)
- [DevOps OMAS](/services/omas/dev-ops/overview)
- [Digital Architecture OMAS](/services/omas/digital-architecture/overview)
- [Digital Product](/concepts/digital-product)
- [Digital Resource](/concepts/digital-resource)
- [Digital Resource Connector](/concepts/digital-resource-connector)
- [Digital Service](/practices/digital-services/overview)
Expand Down

Large diffs are not rendered by default.

21 changes: 21 additions & 0 deletions site/docs/services/omvs/data-discovery/overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
hide:
- toc
---

<!-- SPDX-License-Identifier: CC-BY-4.0 -->
<!-- Copyright Contributors to the Egeria project. -->

--8<-- "snippets/content-status/in-development.md"

# Data Discovery OMVS

The Data Discovery Open Metadata View Services (OMVS) is a REST API designed to support user interfaces (UIs) for documenting specifications that describe the data needed for a project. These are known as DataSpecs and they can be used to specify schemas for data pipelines as well as saved searches.

---8<-- "snippets/abbr.md"






5 changes: 4 additions & 1 deletion site/docs/services/omvs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,13 @@ The view services are as follows:
| [Asset Catalog](/services/omvs/asset-catalog/overview) | **Search for assets.** | The Asset Catalog OMVS provides search and query capabilities for tools and applications to support an asset catalog function. It supports search requests for assets with specific characteristics and returns summaries of the matching assets, plus methods to allow drill-down into the details of a specific asset to related metadata. |
| [Feedback Manager](/services/omvs/feedback-manager/overview) | **Maintain feedback such as comments, tags, reviews, likes and note logs.** | The Feedback Manager OMVS is for user interfaces supporting feedback from users. A registered user is able to add comments, informal tags, notes, reviews and likes to elements such as assets or glossary terms. |
| [Collection Manager](/services/omvs/collection-manager/overview) | **Manage collections of assets and other elements.** | The Collection Manager OMVS provides the REST APIs to create collections of asset and other elements such as glossary terms or policies. The collections can be nested (like folders in a file system) and they can be classified to describe the type of collection. For example, one type of classification for a collection is a *DigitalProduct* that allows the collections of assets and other related material to describe data and or services for a specific consumer or purpose. |
| [Automated Curation](/services/omvs/automated-curation/overview) | **Set up and monitor automated harvesting and governance services.** | The Automated Curation OMVS is for user interfaces that allows asset owners and consumers to set up, execute and monitor automated harvesting and governance services. |
| [Automated Curation](/services/omvs/automated-curation/overview) | **Discovery, initiate and monitor metadata cataloging and governance actions such as automated surveying.** | The Automated Curation OMVS is for user interfaces that allows asset owners and consumers to set up, execute and monitor automated harvesting and governance services. |
| [Data Discovery](/services/omvs/data-discovery/overview) | **Documenting specifications that describe the data needed for a project.** | The Data Discovery Open Metadata View Services (OMVS) is a REST API designed to support user interfaces (UIs) for documenting specifications that describe the data needed for a project. These are known as DataSpecs and they can be used to specify schemas for data pipelines as well as saved searches. |
| [Governance Author](/services/omvs/governance-author/overview) | **Create and maintain governance actions.** | The Governance Author OMVS is for user interfaces supporting the governance team to set up governance definitions and actions. |
| [Notification Manager](/services/omvs/notification-manager/overview) | **Locate, retrieve and update the types of user notifications that should be produced.** | The Notification Manager OMVS is for user interfaces supporting personalized notifications to specific users. A registered user is able to define which types of notification should be produced and who they should be delivered to. |
| [Project Manager](/services/omvs/project-manager/overview) | **Locate, retrieve and update information relating to projects.** | The Project Manager OMVS is for user interfaces supporting projects, either for a group of people or personalized sandboxes for individuals. A registered user is able to maintain information about a project and link it with other projects, users and resources. |
| [Reference Data](/services/omvs/reference-data/overview) | **Create and maintain reference data values and their mappings.** | The Reference Data Open Metadata View Services (OMVS) is a REST API designed to support user interfaces (UIs) that maintain reference data values and their mappings. | |
| [Template Manager](/services/omvs/template-manager/overview) | **Create and maintain templates used to create new metadata elements.** | The Template Manager Open Metadata View Services (OMVS) is a REST API designed to support user interfaces (UIs) that support the management of templates that are used when creating new metadata. |
| [Glossary Author](/services/omvs/glossary-author/overview) | **Develop new glossary terms and categories.** | The Glossary Author OMVS is for user interfaces supporting the creating and editing of glossary content, such as glossary terms and categories. The changes made are immediately visible to all users. |
| [Glossary Browser](/services/omvs/glossary-browser/overview) | **Search and view the contents of specific glossaries and their links to governance definitions and assets.** | The Glossary Browser OMVS is for user interfaces that wish to provide search facilities within a single glossary (or glossaries) along with the ability to browse the structure of the glossary and view an element within a glossary along with connected governance classifications, governance definitions, user feedback and attached assets. |
| [Glossary Workflow](/services/omvs/glossary-workflow/overview) | **Develop new glossary terms and categories in a controlled workflow process.** | The Glossary Workflow OMVS is for user interfaces supporting the creation and editing of glossary content, such as glossary terms and categories, in a controlled workflow process. This means that as terms and categories are created, updated and deleted, these changes are invisible to the general user until they are approved. |
Expand Down
21 changes: 21 additions & 0 deletions site/docs/services/omvs/reference-data/overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
hide:
- toc
---

<!-- SPDX-License-Identifier: CC-BY-4.0 -->
<!-- Copyright Contributors to the Egeria project. -->

--8<-- "snippets/content-status/in-development.md"

# Reference Data OMVS

The Reference Data Open Metadata View Services (OMVS) is a REST API designed to support user interfaces (UIs) that maintain reference data values and their mappings.

---8<-- "snippets/abbr.md"






21 changes: 21 additions & 0 deletions site/docs/services/omvs/template-manager/overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
hide:
- toc
---

<!-- SPDX-License-Identifier: CC-BY-4.0 -->
<!-- Copyright Contributors to the Egeria project. -->

--8<-- "snippets/content-status/in-development.md"

# Template Manager OMVS

The Template Manager Open Metadata View Services (OMVS) is a REST API designed to support user interfaces (UIs) that support the management of templates that are used when creating new metadata.

---8<-- "snippets/abbr.md"






15 changes: 10 additions & 5 deletions site/docs/types/0/0021-Collections.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,10 @@ The attributes for a collection, beyond the standard attributes for *Referenceab

The classifications associated with *Collection* allow it to be specialized for particular uses. They help when searching for collections for specific uses.

* [*RootCollection*](#root-collection-classification) means the collection is the top-level node in a collection hierarchy. The members of this collection are typically all collections.
* [*RootCollection*](#root-collection-classification) means the collection is an independent, top-level node in a collection hierarchy. The members of this collection are typically all collections.
* [*HomeCollection*](#home-collection-classification) means the collection is the top-level node in a collection hierarchy anchored to a specific [Referenceable](/types/0/0010-Base-Model). The members of this collection may or may not be collections.
* [*Folder*](#folder-classification) means the collection can be treated as if it where a folder of metadata elements. This classification includes properties to control how the members are displayed.
* [*Set*](#set-classification) means the collection is a set of related entities and no entity is a member more than once.
* [*ResultsSet*](#resultsset-classification) means the collection is a set of related results.
* [*DigitalProduct*](/types/7/0710-Digital-Service) describes a collection of [assets](/concepts/asset) that represent a digital product.
* [*GovernanceStatusSet*](/types/4/0421-Governance-Classification-Levels) for a collection of governance statuses.
* [*GovernanceClassificationSet*](/types/4/0421-Governance-Classification-Levels) for a collection of governance classification for a particular governance classification.
Expand All @@ -40,7 +41,11 @@ The collection at the root of the collection hierarchy is called "Product Catalo

### RootCollection classification

The *RootCollection* classification indicates that the collection is used to provide the starting node for a hierarchy of collections.
The *RootCollection* classification indicates that the collection is used to provide the starting node for an independent hierarchy of collections. For example, this could be a collection hierarch that organizes [digital products]

### HomeCollection classification

The *HomeCollection* classification indicates that the collection is used to provide the starting node for a hierarchy of collections.

### Folder classification

Expand All @@ -58,9 +63,9 @@ The *Folder* classification indicates that the collection is used to organize me
* *DateCreated* - Order by date that the asset was created.
* *Other* - Order by another property.

### Set classification
### ResultsSet classification

The *Set* classification indicates that the collection is a set of elements where each element is only included in the collection once.
The *ResultsSet* classification indicates that the collection is a set of elements where each element is only included in the collection once.

## CollectionMembership relationship

Expand Down
2 changes: 1 addition & 1 deletion site/docs/types/0/0021-Collections.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 2be9166

Please sign in to comment.