diff --git a/site/docs/education/tutorials/building-egeria-tutorial/overview.md b/site/docs/education/tutorials/building-egeria-tutorial/overview.md index ea5dc3dc14..6514e9c8b0 100644 --- a/site/docs/education/tutorials/building-egeria-tutorial/overview.md +++ b/site/docs/education/tutorials/building-egeria-tutorial/overview.md @@ -35,7 +35,7 @@ ready to [learn about the OMAG Server Platform](/education/tutorials/omag-server Alternatively ... -* [Set up IntelliJ ready to develop connectors or clients that use Egeria](/education/tutorials/developer-intellij-tutorial) +* [Set up IntelliJ ready to develop connectors or clients that use Egeria](/education/tutorials/developer-intellij-tutorial/overview) or * [Run the open metadata labs to get experience with using Egeria](/education/open-metadata-labs/overview) or diff --git a/site/docs/education/tutorials/developer-intellij-tutorial/correct-java-level.png b/site/docs/education/tutorials/developer-intellij-tutorial/correct-java-level.png new file mode 100644 index 0000000000..a62b8093bc Binary files /dev/null and b/site/docs/education/tutorials/developer-intellij-tutorial/correct-java-level.png differ diff --git a/site/docs/education/tutorials/developer-intellij-tutorial/default-java-level.png b/site/docs/education/tutorials/developer-intellij-tutorial/default-java-level.png new file mode 100644 index 0000000000..900592a4ad Binary files /dev/null and b/site/docs/education/tutorials/developer-intellij-tutorial/default-java-level.png differ diff --git a/site/docs/education/tutorials/developer-intellij-tutorial/overview.md b/site/docs/education/tutorials/developer-intellij-tutorial/overview.md index 87cdf10969..e773404d6a 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) + 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) ## Prerequisite tasks 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 44a5ab334f..4b663235d7 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 @@ -3,7 +3,8 @@ ### Create IntelliJ project -From an IntelliJ window, select `File->NewProject` from the top menu bar. +Either from start up wizard click on the `New Project` button or from IntelliJ's top +From an IntelliJ window, select `File->New Project` from the top menu bar. ![Select new project](create-intellij-project.png) @@ -15,6 +16,16 @@ Press the `Create` button and the new project is opened. ![New project window](new-project-is-opened.png) +??? 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) + +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) + +??? tip "Ensure you have enough memory ..." + ---8<-- "docs/education/tutorials/intellij-tutorial/intellij-memory-settings.md" diff --git a/site/docs/education/tutorials/developer-intellij-tutorial/task-server-config-in-intellij.md b/site/docs/education/tutorials/developer-intellij-tutorial/task-server-config-in-intellij.md index d54bba3c1a..d86554ab97 100644 --- a/site/docs/education/tutorials/developer-intellij-tutorial/task-server-config-in-intellij.md +++ b/site/docs/education/tutorials/developer-intellij-tutorial/task-server-config-in-intellij.md @@ -5,13 +5,13 @@ Egeria's assembly includes a utility for configuring servers. It is called `ServerConfig`. Select `Edit Configurations` and create another `JAR Application` run configuration entry for `ServerConfig`. -==== "V4.3 and before" +=== "V4.3 and before" ![server config settings](server-config-settings-4-3.png) -==== "V4.4" and beyond +=== "V4.4" and beyond ![server config settings](server-config-settings-4-4.png) -When you click `OK`, then `ServerConfig` appears in the dropdown run menu. Press the green triangle to run the utility and a new tab appears in the section of the IntelliJ window where the platform is running. +When you click `OK`, then `ServerConfig` appears in the dropdown run menu. Press the green triangle to run the utility and a new tab appears in the panel of the IntelliJ window where the platform is running. `ServerConfig` prints out a menu of the different configuration options it supports. diff --git a/site/docs/education/tutorials/developer-intellij-tutorial/task-server-ops-in-intellij.md b/site/docs/education/tutorials/developer-intellij-tutorial/task-server-ops-in-intellij.md index 54e5e11d63..bc599229ec 100644 --- a/site/docs/education/tutorials/developer-intellij-tutorial/task-server-ops-in-intellij.md +++ b/site/docs/education/tutorials/developer-intellij-tutorial/task-server-ops-in-intellij.md @@ -5,13 +5,13 @@ Egeria's assembly includes a utility called `ServerOps` that makes it easy to start and stop servers on your OMAG Server Platform. Select `Edit Configurations` and create another `JAR Application` run configuration entry for `ServerOps`. -==== "V4.3 and before" +=== "V4.3 and before" ![server ops settings](server-ops-settings-4-3.png) -==== "V4.4" and beyond +=== "V4.4" and beyond ![server ops settings](server-ops-settings-4-4.png) -When you click `OK`, then `ServerOps` appears in the dropdown run menu. Press the green triangle to run the utility and a new tab appears in the section of the IntelliJ window where the platform is running. +When you click `OK`, then `ServerOps` appears in the dropdown run menu. Press the green triangle to run the utility and a new tab appears in the panel of the IntelliJ window where the platform is running. `ServerOps` prints out a menu of the different operations it supports. diff --git a/site/docs/education/tutorials/developer-intellij-tutorial/task-set-up-platform-in-intellij.md b/site/docs/education/tutorials/developer-intellij-tutorial/task-set-up-platform-in-intellij.md index bf7e301a73..1a959d3afd 100644 --- a/site/docs/education/tutorials/developer-intellij-tutorial/task-set-up-platform-in-intellij.md +++ b/site/docs/education/tutorials/developer-intellij-tutorial/task-set-up-platform-in-intellij.md @@ -33,7 +33,7 @@ Press the green triangle to run the platform. ![run egeria platform](run-egeria-platform.png) -A new section appears in the IntelliJ window showing the platform is starting up. +A new panel appears in the IntelliJ window showing the platform is starting up. ![platform starting](platform-starting.png) @@ -47,13 +47,13 @@ Select `Edit Configurations` to create another `JAR Application`. This time cal Leave the `Working Directory` to default to your project directory. If you are using Version 4.3 of Egeria, set the VM Options to `-Dstrict.ssl=false`; for release V4.4 and beyond, you can leave them blank. -==== "V4.3 and before" +=== "V4.3 and before" ![platform report settings](platform-report-settings-4-3.png) -==== "V4.4" and beyond +=== "V4.4" and beyond ![platform report settings](platform-report-settings-4-4.png) -When you click `OK`, then `PlatformReport` appears in the dropdown run menu. Press the green triangle to run the report and a new tab appears in the section of the IntelliJ window where the platform is running. +When you click `OK`, then `PlatformReport` appears in the dropdown run menu. Press the green triangle to run the report and a new tab appears in the panel of the IntelliJ window where the platform is running. ![Run platform report](run-platform-report.png) diff --git a/site/snippets/tasks/task-building-with-gradle.md b/site/snippets/tasks/task-building-with-gradle.md index 748ca39abf..12968f8077 100644 --- a/site/snippets/tasks/task-building-with-gradle.md +++ b/site/snippets/tasks/task-building-with-gradle.md @@ -1,14 +1,7 @@ -[Gradle :material-dock-window:](https://gradle.org/){ target=gradle } is used to build the following repositories: - -* egeria.git - main Egeria libraries. -* egeria-dev-projects.git - utilities and connectors for developers to use and develop further. - -The Gradle processing works through the project modules. Each module has a `build.gradle` file that defines the artifact, its dependencies and any special processing that the module builds. The top-level `build.gradle` file at the root of the repository's source code directory structure controls the overall process. - -Gradle runs the build in parallel threads so be sure any test cases are independent of one another. +The [Gradle :material-dock-window:](https://gradle.org/){ target=gradle } processing works through the project modules. Each module has a `build.gradle` file that defines the artifact, its dependencies and any special processing that the module builds. The top-level `build.gradle` file at the root of the repository's source code directory structure controls the overall process. It runs the build in parallel threads to speed up the process of the build, but may take many cycles of your machine's capacity. When it is running, it may be a good time for a break! !!! tip "Maven repositories" This processing includes locating and downloading external libraries and dependencies, typically from an online open source repository called Maven Central and our snapshot repository on https://oss.sonatype.org, so make sure you are online when you run the build. diff --git a/site/snippets/tasks/task-installing-intellij.md b/site/snippets/tasks/task-installing-intellij.md index c9b9ca5b4c..49b0f4e1ee 100644 --- a/site/snippets/tasks/task-installing-intellij.md +++ b/site/snippets/tasks/task-installing-intellij.md @@ -3,16 +3,8 @@ ### Installing Intellij -Link to the [download](https://www.jetbrains.com/idea/download/) page and follow the instructions. +Link to the [download](https://www.jetbrains.com/idea/download/) page and follow the instructions. Then start up IntelliJ and a wizard appears. -Start up IntelliJ. -??? 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. - - ![Set Java level](/education/tutorials/intellij-tutorial/intellij-set-java-level.png) - -??? tip "Ensure you have enough memory ..." - ---8<-- "docs/education/tutorials/intellij-tutorial/intellij-memory-settings.md" diff --git a/site/snippets/tasks/terminal-installing-egeria.md b/site/snippets/tasks/terminal-installing-egeria.md index 1e7eda48dc..42367fb07f 100644 --- a/site/snippets/tasks/terminal-installing-egeria.md +++ b/site/snippets/tasks/terminal-installing-egeria.md @@ -2,7 +2,7 @@ -The [egeria build process](/education/tutorials/building-egeria-tutorial/overview) creates the distribution files for Egeria in the `open-metadata-distribution/open-metadata-assemblies` module. To see its contents, after a full gradle build completes, use the following `cd` command to change to its `build/distributions` directory: +The [egeria build process](/education/tutorials/building-egeria-tutorial/overview) creates the distribution files for Egeria in the `open-metadata-distribution/omag-server-platform` module. To see its contents, after a full gradle build completes, use the following `cd` command to change to its `build/distributions` directory: ```bash cd open-metadata-distribution/omag-server-platform/build/distributions @@ -26,7 +26,7 @@ mkdir ~/egeria-install cp egeria*-distribution.tar.gz ~/egeria-install ``` -These next commands change to the new directory and lists its contents. +This next command changes to the new directory. ```bash cd ~/egeria-install @@ -49,7 +49,8 @@ cd egeria*gz ls ``` ```bash -Dockerfile LICENSE NOTICE README.md assembly dist +Dockerfile LICENSE NOTICE +README.md assembly dist ``` As before, you may notice different files as Egeria evolves. @@ -70,8 +71,8 @@ Under `platform` is a directory for the [OMAG Server Platform](/concepts/omag-se ls platform ``` ```bash -README.md data keystore.p12 logs truststore.p12 -application.properties extra lib omag-server-platform-4.3.jar +README.md data keystore.p12 logs truststore.p12 +application.properties extra lib omag-server-platform-4.3.jar ``` The `platform/lib` directory is where the jar files for connectors, samples and new registered services are installed. It includes the connectors that are located in the `egeria.git` repository. ```bash @@ -99,7 +100,7 @@ The `opt` and `etc` directories contain additional content that can used with th ls etc/reports ``` ```bash -README.md component-id-report.jar database-report.jar egeria-platform-report.jar +README.md component-id-report.jar database-report.jar egeria-platform-report.jar ``` The `opt/content-packs` directory contains [Open Metadata Archives](/concepts/open-metadata-archive) that provide sample open metadata content. The `README.md` describes their content. ```bash @@ -117,9 +118,6 @@ The `/opt/sample-data` directory contains sample data that is used in various la ls /opt/sample-data/* ``` ```bash -README.md database old-market-drop-foot-weekly-measurements -data-files oak-dene-drop-foot-weekly-measurements -mandy-chessell@Amandas-MacBook-Pro assembly % ls opt/sample-data/* opt/sample-data/README.md opt/sample-data/data-files: @@ -135,4 +133,3 @@ week1.csv week2.csv week3.csv week4.csv week5.csv Notice that each directory contains a `README.md` file that explains the content of the directory. ---8<-- "snippets/abbr.md"