From 3387ed2a3482ad3f8b53bfb14a6d7852fa389ff8 Mon Sep 17 00:00:00 2001 From: Mandy Chessell Date: Thu, 14 Sep 2023 09:55:56 +0100 Subject: [PATCH] Tidy up open metadata labs Signed-off-by: Mandy Chessell --- .../education/open-metadata-labs/overview.md | 35 ++++++++++++++-- .../open-metadata-labs/running-natively.md | 40 ------------------- .../building-egeria-tutorial/overview.md | 1 + .../developer-intellij-tutorial/overview.md | 13 +++--- .../task-create-intellij-project.md | 6 +-- .../egeria-git-repositories.md | 1 - .../tasks/task-installing-intellij.md | 2 +- .../snippets/tasks/task-installing-jupyter.md | 2 +- 8 files changed, 44 insertions(+), 56 deletions(-) delete mode 100644 site/docs/education/open-metadata-labs/running-natively.md diff --git a/site/docs/education/open-metadata-labs/overview.md b/site/docs/education/open-metadata-labs/overview.md index ab8f22ec80..cb46eb9dd2 100644 --- a/site/docs/education/open-metadata-labs/overview.md +++ b/site/docs/education/open-metadata-labs/overview.md @@ -15,9 +15,8 @@ These labs can be used for individual study, as part of a class and / or as the There are two main ways to set up the software to run these labs. These are listed below. They each create exactly the same environment that supports the labs. -* [Using Kubernetes](/guides/operations/kubernetes){target=new} to run them in a flexible, self-contained environment - locally or in the cloud. -In this case, all software components required to run are deployed using single helm chart called **odpi-egeria-lab**. The process is described [here](/guides/operations/kubernetes/charts/lab/). -* [Using your own local environment directly](/education/open-metadata-labs/running-natively). +* [Using Kubernetes](/guides/operations/kubernetes){target=new} to run them in a flexible, self-contained environment - locally or in the cloud. In this case, all software components required to run are deployed using single helm chart called **odpi-egeria-lab**. The process is described [here](/guides/operations/kubernetes/charts/lab/). +* [Using your own local environment directly](#running-egeria-natively). Once the software is in place, and the four platforms are running, you then go to the `JupyterLab` browser window (typically at `http://localhost:8888/lab`) and begin with the [read-me-first.ipynb](https://github.com/odpi/egeria-jupyter-notebooks/blob/main/read-me-first.ipynb){target=new} lab notebook to familiarize yourself with the tutorial tools. This notebook will guide you to the rest of the labs. @@ -25,4 +24,34 @@ Once the software is in place, and the four platforms are running, you then go t You can start running a notebook by simply double-clicking the filename in the left pane of the Jupyter interface. +## Running Egeria natively + +The technologies described on this page are required to operation Egeria. They are included when using the self-contained environments, but they can also be installed and run natively (directly) on your system. + +Just be aware that running them natively on your system will require the additional effort of downloading, installing, configuring and operating each one -- which the self-contained environments largely take care of for you. To make use of the latest Egeria software, you will likely also need to be familiar with how to [build Egeria](/education/tutorials/building-egeria-tutorial/overview) in order to use it natively. + +??? education "Installing and configuring prerequisite software" + --8<-- "snippets/tasks/task-installing-java.md" + --8<-- "snippets/tasks/task-installing-git.md" + --8<-- "snippets/tasks/task-installing-kafka.md" + --8<-- "snippets/tasks/task-starting-kafka.md" + --8<-- "snippets/tasks/task-downloading-egeria-source.md" + --8<-- "snippets/tasks/task-building-egeria-source.md" + --8<-- "snippets/tasks/task-installing-egeria.md" + --8<-- "snippets/tasks/task-installing-jupyter.md" + +??? education "Starting up your environment" + Follow the [OMAG Server Platform tutorial](/education/tutorials/omag-server-tutorial/overview) + for instructions on how to set up and run a platform yourself. + You need to start four OMAG Server Platforms at the following URLs - remembering to use the `-Dserver.port=nnnn` option: + + - `https://localhost:9443` + - `https://localhost:9444` + - `https://localhost:9445` + - `https://localhost:9446` + + +??? tip "Help" + For additional help refer to our Slack channels at http://slack.lfaidata.foundation + --8<-- "snippets/abbr.md" diff --git a/site/docs/education/open-metadata-labs/running-natively.md b/site/docs/education/open-metadata-labs/running-natively.md deleted file mode 100644 index 7ef9e9f3ea..0000000000 --- a/site/docs/education/open-metadata-labs/running-natively.md +++ /dev/null @@ -1,40 +0,0 @@ - - - -# Running Egeria natively - -The technologies described on this page are required to operation Egeria. They are included when using the self-contained environments, but they can also be installed and run natively (directly) on your system. - -Just be aware that running them natively on your system will require the additional effort of downloading, installing, -configuring and operating each one -- which the self-contained environments largely take care of for you. To make use -of the latest Egeria software, you will likely also need to be familiar with how to [build Egeria](/education/tutorials/building-egeria-tutorial/overview) in -order to use it natively. - -## Installing and configuring prerequisite software - ---8<-- "snippets/tasks/task-installing-java.md" ---8<-- "snippets/tasks/task-installing-git.md" ---8<-- "snippets/tasks/task-installing-kafka.md" ---8<-- "snippets/tasks/task-starting-kafka.md" ---8<-- "snippets/tasks/task-downloading-egeria-source.md" ---8<-- "snippets/tasks/task-building-egeria-source.md" ---8<-- "snippets/tasks/task-installing-egeria.md" ---8<-- "snippets/tasks/task-installing-jupyter.md" - -## Starting up your environment - -Follow the [OMAG Server Platform tutorial](/education/tutorials/omag-server-tutorial/overview) -for instructions on how to set up and run a platform yourself. -You need to start four OMAG Server Platforms at the following URLs - remembering to use the `-Dserver.port=nnnn` option: - -- `https://localhost:9443` -- `https://localhost:9444` -- `https://localhost:9445` -- `https://localhost:9446` - - -## Help - -For additional help refer to our Slack channels at http://slack.lfaidata.foundation - ---8<-- "snippets/abbr.md" diff --git a/site/docs/education/tutorials/building-egeria-tutorial/overview.md b/site/docs/education/tutorials/building-egeria-tutorial/overview.md index 6514e9c8b0..ae8fd13c91 100644 --- a/site/docs/education/tutorials/building-egeria-tutorial/overview.md +++ b/site/docs/education/tutorials/building-egeria-tutorial/overview.md @@ -20,6 +20,7 @@ Alternatively you can also use [Kubernetes](/guides/operations/kubernetes) to ru 2. [Building the Egeria source](#building-the-egeria-source) 3. [Installing Egeria](#installing-egeria) +??? --8<-- "snippets/tasks/task-downloading-egeria-source.md" You are now ready to [build the egeria source](#building-the-egeria-source). diff --git a/site/docs/education/tutorials/developer-intellij-tutorial/overview.md b/site/docs/education/tutorials/developer-intellij-tutorial/overview.md index e773404d6a..582642dafb 100644 --- a/site/docs/education/tutorials/developer-intellij-tutorial/overview.md +++ b/site/docs/education/tutorials/developer-intellij-tutorial/overview.md @@ -6,7 +6,7 @@ This tutorial explains how to set up IntelliJ so that you can develop new connectors and clients for your organization. !!! tip "For developers wishing to contribute to Egeria" - Contributions to Egeria need to be made via a Pull Request (PR) from you own fork of the project. There are detailed instructions on how to do this in the [Git and GitHub Tutorial](/education/tutorials/git-and-git-hub-tutorial/overview) + Contributions to Egeria need to be made via a Pull Request (PR) from you own fork of the project. There are detailed instructions on how to do this in the [Git and GitHub Tutorial](/education/tutorials/git-and-git-hub-tutorial/overview/#using-git-and-github-when-making-a-contribution) ## Prerequisite tasks @@ -15,11 +15,11 @@ This tutorial explains how to set up IntelliJ so that you can develop new connec ## Tutorial tasks -1. Install IntelliJ -2. Create a project for your code -3. Set up an OMAG Server Platform -4. Create test servers -5. Start and stop servers +1. [Install IntelliJ](#installing-intellij) +2. [Create a project for your code](#create-intellij-project) +3. [Set up an OMAG Server Platform](#set-up-omag-server-platform-in-intellij) +4. [Create test servers](#create-test-servers) +5. [Start and stop servers](#start-and-stop-servers) --8<-- "snippets/tasks/task-installing-intellij.md" @@ -32,7 +32,6 @@ This tutorial explains how to set up IntelliJ so that you can develop new connec --8<-- "docs/education/tutorials/developer-intellij-tutorial/task-server-ops-in-intellij.md" - ## What next? Now that IntelliJ is set up, you can: diff --git a/site/docs/education/tutorials/developer-intellij-tutorial/task-create-intellij-project.md b/site/docs/education/tutorials/developer-intellij-tutorial/task-create-intellij-project.md index 4b663235d7..da6897d1ad 100644 --- a/site/docs/education/tutorials/developer-intellij-tutorial/task-create-intellij-project.md +++ b/site/docs/education/tutorials/developer-intellij-tutorial/task-create-intellij-project.md @@ -19,11 +19,11 @@ Press the `Create` button and the new project is opened. ??? tip "Set up Java Level ..." Validate that the project is set up with the right level of Java - you need Java 17. Select `File` and then `Project Structure...`. When the wizard opens select `Project` and ensure the SDK is Java 17. -![Check Java level](default-java-level.png) + ![Check Java level](default-java-level.png) -If the SDK is not 17, click on the dropdown and change it to 17, and click OK to save it. If Java 17 is not listed, make sure you have Java 17 installed on your machine and retry. + If the SDK is not 17, click on the dropdown and change it to 17, and click OK to save it. If Java 17 is not listed, make sure you have Java 17 installed on your machine and retry. -![Correct Java Level](correct-java-level.png) + ![Correct Java Level](correct-java-level.png) ??? tip "Ensure you have enough memory ..." ---8<-- "docs/education/tutorials/intellij-tutorial/intellij-memory-settings.md" diff --git a/site/docs/education/tutorials/git-and-git-hub-tutorial/egeria-git-repositories.md b/site/docs/education/tutorials/git-and-git-hub-tutorial/egeria-git-repositories.md index 7fcb5aefad..6786dff011 100644 --- a/site/docs/education/tutorials/git-and-git-hub-tutorial/egeria-git-repositories.md +++ b/site/docs/education/tutorials/git-and-git-hub-tutorial/egeria-git-repositories.md @@ -12,7 +12,6 @@ Egeria has the following repositories: | Repository | Purpose | | --- | --- | -| Repository | Purpose | | [`egeria` :material-github:](https://github.com/odpi/egeria){ target=gh } | Egeria core | | [`egeria-docs` :material-github:](https://github.com/odpi/egeria-docs){ target=gh } | Documentation repository for the Egeria project. | | [`egeria-charts` :material-github:](https://github.com/odpi/egeria-charts){ target=gh } | Helm chart repository | diff --git a/site/snippets/tasks/task-installing-intellij.md b/site/snippets/tasks/task-installing-intellij.md index 49b0f4e1ee..0ea6647e23 100644 --- a/site/snippets/tasks/task-installing-intellij.md +++ b/site/snippets/tasks/task-installing-intellij.md @@ -1,7 +1,7 @@ -### Installing Intellij +### Installing Intellij Link to the [download](https://www.jetbrains.com/idea/download/) page and follow the instructions. Then start up IntelliJ and a wizard appears. diff --git a/site/snippets/tasks/task-installing-jupyter.md b/site/snippets/tasks/task-installing-jupyter.md index 8dd125569d..401d9fe933 100644 --- a/site/snippets/tasks/task-installing-jupyter.md +++ b/site/snippets/tasks/task-installing-jupyter.md @@ -22,4 +22,4 @@ Alternatively, if you are running macOS you can use HomeBrew. brew install jupyterlab ``` - +Once JupyterLab is installed it can be run with the `jupyter lab` command.