From b9e2f2b458b114238498ba7148077f08bce92398 Mon Sep 17 00:00:00 2001 From: Mandy Chessell Date: Wed, 9 Oct 2024 09:39:41 +0100 Subject: [PATCH] Correct getting started instructions Signed-off-by: Mandy Chessell --- .../unity-catalog/unity-catalog.drawio | 268 +++++++----------- site/docs/types/2/0212-Deployed-APIs.md | 4 +- site/docs/types/2/0212-Deployed-APIs.svg | 2 +- site/docs/types/2/area-2-assets.drawio | 21 +- site/snippets/getting-started-text.md | 8 +- 5 files changed, 118 insertions(+), 185 deletions(-) diff --git a/site/docs/connectors/unity-catalog/unity-catalog.drawio b/site/docs/connectors/unity-catalog/unity-catalog.drawio index 10cd52efba..38a7496997 100644 --- a/site/docs/connectors/unity-catalog/unity-catalog.drawio +++ b/site/docs/connectors/unity-catalog/unity-catalog.drawio @@ -1015,7 +1015,7 @@ - + @@ -1032,94 +1032,68 @@ - + - + - + - + + + + + + + - + + + + - + + + + - + - + - - + + - - + + - + - + - + - - + + - - - - - - - - - - - - - - - - - - - - - - - - - + + - - - - - - - - - - - - - - - - + @@ -1372,7 +1346,10 @@ - + + + + @@ -1386,33 +1363,33 @@ - + - - + + - - + + - + - + - + - + - + - - - + + + @@ -1421,17 +1398,14 @@ - - - - - + + - - + + - - + + @@ -1477,21 +1451,21 @@ - + - - + + - - + + - + - + - + @@ -1503,27 +1477,9 @@ - + - - - - - - - - - - - - - - - - - - @@ -1576,21 +1532,21 @@ - + - - + + - - + + - + - + - + @@ -1602,27 +1558,9 @@ - + - - - - - - - - - - - - - - - - - - @@ -1695,21 +1633,21 @@ - + - - + + - - + + - + - + - + @@ -1721,27 +1659,9 @@ - + - - - - - - - - - - - - - - - - - - @@ -1772,6 +1692,28 @@ + + + + + + + + + + + + + + + + + + + + + + diff --git a/site/docs/types/2/0212-Deployed-APIs.md b/site/docs/types/2/0212-Deployed-APIs.md index 52d5472326..b60c7c3528 100644 --- a/site/docs/types/2/0212-Deployed-APIs.md +++ b/site/docs/types/2/0212-Deployed-APIs.md @@ -9,11 +9,11 @@ APIs exchange data structures and commands. Each API is an access point for data ## DeployedAPI -The *DeployedAPI* is the entity that represents the API as an [Asset](/types/0/0010-Base-Model). The *deployedImplementationType* attribute describes the class of technology that is used in its implementation. Values for the *deployedImplementationType* attribute can be managed for consistency in a [*deployed implementation type*](/concepts/deployed-implementation-type) valid value set. The definition of the API's operations, their parameters and responses are described via the [APISchemaType](/types/5/0536-API-Schemas) entity, which is connected to the *DeployedAPI* entity with the [AssetSchemaType](/types/5/0503-Asset-Schema) relationship. +The *DeployedAPI* is the entity that represents the API as a [DeployedSoftwareComponent](/types/2/0215-Software-Components). The definition of the API's operations, their parameters and responses are described via the [APISchemaType](/types/5/0536-API-Schemas) entity, which is connected to the *DeployedAPI* entity with the [AssetSchemaType](/types/5/0503-Asset-Schema) relationship. The classifications [RequestResponseInterface](#requestresponseinterface), [ListenerInterface](#listenerinterface) and [PublisherInterface](#publisherinterface) can be used to describe the style of the API. They can appear in combination on a single *DeployedAPI*. -APIs often provide remote access to [DeployedSoftwareComponents](/types/2/0215-Software-Components). A *DeployedAPI* entity is linked to a *DeployedSoftwareComponent* entity via the [ProcessCall](/types/7/0750-Data-Passing) relationship. +APIs often provide remote access to other [DeployedSoftwareComponents](/types/2/0215-Software-Components). A *DeployedAPI* entity is linked to another *DeployedSoftwareComponent* entity via the [ProcessCall](/types/7/0750-Data-Passing) relationship. ## APIEndpoint diff --git a/site/docs/types/2/0212-Deployed-APIs.svg b/site/docs/types/2/0212-Deployed-APIs.svg index cf4671dafb..c27678e720 100644 --- a/site/docs/types/2/0212-Deployed-APIs.svg +++ b/site/docs/types/2/0212-Deployed-APIs.svg @@ -1,4 +1,4 @@ -
0212 - Deployed APIs
0212 - Deployed APIs
«entity»
DeployedAPI
«entity»...
«entity»
Asset
«entity»...
«entity»
Endpoint
«entity»...
*
*
supportedAPIs
supportedAPIs
accessEndpoints
accessEndpoints
*
*
«relationship»
APIEndpoint
«relationship»...
«classification»
RequestResponseInterface
«classification»...
deployedImplementationType : string
deployedImplementationType : string
«classification»
ListenerInterface
«classification»...
«classification»
PublisherInterface
«classification»...Text is not SVG - cannot display \ No newline at end of file +
0212 - Deployed APIs
«entity»
DeployedAPI
«entity»
Endpoint
*
supportedAPIs
accessEndpoints
*
«relationship»
APIEndpoint
«classification»
RequestResponseInterface
«classification»
ListenerInterface
«classification»
PublisherInterface
«entity»
DeployedSoftwareComponent
 \ No newline at end of file diff --git a/site/docs/types/2/area-2-assets.drawio b/site/docs/types/2/area-2-assets.drawio index 4ef1bb62fc..6f39d38962 100644 --- a/site/docs/types/2/area-2-assets.drawio +++ b/site/docs/types/2/area-2-assets.drawio @@ -661,7 +661,7 @@ - + @@ -671,20 +671,12 @@ + + + - - - - - - - - - - - @@ -727,7 +719,7 @@ - + @@ -752,6 +744,9 @@ + + + diff --git a/site/snippets/getting-started-text.md b/site/snippets/getting-started-text.md index a2d842215d..a0e6457d6c 100644 --- a/site/snippets/getting-started-text.md +++ b/site/snippets/getting-started-text.md @@ -12,11 +12,7 @@ The [Getting Started with Egeria](https://getting-started-with-egeria.pdr-associ See [Setting up IntelliJ to develop components for Egeria](https://egeria-project.org/education/tutorials/developer-intellij-tutorial/overview/). -**Running Egeria in Kubernetes** - -* There is a *base* helm chart that includes a single [platform](/concepts/omag-server-platform) with a [metadata server](/concepts/metadata-access-store). This provides a simple way to experiment with Egeria's [APIs](/services) and [User Interfaces](/user-interfaces). Link to instructions for [starting the *base* helm chart](/guides/operations/kubernetes/charts/base). - -* There is a *lab* helm chart that provides a more complex multi-platform environment that is integrated with a variety of third party technologies. This chart is designed to support the [Open Metadata Labs](/education/open-metadata-labs/overview) which provide a rich set of demonstrations of many features of Egeria. The Open Metadata Labs are a good option if you would like a guided tour of Egeria. Link to instructions for [starting the *lab* helm chart](/guides/operations/kubernetes/charts/lab). - +**Running Egeria in Containers** +The [egeria-workspaces](https://github.com/odpi/egeria-workspaces) repository provides a choice of configurations of Egeria and related technologies. These deployments are designed for evaluation and test. They provide a running Egeria system plus a JupyterLab environment where it is possible to experiment with Egeria's capability. There are example python notebooks to guide you through the principle capabilities.