From e29d9d245e345a3fbab86fc131f68c4530656930 Mon Sep 17 00:00:00 2001 From: Nigel Jones Date: Mon, 17 Jan 2022 00:00:04 +0000 Subject: [PATCH] #116 Integrate ecosystem UI into tutorial navigation & fix bad links Signed-off-by: Nigel Jones --- .../education/egeria-dojo/running-egeria.md | 6 +- .../running-egeria/coco-labs-environment.md | 15 ++++- .../configuring-and-operating-a-server.md | 4 ++ .../running-egeria/simple-install.md | 3 +- .../ecosystem-ui/ecosystem-ui-start.md | 66 ++++++++++++------- .../user-interfaces/ui-introduction.md | 4 +- site/mkdocs.yml | 6 +- 7 files changed, 72 insertions(+), 32 deletions(-) diff --git a/site/docs/education/egeria-dojo/running-egeria.md b/site/docs/education/egeria-dojo/running-egeria.md index ada74373ba..473926908a 100644 --- a/site/docs/education/egeria-dojo/running-egeria.md +++ b/site/docs/education/egeria-dojo/running-egeria.md @@ -3,6 +3,8 @@ # Running Egeria Day ---8<-- "snippets/abbr.md" - This day is designed to introduce you to Egeria, and show how you can run Egeria and start using it. + +Jump straight to the [content](/egeria-docs/education/egeria-dojo/running-egeria/running-egeria-intro) of this day. + +--8<-- "snippets/abbr.md" diff --git a/site/docs/education/egeria-dojo/running-egeria/coco-labs-environment.md b/site/docs/education/egeria-dojo/running-egeria/coco-labs-environment.md index c6b02733a1..bad7d8ee35 100644 --- a/site/docs/education/egeria-dojo/running-egeria/coco-labs-environment.md +++ b/site/docs/education/egeria-dojo/running-egeria/coco-labs-environment.md @@ -112,7 +112,7 @@ As you progress through the labs, if you are interested in experimenting with po # Start working on the labs -Open up a web browser and go to http://localhost:8888 +Open up a web browser and go to [http://localhost:8888 :material-dock-window:](http://localhost:8888){ target=egeria } You should see a window similar to this: @@ -124,6 +124,19 @@ There is more material to run in the Open metadata Labs than can be done in this In addition, these labs (like everything else in Egeria) is evolving rapidly so it is worth checking back from time to time to see what is new. This also means some of the labs are incomplete. Visit the slack channel to check if you get problems. +## Using the Ecosystem UI with Coco Labs + +As you work through the labs, you may also wish to explore the metadata instances, and server configuration that +this more complex environment has setup. + +Make sure you are still running the required port forwarding for the ui +```console +kubectl port-forward base-presentation 8091:8091 +``` +and go to [https://localhost:8091/coco/login :material-dock-window:](https://localhost:8091/coco/login){ target=egeria } in your browser. + +You'll notice the URL is slightly different to before. This is because **coco** in the above URL refers to the organization configured in the UI deployment (how to set this up will be covered in a future dojo). For our simple install this defaulted to the name **org**. + ## Next step Let's move on to a [summary](/egeria-docs/education/egeria-dojo/running-egeria/running-egeria-summary) diff --git a/site/docs/education/egeria-dojo/running-egeria/configuring-and-operating-a-server.md b/site/docs/education/egeria-dojo/running-egeria/configuring-and-operating-a-server.md index 10ae5a46cb..57db5682bb 100644 --- a/site/docs/education/egeria-dojo/running-egeria/configuring-and-operating-a-server.md +++ b/site/docs/education/egeria-dojo/running-egeria/configuring-and-operating-a-server.md @@ -371,6 +371,10 @@ Start both servers and view their logs via Kubernetes - you should see that they Now use the commands in the `Egeria-repository-services-metadata-highway` to query information about the cohort from each server's perspective. +## Using the ecosystem UI + +We will not explore the UI in this tutorial. we'll get into more detail on this configuration for your own deployments in a future dojo session. + ## Next step Let's move on to [Coco Pharmacueticals](/egeria-docs/education/egeria-dojo/running-egeria/coco-labs-environment) diff --git a/site/docs/education/egeria-dojo/running-egeria/simple-install.md b/site/docs/education/egeria-dojo/running-egeria/simple-install.md index 2266b903c3..524e62aaa0 100644 --- a/site/docs/education/egeria-dojo/running-egeria/simple-install.md +++ b/site/docs/education/egeria-dojo/running-egeria/simple-install.md @@ -165,5 +165,6 @@ As long as all the pods are ready, we know that: ## Next step -Let's move on to [configuring and operating a server](/egeria-docs/education/egeria-dojo/running-egeria/configuring-and-operating-a-server) +Let's move on to the [Egeria UIs](/egeria-docs/education/egeria-dojo/running-egeria/user-interfaces/ui-introduction) + --8<-- "snippets/abbr.md" diff --git a/site/docs/education/egeria-dojo/running-egeria/user-interfaces/ecosystem-ui/ecosystem-ui-start.md b/site/docs/education/egeria-dojo/running-egeria/user-interfaces/ecosystem-ui/ecosystem-ui-start.md index 3b2140d5e4..4431f058b8 100644 --- a/site/docs/education/egeria-dojo/running-egeria/user-interfaces/ecosystem-ui/ecosystem-ui-start.md +++ b/site/docs/education/egeria-dojo/running-egeria/user-interfaces/ecosystem-ui/ecosystem-ui-start.md @@ -1,35 +1,42 @@ # Using the Egeria Ecosystem UI -## Prerequisites +With the simple environment we have set up, we can now start exploring the Egeria Ecosystem UI. -Ensure that you have successfully completed the [Simple Install](../../simple-install.md). -At this point you should have all your pods running. +In later labs you can refer back to this documentation and try out the new with the new environment. + +## Setting up connectivity to the UI + +To use the Ecosystem UI you will need to forward a port so that the browser can communicate with the Egeria Ecosystem UI application. -To use the Ecosystem UI you will need to forward a port so that he browser can communicate with Egeria. At a Terminal run: -``` +```console kubectl port-forward service/base-presentation 8091:8091 ``` -Leave that running. -## Using the UI. +Leave this running throughout this exploration of the UI. + +## Using the UI You need to use an up to date Chrome browser. -* In a browser go to https://localhost:8091/org/login +* In the browser go to [https://localhost:8091/org/login :material-dock-window:](https://localhost:8091/org/login){ target=ui } + You should now see a screen like this ![Login screen](login-screen.png) -* login with userid garygeeke and password admin +* login with userid garygeeke and password admin + Note the login details here are hard-coded for demonstration purposes. + You should now see a screen like this: + ![Start Screen](initial-screen.png) ## Type Explorer -Egeria has a rich set of [open types](../../../../types/) that are used by the [OMRS](../../../../services/omrs/). These types can be for entities, relationships and classifications. +Egeria has a rich set of [open types :material-dock-window:](/egeria-docs/types/){ target=docs } that are used by the [OMRS :material-dock-window:](/egeria-docs/services/omrs/){ target=docs }. These types can be for entities, relationships and classifications. In order to write connectors, work with the internals of Egeria or just to understand the scope of Egeria, you may want to familiarise yourself with the types. There are hundreds of open types. The Type Explorer allows you to explore the types on a server. -More information can be found in the [Type Explorer User Guide](../../../../guides/react-ui/tex-user-guide.md) +More information can be found in the [Type Explorer User Guide :material-dock-window:](/egeria-docs/guides/ecosystem-ui/tex-user-guide){ target=docs } ### Using the Type Explorer * Click on the Type Explorer in the left navigation pane. @@ -51,7 +58,7 @@ The neighbourhood view centers around an entity type (in this case Asset) and sh and the type of the entity at the other end of the relationship. There is a checkbox called Enterprise. When checked this shows an enterprise view of the types i.e. the selected servers view of all the types it can see, including -types from other servers in its [cohorts](../../../../../services/omrs/cohort.md). +types from other servers in its [cohorts :material-dock-window:](/egeria-docs/services/omrs/cohort){ target=docs }. Over time new releases of Egeria deprecate types. The deprecated types can still be used, but in time may be removed. Most of the time it is not useful to see the deprecated types. It is possible to use **Type Explorer** to explore deprecated types and attributes. @@ -68,7 +75,7 @@ There is a checkbox called Include deprecated attributes to include ## Dino Dino allows you to explore the operational environment of the Egeria ecosystem. -More information can be found in the [Dino User Guide](/guides/react-ui/dino-user-guide.md) +More information can be found in the [Dino User Guide :material-dock-window:](/egeria-docs/guides/ecosystem-ui/dino-user-guide){ target=docs } ### Using Dino @@ -76,12 +83,14 @@ More information can be found in the [Dino User Guide](/guides/react-ui/dino-use * Choose **platform** and **mds1**. As you open sections on the left navigation pane, the operational landscape picture is updated. Here is an example after I opened some sections. -[dino](dino.png) -Known issue: [issue 327](https://github.com/odpi/egeria-react-ui/issues/327) viewing view server config : +![dino](dino.png) + +!!! note + Known issue: [issue 327 :material-dock-window:](https://github.com/odpi/egeria-react-ui/issues/327){ target=gh } viewing view server config : ## Glossary Author -More information can be found in the [Glossary Author User Guide](../../../../guides/react-ui/glossary-author-user-guide.md) +More information can be found in the [Glossary Author User Guide :material-dock-window:](/egeria-docs/guides/ecosystem-ui/glossary-author-user-guide){ target=docs } ### Using the Glossary Author @@ -99,7 +108,10 @@ this screen to be empty. * you will notice that some action buttons have appeared at the top of the screen. * the first is to quickly create terms; quickly putting in names and descriptions of terms is something that is useful as part of innovation/ planning sessions to get terms defined quickly. -Known issue: There is a formatting error in the response screen - this is tracked in [issue 325](https://github.com/odpi/egeria-react-ui/issues/325). + +!!! note + Known issue: There is a formatting error in the response screen - this is tracked in [issue 325 :material-dock-window:](https://github.com/odpi/egeria-react-ui/issues/325){ target=gh }. + The green ticks indicate that the terms have been created where there was a name. * Back on the glossary card screen, you will notice that there are other icons to the right of the quick terms, respectively they are: @@ -128,7 +140,10 @@ a glossary via the TermAnchor relationship. and shou * Try pressing "Create Node", to create a term called term5. This will be added to the canvas - you may need to scroll down to see this new Term. You can drag content around the canvas as required. ![Term5 on Canvas](term5-on-canvas.png) -Known issue : there is currently an issue with 'Create relationship', that it does not work . [issue 326](https://github.com/odpi/egeria-react-ui/issues/326) has been raised. + +!!! note + Known issue : there is currently an issue with 'Create relationship', that it does not work . [issue 326 :material-dock-window:](https://github.com/odpi/egeria-react-ui/issues/326){ target=gh } has been raised. + * Notice that you can use the breadcrumb to navigate back to previous screens * Notice on the card and table views there are paging controls to allow you to alter the number of elements displayed on the screen. * You can use the button on the category tab to create a new category, and optionally specify a parent category. In this way you can author a category hierarchy. @@ -145,9 +160,9 @@ Known issue : there is currently an issue with 'Create relationship', that it do ??? hint ![categorised term](create Categorised term.png) ## Repository Explorer -The Repository Explorer allows the user to explore [Open Metadata Instances](../../../../../concepts/open-metadata-instances.md) +The Repository Explorer allows the user to explore [Open Metadata Instances :material-dock-window:](/egeria-docs/concepts/open-metadata-instances){ target=docs } If you know the guid of an entity you can enter it and start exploring. More usefully you can start your exploration using a -text search restricted by types. More information can be found in the [Repository Explorer User Guide](../../../../guides/react-ui/rex-user-guide.md) +text search restricted by types. More information can be found in the [Repository Explorer User Guide :material-dock-window:](/egeria-docs/guides/ecosystem-ui/rex-user-guide){ target=docs } ### Using the Repository Explorer @@ -195,7 +210,7 @@ Note that The Server Author is an authoring UI to create new server configurations. This is currently being developed and will support all the server types. In this dojo you will create a Access Store Server. -More information can be found in the [Server Author User Guide](../../../../guides/react-ui/server-author-user-guide.md) +More information will be found in the [Server Author User Guide :material-dock-window:](/egeria-docs/guides/ecosystem-ui/server-author-user-guide){ target=docs }, but this documentation is still in the process of being written. ### Using the Server Author @@ -206,7 +221,7 @@ More information can be found in the [Server Author User Guide](../../../../guid ![choose server type](access-store-server.png) * Click . Call the new server (Server Name) **dojo1** and add a Local user Id of **dojo1**. ![Basic screen](server-author-basic.png) -* Click and choose **Non-temporal local Graph (janus) graph** from the dropdown. +* Click and choose **Non-temporal local Graph (Janus)** from the dropdown. ![repo](janus-graph.png) * Click . This currently defaults, but will be customisable in the near future. * Click and add a name for the cohort you will use. @@ -223,7 +238,7 @@ Then change the name to be json and the type from the dropdown to be Json. You c ![Audit Log list](audit-log-list.png) You will see the default console audit log and your new audit log destination. You can select an audit log and update it or delete it. * Click then -You will not see your server in the list, as the Dojo is running on release 3.4, this issue is fixed in the latest [Egeria Ecosystem UI code](https://github.com/odpi/egeria-react-ui). +You will not see your server in the list, as the Dojo is running on release 3.4, this issue is fixed in the latest [Egeria Ecosystem UI code :material-dock-window:](https://github.com/odpi/egeria-react-ui){ target=gh }. * to see your server in the list, choose 'Repository Explorer' , then 'Server Author' in the left navigation pane and you should see the new server ![](./) @@ -231,7 +246,10 @@ You will not see your server in the list, as the Dojo is running on release 3.4, * What is an Egeria OMAG Platform? * What is an Egeria OMAG Server? * What types of audit log destinations can be associated with a server? - + +## Next Step + +We will now continue looking at [Configuring and operating an Egeria server](/egeria-docs/education/egeria-dojo/running-egeria/configuring-and-operating-a-server) diff --git a/site/docs/education/egeria-dojo/running-egeria/user-interfaces/ui-introduction.md b/site/docs/education/egeria-dojo/running-egeria/user-interfaces/ui-introduction.md index 889a992f02..57a5c1aeba 100644 --- a/site/docs/education/egeria-dojo/running-egeria/user-interfaces/ui-introduction.md +++ b/site/docs/education/egeria-dojo/running-egeria/user-interfaces/ui-introduction.md @@ -4,7 +4,7 @@ # Egeria UIs -Egeria has two User Interfaces in development at the moment, each focused at different +Egeria has two User Interfaces in development, each focused at different types of organization. * **Egeria General User Interface** This UI is for a mature organization that has already invested in a metadata @@ -13,6 +13,8 @@ capability and is using Egeria to integrate tools into their metadata repository * **Egeria Ecosystem User Interface** This UI is a multi-tenanted persona based user interface; this user interface will be driven by the [community profile](../../../../services/omas/community-profile/overview.md) producing tailored experiences for the different personas and is focussed on supporting all aspects of an organization's metadata integration and governance needs. This user interface makes use of view servers and a thin presentation server. +## Next step + Press [here](ecosystem-ui/ecosystem-ui-start.md) to try out the Egeria Ecosystem UI. diff --git a/site/mkdocs.yml b/site/mkdocs.yml index ea6bd37f00..967a960f57 100644 --- a/site/mkdocs.yml +++ b/site/mkdocs.yml @@ -149,11 +149,11 @@ nav: - Egeria introduction : education/egeria-dojo/running-egeria/egeria-introduction.md - Setup of the environment: education/egeria-dojo/running-egeria/setup-environment.md - Simple Install of Egeria: education/egeria-dojo/running-egeria/simple-install.md - - Configuring and Operating a Server : education/egeria-dojo/running-egeria/configuring-and-operating-a-server.md - User Interfaces: - - Introduction to the Egeria UIs : education/egeria-dojo/running-egeria/user-interfaces/ui-introduction.md + - Introduction to the Egeria UIs: education/egeria-dojo/running-egeria/user-interfaces/ui-introduction.md - Ecosystem UI: - - Using the Egeria Ecosystem UI: education/egeria-dojo/running-egeria/user-interfaces/ecosystem-ui/ecosystem-ui-start.md + - Using the Egeria Ecosystem UI: education/egeria-dojo/running-egeria/user-interfaces/ecosystem-ui/ecosystem-ui-start.md - + - Configuring and Operating a Server : education/egeria-dojo/running-egeria/configuring-and-operating-a-server.md - Coco Pharmaceuticals : education/egeria-dojo/running-egeria/coco-labs-environment.md - Summary of 'Running Egeria' day : education/egeria-dojo/running-egeria/running-egeria-summary.md - Developer Day : education/egeria-dojo/developer/overview.md