diff --git a/site/docs/education/egeria-dojo/developer/overview-old.md b/site/docs/education/egeria-dojo/developer/overview-old.md index 0161caf6a7..f15a622879 100644 --- a/site/docs/education/egeria-dojo/developer/overview-old.md +++ b/site/docs/education/egeria-dojo/developer/overview-old.md @@ -46,7 +46,7 @@ After completing developer day of the egeria dojo you should feel comfortable wi Many of the contributors to the Egeria project use the *[IntelliJ IDEA](https://www.jetbrains.com/idea/)* IDE. Jetbrains offers a [free community edition of IntelliJ](https://www.jetbrains.com/idea/download/) which is sufficient to work with Egeria. You are free to use any IDE during the dojo, however the instructions will focus on IntelliJ IDEA. ??? tip "Installing IntelliJ IDEA ..." - --8<-- "docs/education/tutorials/intellij-tutorial/task-installing-intellij.md" + --8<-- "snippets/tasks/task-installing-intellij.md" Congratulations, you are ready to begin. diff --git a/site/docs/education/egeria-dojo/developer/overview.md b/site/docs/education/egeria-dojo/developer/overview.md index 34740440ee..24fb5ad4cb 100644 --- a/site/docs/education/egeria-dojo/developer/overview.md +++ b/site/docs/education/egeria-dojo/developer/overview.md @@ -108,7 +108,7 @@ This dojo was last tested using Egeria release 3.14. Many of the contributors to the Egeria project use the *[IntelliJ IDEA](https://www.jetbrains.com/idea/){ target=dojo-support }* IDE. Jetbrains offers a [free community edition of IntelliJ](https://www.jetbrains.com/idea/download/) which is sufficient to work with Egeria. You are free to use any IDE during the dojo, however the instructions will focus on IntelliJ IDEA. ??? tip "Installing IntelliJ IDEA ..." - --8<-- "docs/education/tutorials/intellij-tutorial/task-installing-intellij.md" + --8<-- "snippets/tasks/task-installing-intellij.md" Congratulations, you are ready to begin. diff --git a/site/docs/education/tutorials/building-egeria-tutorial/overview.md b/site/docs/education/tutorials/building-egeria-tutorial/overview.md index b327f3c5a5..ea5dc3dc14 100644 --- a/site/docs/education/tutorials/building-egeria-tutorial/overview.md +++ b/site/docs/education/tutorials/building-egeria-tutorial/overview.md @@ -5,7 +5,7 @@ Egeria is an open source project that is delivered both as source code as well as [Maven Central Repository](https://search.maven.org/) libraries. -This tutorial will guide you through the process of downloading the core Egeria source code from [GitHub](https://github.com/) and building it so that you can run it on your local machine. +This tutorial will guide you through the process of downloading the core Egeria source code from [GitHub](https://github.com/) and building it so that you can install and run it on your local machine. Alternatively you can also use [Kubernetes](/guides/operations/kubernetes) to run Egeria. This uses the published builds of Egeria and does not require you to build Egeria on your machine. @@ -13,16 +13,14 @@ Alternatively you can also use [Kubernetes](/guides/operations/kubernetes) to ru ??? tip "Installing Java" --8<-- "snippets/tasks/task-installing-java.md" -??? tip "Installing Maven (rarely needed)" - --8<-- "snippets/tasks/task-installing-maven.md" ## Tutorial tasks -1. [Downloading the Egeria source from GitHub](#downloading-the-egeria-source-from-github) -2. [Building the Egeria source with Apache Maven](#building-the-egeria-source) +1. [Downloading the Egeria source from GitHub](#downloading-egeria-from-github-website) +2. [Building the Egeria source](#building-the-egeria-source) 3. [Installing Egeria](#installing-egeria) ---8<-- "snippets/tasks/task-cloning-egeria-source.md" +--8<-- "snippets/tasks/task-downloading-egeria-source.md" You are now ready to [build the egeria source](#building-the-egeria-source). @@ -32,11 +30,13 @@ You are now ready to [build the egeria source](#building-the-egeria-source). ## What next? -This is the end of the *Downloading and Building Egeria Tutorial*. You are now +This is the end of the *Downloading and Building Egeria Tutorial*. You are now ready to [learn about the OMAG Server Platform](/education/tutorials/omag-server-tutorial/overview). Alternatively ... +* [Set up IntelliJ ready to develop connectors or clients that use Egeria](/education/tutorials/developer-intellij-tutorial) +or * [Run the open metadata labs to get experience with using Egeria](/education/open-metadata-labs/overview) or * [Learn about developing extensions to Egeria](/guides/developer) diff --git a/site/docs/education/tutorials/developer-intellij-tutorial/create-intellij-project.png b/site/docs/education/tutorials/developer-intellij-tutorial/create-intellij-project.png new file mode 100644 index 0000000000..f7ddf5bf8f Binary files /dev/null and b/site/docs/education/tutorials/developer-intellij-tutorial/create-intellij-project.png differ diff --git a/site/docs/education/tutorials/developer-intellij-tutorial/create-test-metadata-store.png b/site/docs/education/tutorials/developer-intellij-tutorial/create-test-metadata-store.png new file mode 100644 index 0000000000..ab27851ba7 Binary files /dev/null and b/site/docs/education/tutorials/developer-intellij-tutorial/create-test-metadata-store.png differ diff --git a/site/docs/education/tutorials/developer-intellij-tutorial/edit-configurations-empty-wizard.png b/site/docs/education/tutorials/developer-intellij-tutorial/edit-configurations-empty-wizard.png new file mode 100644 index 0000000000..a41551759d Binary files /dev/null and b/site/docs/education/tutorials/developer-intellij-tutorial/edit-configurations-empty-wizard.png differ diff --git a/site/docs/education/tutorials/developer-intellij-tutorial/edit-configurations.png b/site/docs/education/tutorials/developer-intellij-tutorial/edit-configurations.png new file mode 100644 index 0000000000..6126342270 Binary files /dev/null and b/site/docs/education/tutorials/developer-intellij-tutorial/edit-configurations.png differ diff --git a/site/docs/education/tutorials/developer-intellij-tutorial/egeria-platform-in-run-menu.png b/site/docs/education/tutorials/developer-intellij-tutorial/egeria-platform-in-run-menu.png new file mode 100644 index 0000000000..55c496dd61 Binary files /dev/null and b/site/docs/education/tutorials/developer-intellij-tutorial/egeria-platform-in-run-menu.png differ diff --git a/site/docs/education/tutorials/developer-intellij-tutorial/egeria-platform-report-no-servers.md b/site/docs/education/tutorials/developer-intellij-tutorial/egeria-platform-report-no-servers.md new file mode 100644 index 0000000000..c910f4d23a --- /dev/null +++ b/site/docs/education/tutorials/developer-intellij-tutorial/egeria-platform-report-no-servers.md @@ -0,0 +1,61 @@ + + + +# Platform report for: https://localhost:9443 + +## Platform deployment +* **Egeria version**: Egeria OMAG Server Platform (version 4.3) +* **Configuration document store connector**: *null* +* **Platform security connector**: *null* +## Registered services +* **Data Manager OMAS**: Capture changes to the data stores and data set managed by a data manager such as a database server, content manager or file system. +* **Subject Area OMAS**: Document knowledge about a subject area +* **Glossary View OMAS**: Support glossary terms visualization +* **Design Model OMAS**: Exchange design model content with tools and standard packages +* **Security Officer OMAS**: Set up rules and security tags to protect data +* **Asset Manager OMAS**: Manage metadata from a third party asset manager +* **IT Infrastructure OMAS**: Manage information about the deployed IT infrastructure +* **Data Science OMAS**: Create and manage data science definitions and models +* **Community Profile OMAS**: Define personal profile and collaborate +* **Data Engine OMAS**: Exchange process models and lineage with a data engine +* **Discovery Engine OMAS**: Support for automated metadata discovery engines +* **Digital Architecture OMAS**: Design of the digital services for an organization +* **Asset Owner OMAS**: Manage an asset +* **Stewardship Action OMAS**: Manage exceptions and actions from open governance +* **Governance Program OMAS**: Manage the governance program +* **Digital Service OMAS**: Manage a digital service through its lifecycle +* **Asset Lineage OMAS**: Store asset lineage +* **Asset Consumer OMAS**: Access assets through connectors +* **Asset Catalog OMAS**: Search and understand your assets +* **DevOps OMAS**: Manage a DevOps pipeline +* **Software Developer OMAS**: Interact with software development tools +* **Project Management OMAS**: Manage governance related projects +* **Governance Engine OMAS**: Set up an operational governance engine +* **Data Privacy OMAS**: Manage governance of privacy +* **Security Manager OMAS**: Manages exchange of metadata with a security service +* **Governance Action OMES**: Executes requested governance action services to monitor, assess and maintain metadata and its real-world counterparts. +* **Repository Governance OMES**: Dynamically governance open metadata repositories in the connected cohorts. +* **Asset Analysis OMES**: Analyses the content of an asset's real world counterpart, generates annotations in an open discovery report that is attached to the asset in the open metadata repositories. +* **Infrastructure Integrator OMIS**: Exchange information relating to IT infrastructure such as hosts, platforms, servers, server capabilities and services. +* **Files Integrator OMIS**: Extract metadata about files stored in a file system or file manager. +* **Topic Integrator OMIS**: Exchange metadata with third party event-based brokers. +* **Security Integrator OMIS**: Distribute security properties to security enforcement points. +* **API Integrator OMIS**: Exchange metadata with third party API Gateways. +* **Search Integrator OMIS**: Store metadata with a third party technology that is focused on search efficiency. +* **Lineage Integrator OMIS**: Manage capture of lineage from a third party tool. +* **Database Integrator OMIS**: Extract metadata such as schema, tables and columns from database managers. +* **Catalog Integrator OMIS**: Exchange metadata with third party data catalogs. +* **Display Integrator OMIS**: Exchange metadata with applications that display data to users. +* **Analytics Integrator OMIS**: Exchange metadata with third party analytics tools. +* **Organization Integrator OMIS**: Load information about the teams and people in an organization and return collaboration activity. +* **Glossary Author OMVS**: View Service for glossary authoring. +* **Dynamic Infrastructure and Operations OMVS**: Explore and operate an open metadata ecosystem. +* **Repository Explorer OMVS**: Explore open metadata instances. +* **Glossary Workflow OMVS**: Create glossary terms and organize them into categories as part of a controlled workflow process. It supports the editing glossary and multiple states. +* **My Profile OMVS**: Manage information about the logged on user as well as their preferences. +* **Type Explorer OMVS**: Explore the open metadata types in a repository or cohort. +* **Server Author OMVS**: Author servers. +* **Glossary Browser OMVS**: View glossary terms and categories within a glossary. +## Platform servers +None +--8<-- "snippets/abbr.md" \ No newline at end of file diff --git a/site/docs/education/tutorials/developer-intellij-tutorial/egeria-platform-report-server-config.md b/site/docs/education/tutorials/developer-intellij-tutorial/egeria-platform-report-server-config.md new file mode 100644 index 0000000000..b4f5b70035 --- /dev/null +++ b/site/docs/education/tutorials/developer-intellij-tutorial/egeria-platform-report-server-config.md @@ -0,0 +1,117 @@ + + + +# Platform report for: https://localhost:9443 + +## Platform deployment +* **Egeria version**: Egeria OMAG Server Platform (version 4.3) +* **Configuration document store connector**: *null* +* **Platform security connector**: *null* +## Registered services +* **Data Manager OMAS**: Capture changes to the data stores and data set managed by a data manager such as a database server, content manager or file system. +* **Subject Area OMAS**: Document knowledge about a subject area +* **Glossary View OMAS**: Support glossary terms visualization +* **Design Model OMAS**: Exchange design model content with tools and standard packages +* **Security Officer OMAS**: Set up rules and security tags to protect data +* **Asset Manager OMAS**: Manage metadata from a third party asset manager +* **IT Infrastructure OMAS**: Manage information about the deployed IT infrastructure +* **Data Science OMAS**: Create and manage data science definitions and models +* **Community Profile OMAS**: Define personal profile and collaborate +* **Data Engine OMAS**: Exchange process models and lineage with a data engine +* **Discovery Engine OMAS**: Support for automated metadata discovery engines +* **Digital Architecture OMAS**: Design of the digital services for an organization +* **Asset Owner OMAS**: Manage an asset +* **Stewardship Action OMAS**: Manage exceptions and actions from open governance +* **Governance Program OMAS**: Manage the governance program +* **Digital Service OMAS**: Manage a digital service through its lifecycle +* **Asset Lineage OMAS**: Store asset lineage +* **Asset Consumer OMAS**: Access assets through connectors +* **Asset Catalog OMAS**: Search and understand your assets +* **DevOps OMAS**: Manage a DevOps pipeline +* **Software Developer OMAS**: Interact with software development tools +* **Project Management OMAS**: Manage governance related projects +* **Governance Engine OMAS**: Set up an operational governance engine +* **Data Privacy OMAS**: Manage governance of privacy +* **Security Manager OMAS**: Manages exchange of metadata with a security service +* **Governance Action OMES**: Executes requested governance action services to monitor, assess and maintain metadata and its real-world counterparts. +* **Repository Governance OMES**: Dynamically governance open metadata repositories in the connected cohorts. +* **Asset Analysis OMES**: Analyses the content of an asset's real world counterpart, generates annotations in an open discovery report that is attached to the asset in the open metadata repositories. +* **Infrastructure Integrator OMIS**: Exchange information relating to IT infrastructure such as hosts, platforms, servers, server capabilities and services. +* **Files Integrator OMIS**: Extract metadata about files stored in a file system or file manager. +* **Topic Integrator OMIS**: Exchange metadata with third party event-based brokers. +* **Security Integrator OMIS**: Distribute security properties to security enforcement points. +* **API Integrator OMIS**: Exchange metadata with third party API Gateways. +* **Search Integrator OMIS**: Store metadata with a third party technology that is focused on search efficiency. +* **Lineage Integrator OMIS**: Manage capture of lineage from a third party tool. +* **Database Integrator OMIS**: Extract metadata such as schema, tables and columns from database managers. +* **Catalog Integrator OMIS**: Exchange metadata with third party data catalogs. +* **Display Integrator OMIS**: Exchange metadata with applications that display data to users. +* **Analytics Integrator OMIS**: Exchange metadata with third party analytics tools. +* **Organization Integrator OMIS**: Load information about the teams and people in an organization and return collaboration activity. +* **Glossary Author OMVS**: View Service for glossary authoring. +* **Dynamic Infrastructure and Operations OMVS**: Explore and operate an open metadata ecosystem. +* **Repository Explorer OMVS**: Explore open metadata instances. +* **Glossary Workflow OMVS**: Create glossary terms and organize them into categories as part of a controlled workflow process. It supports the editing glossary and multiple states. +* **My Profile OMVS**: Manage information about the logged on user as well as their preferences. +* **Type Explorer OMVS**: Explore the open metadata types in a repository or cohort. +* **Server Author OMVS**: Author servers. +* **Glossary Browser OMVS**: View glossary terms and categories within a glossary. +## Platform servers +### Server: test-metadata-store +* **Type**: *null* +* **Description**: Metadata Access Store called test-metadata-store running on platform https://localhost:9443 +* **UserId**: cocoMDS1npa +#### Security Connector +* **Implementation**: org.odpi.openmetadata.metadatasecurity.samples.CocoPharmaServerSecurityProvider +* **Location**: *null* +#### Local Repository +* **Local Repository Mode**: Open Metadata Native +##### Local Repository Connector +* **Implementation**: org.odpi.openmetadata.adapters.repositoryservices.inmemory.repositoryconnector.InMemoryOMRSRepositoryConnectorProvider +* **Location**: *null* +##### Local Repository Remote Connector +* **Implementation**: org.odpi.openmetadata.adapters.repositoryservices.rest.repositoryconnector.OMRSRESTRepositoryConnectorProvider +* **Location**: https://localhost:9443/servers/test-metadata-store +#### Runtime Status +#### Services +##### Service: Asset Manager OMAS +###### Service Options +* **SupportedZones**: [quarantine, trash-can, data-lake] +* **PublishZones**: [data-lake, personal-files] +* **DefaultZones**: [quarantine] +##### Service: Community Profile OMAS +###### Service Options +* **KarmaPointPlateau**: 10 +* **SupportedZones**: [data-lake, personal-files] +* **DefaultZones**: [personal-files] +##### Service: Data Manager OMAS +###### Service Options +* **SupportedZones**: [quarantine, trash-can, data-lake] +* **PublishZones**: [data-lake, personal-files] +* **DefaultZones**: [quarantine] +##### Service: Digital Architecture OMAS +###### Service Options +* **SupportedZones**: [quarantine, trash-can, data-lake] +* **PublishZones**: [data-lake, personal-files] +* **DefaultZones**: [quarantine] +##### Service: Asset Consumer OMAS +###### Service Options +* **SupportedZones**: [data-lake, personal-files] +* **DefaultZones**: [personal-files] +##### Service: Governance Program OMAS +###### Service Options +* **SupportedZones**: [quarantine, trash-can, data-lake] +* **PublishZones**: [data-lake, personal-files] +* **DefaultZones**: [quarantine] +##### Service: IT Infrastructure OMAS +###### Service Options +* **SupportedZones**: [quarantine, trash-can, data-lake] +* **PublishZones**: [data-lake, personal-files] +* **DefaultZones**: [quarantine] +##### Service: Asset Owner OMAS +###### Service Options +* **SupportedZones**: [quarantine, trash-can, data-lake] +* **PublishZones**: [data-lake, personal-files] +* **DefaultZones**: [quarantine] + +--8<-- "snippets/abbr.md" \ No newline at end of file diff --git a/site/docs/education/tutorials/developer-intellij-tutorial/egeria-platform-report-server-running.md b/site/docs/education/tutorials/developer-intellij-tutorial/egeria-platform-report-server-running.md new file mode 100644 index 0000000000..bc97b4f35f --- /dev/null +++ b/site/docs/education/tutorials/developer-intellij-tutorial/egeria-platform-report-server-running.md @@ -0,0 +1,135 @@ + + + +# Platform report for: https://localhost:9443 + +## Platform deployment +* **Egeria version**: Egeria OMAG Server Platform (version 4.3) +* **Configuration document store connector**: *null* +* **Platform security connector**: *null* +## Registered services +* **Data Manager OMAS**: Capture changes to the data stores and data set managed by a data manager such as a database server, content manager or file system. +* **Subject Area OMAS**: Document knowledge about a subject area +* **Glossary View OMAS**: Support glossary terms visualization +* **Design Model OMAS**: Exchange design model content with tools and standard packages +* **Security Officer OMAS**: Set up rules and security tags to protect data +* **Asset Manager OMAS**: Manage metadata from a third party asset manager +* **IT Infrastructure OMAS**: Manage information about the deployed IT infrastructure +* **Data Science OMAS**: Create and manage data science definitions and models +* **Community Profile OMAS**: Define personal profile and collaborate +* **Data Engine OMAS**: Exchange process models and lineage with a data engine +* **Discovery Engine OMAS**: Support for automated metadata discovery engines +* **Digital Architecture OMAS**: Design of the digital services for an organization +* **Asset Owner OMAS**: Manage an asset +* **Stewardship Action OMAS**: Manage exceptions and actions from open governance +* **Governance Program OMAS**: Manage the governance program +* **Digital Service OMAS**: Manage a digital service through its lifecycle +* **Asset Lineage OMAS**: Store asset lineage +* **Asset Consumer OMAS**: Access assets through connectors +* **Asset Catalog OMAS**: Search and understand your assets +* **DevOps OMAS**: Manage a DevOps pipeline +* **Software Developer OMAS**: Interact with software development tools +* **Project Management OMAS**: Manage governance related projects +* **Governance Engine OMAS**: Set up an operational governance engine +* **Data Privacy OMAS**: Manage governance of privacy +* **Security Manager OMAS**: Manages exchange of metadata with a security service +* **Governance Action OMES**: Executes requested governance action services to monitor, assess and maintain metadata and its real-world counterparts. +* **Repository Governance OMES**: Dynamically governance open metadata repositories in the connected cohorts. +* **Asset Analysis OMES**: Analyses the content of an asset's real world counterpart, generates annotations in an open discovery report that is attached to the asset in the open metadata repositories. +* **Infrastructure Integrator OMIS**: Exchange information relating to IT infrastructure such as hosts, platforms, servers, server capabilities and services. +* **Files Integrator OMIS**: Extract metadata about files stored in a file system or file manager. +* **Topic Integrator OMIS**: Exchange metadata with third party event-based brokers. +* **Security Integrator OMIS**: Distribute security properties to security enforcement points. +* **API Integrator OMIS**: Exchange metadata with third party API Gateways. +* **Search Integrator OMIS**: Store metadata with a third party technology that is focused on search efficiency. +* **Lineage Integrator OMIS**: Manage capture of lineage from a third party tool. +* **Database Integrator OMIS**: Extract metadata such as schema, tables and columns from database managers. +* **Catalog Integrator OMIS**: Exchange metadata with third party data catalogs. +* **Display Integrator OMIS**: Exchange metadata with applications that display data to users. +* **Analytics Integrator OMIS**: Exchange metadata with third party analytics tools. +* **Organization Integrator OMIS**: Load information about the teams and people in an organization and return collaboration activity. +* **Glossary Author OMVS**: View Service for glossary authoring. +* **Dynamic Infrastructure and Operations OMVS**: Explore and operate an open metadata ecosystem. +* **Repository Explorer OMVS**: Explore open metadata instances. +* **Glossary Workflow OMVS**: Create glossary terms and organize them into categories as part of a controlled workflow process. It supports the editing glossary and multiple states. +* **My Profile OMVS**: Manage information about the logged on user as well as their preferences. +* **Type Explorer OMVS**: Explore the open metadata types in a repository or cohort. +* **Server Author OMVS**: Author servers. +* **Glossary Browser OMVS**: View glossary terms and categories within a glossary. +## Platform servers +### Server: test-metadata-store +* **Type**: Metadata Access Store +* **Description**: Metadata Access Store called test-metadata-store running on platform https://localhost:9443 +* **UserId**: cocoMDS1npa +#### Security Connector +* **Implementation**: org.odpi.openmetadata.metadatasecurity.samples.CocoPharmaServerSecurityProvider +* **Location**: *null* +#### Local Repository +* **Local Repository Mode**: Open Metadata Native +##### Local Repository Connector +* **Implementation**: org.odpi.openmetadata.adapters.repositoryservices.inmemory.repositoryconnector.InMemoryOMRSRepositoryConnectorProvider +* **Location**: *null* +##### Local Repository Remote Connector +* **Implementation**: org.odpi.openmetadata.adapters.repositoryservices.rest.repositoryconnector.OMRSRESTRepositoryConnectorProvider +* **Location**: https://localhost:9443/servers/test-metadata-store +#### Runtime Status +* **Last Start Time**: Wed Sep 13 19:28:42 BST 2023 +* **Server Active Status**: Running +#### Services +##### Service: Asset Manager OMAS +* **Service Status**: Running +###### Service Options +* **SupportedZones**: [quarantine, trash-can, data-lake] +* **PublishZones**: [data-lake, personal-files] +* **DefaultZones**: [quarantine] +##### Service: Governance Action Framework Services +* **Service Status**: Starting +##### Service: Open Metadata Repository Services (OMRS) +* **Service Status**: Running +##### Service: Connected Asset Services +* **Service Status**: Starting +##### Service: Community Profile OMAS +* **Service Status**: Running +###### Service Options +* **KarmaPointPlateau**: 10 +* **SupportedZones**: [data-lake, personal-files] +* **DefaultZones**: [personal-files] +##### Service: Data Manager OMAS +* **Service Status**: Running +###### Service Options +* **SupportedZones**: [quarantine, trash-can, data-lake] +* **PublishZones**: [data-lake, personal-files] +* **DefaultZones**: [quarantine] +##### Service: Digital Architecture OMAS +* **Service Status**: Running +###### Service Options +* **SupportedZones**: [quarantine, trash-can, data-lake] +* **PublishZones**: [data-lake, personal-files] +* **DefaultZones**: [quarantine] +##### Service: Asset Consumer OMAS +* **Service Status**: Running +###### Service Options +* **SupportedZones**: [data-lake, personal-files] +* **DefaultZones**: [personal-files] +##### Service: Governance Program OMAS +* **Service Status**: Running +###### Service Options +* **SupportedZones**: [quarantine, trash-can, data-lake] +* **PublishZones**: [data-lake, personal-files] +* **DefaultZones**: [quarantine] +##### Service: IT Infrastructure OMAS +* **Service Status**: Running +###### Service Options +* **SupportedZones**: [quarantine, trash-can, data-lake] +* **PublishZones**: [data-lake, personal-files] +* **DefaultZones**: [quarantine] +##### Service: Open Integration Service +* **Service Status**: Starting +##### Service: Asset Owner OMAS +* **Service Status**: Running +###### Service Options +* **SupportedZones**: [quarantine, trash-can, data-lake] +* **PublishZones**: [data-lake, personal-files] +* **DefaultZones**: [quarantine] + +--8<-- "snippets/abbr.md" \ No newline at end of file diff --git a/site/docs/education/tutorials/developer-intellij-tutorial/egeria-platform-settings.png b/site/docs/education/tutorials/developer-intellij-tutorial/egeria-platform-settings.png new file mode 100644 index 0000000000..f138a5628a Binary files /dev/null and b/site/docs/education/tutorials/developer-intellij-tutorial/egeria-platform-settings.png differ diff --git a/site/docs/education/tutorials/developer-intellij-tutorial/location-of-platform-report.png b/site/docs/education/tutorials/developer-intellij-tutorial/location-of-platform-report.png new file mode 100644 index 0000000000..1a0acd167c Binary files /dev/null and b/site/docs/education/tutorials/developer-intellij-tutorial/location-of-platform-report.png differ diff --git a/site/docs/education/tutorials/developer-intellij-tutorial/new-project-is-opened.png b/site/docs/education/tutorials/developer-intellij-tutorial/new-project-is-opened.png new file mode 100644 index 0000000000..e5fdb67092 Binary files /dev/null and b/site/docs/education/tutorials/developer-intellij-tutorial/new-project-is-opened.png differ diff --git a/site/docs/education/tutorials/developer-intellij-tutorial/overview.md b/site/docs/education/tutorials/developer-intellij-tutorial/overview.md new file mode 100644 index 0000000000..87cdf10969 --- /dev/null +++ b/site/docs/education/tutorials/developer-intellij-tutorial/overview.md @@ -0,0 +1,48 @@ + + + +# Setting up IntelliJ to develop components for Egeria + +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) + +## Prerequisite tasks + +* [Set up Egeria](/education/tutorials/building-egeria-tutorial/overview) +* [Install and start Apache Kafka](/education/tutorials/kafka-tutorial/overview) + +## 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 + +--8<-- "snippets/tasks/task-installing-intellij.md" + +--8<-- "docs/education/tutorials/developer-intellij-tutorial/task-create-intellij-project.md" + +--8<-- "docs/education/tutorials/developer-intellij-tutorial/task-set-up-platform-in-intellij.md" + +--8<-- "docs/education/tutorials/developer-intellij-tutorial/task-server-config-in-intellij.md" + +--8<-- "docs/education/tutorials/developer-intellij-tutorial/task-server-ops-in-intellij.md" + + + +## What next? + +Now that IntelliJ is set up, you can: + +* Build a new connector. +* Build a client that calls Egeria. + +The [Developer Guide](/guides/developer) provides detailed information on developing with Egeria. + + +---8<-- "snippets/abbr.md" + + diff --git a/site/docs/education/tutorials/developer-intellij-tutorial/platform-report-as-markdown.png b/site/docs/education/tutorials/developer-intellij-tutorial/platform-report-as-markdown.png new file mode 100644 index 0000000000..9276f865f8 Binary files /dev/null and b/site/docs/education/tutorials/developer-intellij-tutorial/platform-report-as-markdown.png differ diff --git a/site/docs/education/tutorials/developer-intellij-tutorial/platform-report-settings-4-3.png b/site/docs/education/tutorials/developer-intellij-tutorial/platform-report-settings-4-3.png new file mode 100644 index 0000000000..2447617c9c Binary files /dev/null and b/site/docs/education/tutorials/developer-intellij-tutorial/platform-report-settings-4-3.png differ diff --git a/site/docs/education/tutorials/developer-intellij-tutorial/platform-report-settings-4-4.png b/site/docs/education/tutorials/developer-intellij-tutorial/platform-report-settings-4-4.png new file mode 100644 index 0000000000..20896e84d0 Binary files /dev/null and b/site/docs/education/tutorials/developer-intellij-tutorial/platform-report-settings-4-4.png differ diff --git a/site/docs/education/tutorials/developer-intellij-tutorial/platform-starting.png b/site/docs/education/tutorials/developer-intellij-tutorial/platform-starting.png new file mode 100644 index 0000000000..6b3c1ac4c8 Binary files /dev/null and b/site/docs/education/tutorials/developer-intellij-tutorial/platform-starting.png differ diff --git a/site/docs/education/tutorials/developer-intellij-tutorial/re-run-platform-report.png b/site/docs/education/tutorials/developer-intellij-tutorial/re-run-platform-report.png new file mode 100644 index 0000000000..b6c3a05a9f Binary files /dev/null and b/site/docs/education/tutorials/developer-intellij-tutorial/re-run-platform-report.png differ diff --git a/site/docs/education/tutorials/developer-intellij-tutorial/run-egeria-platform.png b/site/docs/education/tutorials/developer-intellij-tutorial/run-egeria-platform.png new file mode 100644 index 0000000000..517c8615eb Binary files /dev/null and b/site/docs/education/tutorials/developer-intellij-tutorial/run-egeria-platform.png differ diff --git a/site/docs/education/tutorials/developer-intellij-tutorial/run-platform-report.png b/site/docs/education/tutorials/developer-intellij-tutorial/run-platform-report.png new file mode 100644 index 0000000000..4598126f2a Binary files /dev/null and b/site/docs/education/tutorials/developer-intellij-tutorial/run-platform-report.png differ diff --git a/site/docs/education/tutorials/developer-intellij-tutorial/select-jar-application.png b/site/docs/education/tutorials/developer-intellij-tutorial/select-jar-application.png new file mode 100644 index 0000000000..dab857cc4d Binary files /dev/null and b/site/docs/education/tutorials/developer-intellij-tutorial/select-jar-application.png differ diff --git a/site/docs/education/tutorials/developer-intellij-tutorial/server-config-settings-4-3.png b/site/docs/education/tutorials/developer-intellij-tutorial/server-config-settings-4-3.png new file mode 100644 index 0000000000..9f3930bb3a Binary files /dev/null and b/site/docs/education/tutorials/developer-intellij-tutorial/server-config-settings-4-3.png differ diff --git a/site/docs/education/tutorials/developer-intellij-tutorial/server-config-settings-4-4.png b/site/docs/education/tutorials/developer-intellij-tutorial/server-config-settings-4-4.png new file mode 100644 index 0000000000..fc10dc3dca Binary files /dev/null and b/site/docs/education/tutorials/developer-intellij-tutorial/server-config-settings-4-4.png differ diff --git a/site/docs/education/tutorials/developer-intellij-tutorial/server-config-started.png b/site/docs/education/tutorials/developer-intellij-tutorial/server-config-started.png new file mode 100644 index 0000000000..41ad2dfa22 Binary files /dev/null and b/site/docs/education/tutorials/developer-intellij-tutorial/server-config-started.png differ diff --git a/site/docs/education/tutorials/developer-intellij-tutorial/server-ops-settings-4-3.png b/site/docs/education/tutorials/developer-intellij-tutorial/server-ops-settings-4-3.png new file mode 100644 index 0000000000..543252f6a1 Binary files /dev/null and b/site/docs/education/tutorials/developer-intellij-tutorial/server-ops-settings-4-3.png differ diff --git a/site/docs/education/tutorials/developer-intellij-tutorial/server-ops-settings-4-4.png b/site/docs/education/tutorials/developer-intellij-tutorial/server-ops-settings-4-4.png new file mode 100644 index 0000000000..6c7e636b8c Binary files /dev/null and b/site/docs/education/tutorials/developer-intellij-tutorial/server-ops-settings-4-4.png differ diff --git a/site/docs/education/tutorials/developer-intellij-tutorial/server-ops-started.png b/site/docs/education/tutorials/developer-intellij-tutorial/server-ops-started.png new file mode 100644 index 0000000000..79517ba2af Binary files /dev/null and b/site/docs/education/tutorials/developer-intellij-tutorial/server-ops-started.png differ diff --git a/site/docs/education/tutorials/developer-intellij-tutorial/specify-project-details.png b/site/docs/education/tutorials/developer-intellij-tutorial/specify-project-details.png new file mode 100644 index 0000000000..e709fff2bd Binary files /dev/null and b/site/docs/education/tutorials/developer-intellij-tutorial/specify-project-details.png differ diff --git a/site/docs/education/tutorials/developer-intellij-tutorial/start-test-metadata-store.png b/site/docs/education/tutorials/developer-intellij-tutorial/start-test-metadata-store.png new file mode 100644 index 0000000000..1536b3de0e Binary files /dev/null and b/site/docs/education/tutorials/developer-intellij-tutorial/start-test-metadata-store.png differ 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 new file mode 100644 index 0000000000..44a5ab334f --- /dev/null +++ b/site/docs/education/tutorials/developer-intellij-tutorial/task-create-intellij-project.md @@ -0,0 +1,20 @@ + + + +### Create IntelliJ project + +From an IntelliJ window, select `File->NewProject` from the top menu bar. + +![Select new project](create-intellij-project.png) + +Enter information about the project. In this example, the project is called `egeria-extensions`, it is written in Java and being built with Maven. + +![Enter project details](specify-project-details.png) + +Press the `Create` button and the new project is opened. + +![New project window](new-project-is-opened.png) + + + + 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 new file mode 100644 index 0000000000..d54bba3c1a --- /dev/null +++ b/site/docs/education/tutorials/developer-intellij-tutorial/task-server-config-in-intellij.md @@ -0,0 +1,30 @@ + + + +### Create test servers + +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" + ![server config settings](server-config-settings-4-3.png) + +==== "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. + +`ServerConfig` prints out a menu of the different configuration options it supports. + +![server config started](server-config-started.png) + +Click in the ServerConfig run window and enter `create-metadata-store test-metadata-store` and press enter. + +![create test-metadata-store](create-test-metadata-store.png) + +This will create a new [Metadata Access Store](/concepts/metadata-access-store) called `test-metadata-store`. + +![test-metadata-store create](test-metadata-store-created.png) + +You can select `PlatformReport` in the dropdown run menu, and click on the green triangle to re-run the `PlatformReport`. Notice that details of this new server are now included. + +![Rerun platform report](re-run-platform-report.png) \ No newline at end of file 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 new file mode 100644 index 0000000000..54e5e11d63 --- /dev/null +++ b/site/docs/education/tutorials/developer-intellij-tutorial/task-server-ops-in-intellij.md @@ -0,0 +1,33 @@ + + + +### Start and stop servers + +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" + ![server ops settings](server-ops-settings-4-3.png) + +==== "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. + +`ServerOps` prints out a menu of the different operations it supports. + +![server ops started](server-ops-started.png) + +Click in the ServerOps run window and enter `start test-metadata-store` and press enter. + +![start test-metadata-store](start-test-metadata-store.png) + +`ServerOps` returns with a list of the services that have been started. + +![start test-metadata-store](test-metadata-store-started.png) + + + + + + + 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 new file mode 100644 index 0000000000..bf7e301a73 --- /dev/null +++ b/site/docs/education/tutorials/developer-intellij-tutorial/task-set-up-platform-in-intellij.md @@ -0,0 +1,66 @@ + + + +### Set up OMAG Server Platform in intelliJ + +The next set of instructions makes it easy to start and stop an OMAG Server Platform from IntelliJ. + +Select `Edit Configurations` from the dropdown run menu. + +![edit configurations option](edit-configurations.png) + +Click on the `+` sign in the top left of the wizard. + +![edit configurations empty wizard](edit-configurations-empty-wizard.png) + +Select `JAR Application`: + +![select jar application](select-jar-application.png) + +Fill in the properties based on the directory where you installed egeria. In this example, egeria was installed in directory `/Users/mandy-chessell/egeria-install/egeria-platform-4.3-distribution.tar.gz/` and so the settings are: + +* Path to JAR: `{install directory}/assembly/platform/omag-server-platform-4.3.jar` +* VM Options: `-Dloader.path=lib,extra` +* Working Directory: `{install directory}/assembly/platform` + +![egeria platform settings](egeria-platform-settings.png) + +Press `OK` to save the configuration and `EgeriaPlatform` appears in the dropdown run menu. + +![egeria platform in run menu](egeria-platform-in-run-menu.png) + +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. + +![platform starting](platform-starting.png) + +When you see the message `OMAG server platform ready for more configuration` then the platform has initialized. + +Egeria's assembly includes a utility called `EgeriaPlatformReport` that queries the status of an OMAG Server Platform. It is useful to set up to check that your platform is running correctly. + +Select `Edit Configurations` to create another `JAR Application`. This time call it `PlatformReport`. The JAR file is called `{install directory}/assembly/etc/reports/egeria-platform-report.jar` + +![location of platform report jar](location-of-platform-report.png) + +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" + ![platform report settings](platform-report-settings-4-3.png) + +==== "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. + +![Run platform report](run-platform-report.png) + +Also notice that a new markdown file called `egeria-platform-report.md` has appeared in your project files that includes the details of the platform report as a markdown file. + +The platform report provides details of the current status of the platform. Each time you run the report, a new copy of `egeria-platform-report.md` is created + +If you open `egeria-platform-report.md` you can see a formatted version of the report. + +![markdown version of the report](platform-report-as-markdown.png) diff --git a/site/docs/education/tutorials/developer-intellij-tutorial/test-metadata-store-created.png b/site/docs/education/tutorials/developer-intellij-tutorial/test-metadata-store-created.png new file mode 100644 index 0000000000..0272a2aeed Binary files /dev/null and b/site/docs/education/tutorials/developer-intellij-tutorial/test-metadata-store-created.png differ diff --git a/site/docs/education/tutorials/developer-intellij-tutorial/test-metadata-store-started.png b/site/docs/education/tutorials/developer-intellij-tutorial/test-metadata-store-started.png new file mode 100644 index 0000000000..d5d6d9d1ba Binary files /dev/null and b/site/docs/education/tutorials/developer-intellij-tutorial/test-metadata-store-started.png differ diff --git a/site/docs/education/tutorials/docker-tutorial/overview.md b/site/docs/education/tutorials/docker-tutorial/overview.md index 171a524b60..99d895eab1 100644 --- a/site/docs/education/tutorials/docker-tutorial/overview.md +++ b/site/docs/education/tutorials/docker-tutorial/overview.md @@ -231,10 +231,10 @@ $ Only the files from the install image are present because we have not asked the OMAG Server Platform to do anything yet. However, as we configure servers and run them, you will see new files appearing. You can check back here from time to time to see the files accumulating. -If you delete this container then all of the files that the OMAG Server Platform created are lost. +If you delete this container then all the files that the OMAG Server Platform created are lost. (If you want to know more about the egeria install image, see the -[Installing Egeria Tutorial](/education/tutorials/installing-egeria-tutorial).) +[Installing Egeria Tutorial](/education/tutorials/building-egeria-tutorial/overview).) The third button on the docker desktop is the "STOP" button and the fourth button is "RESTART". If you just need to test these buttons, remember to ensure that the docker container is running diff --git a/site/docs/education/tutorials/index.md b/site/docs/education/tutorials/index.md index 7fbf6089bb..eaf539c687 100644 --- a/site/docs/education/tutorials/index.md +++ b/site/docs/education/tutorials/index.md @@ -5,7 +5,7 @@ --8<-- "snippets/supported-platforms.md" -The tutorials provide step-by-step guides that help you work with Egeria and its associated technology. They provide help to: +The tutorials provide step-by-step guides to help you work with Egeria and its associated technology. They provide help to: * **[Those that just want to run and use Egeria](#tutorials-for-running-egeria)**. This includes how to download and build Egeria, install it in a convenient directory, customise it and use containers for cloud deployment. * **[Those that want to develop code with Egeria](#tutorials-for-developing-with-egeria)** (such as building new connectors or calling Egeria's APIs). This includes setting Egeria up in IntelliJ ready for your development work. @@ -13,13 +13,13 @@ The tutorials provide step-by-step guides that help you work with Egeria and its ## Tutorials for running Egeria -Egeria is an open source project that can be: +Egeria can be set up and run using the following methods: -* Run to support the open metadata labs. These labs show Egeria in an operational mode serving different users in the Coco Pharmaceuticals business. Egeria is integrated with a variety of technologies in this environment, and it is set up to specifically support the scenarios within the labs. The implementation of the labs uses Kubernetes. Follow [this link if you want to run the labs](/education/open-metadata-labs/overview). +* Set-up to support the open metadata labs. These labs show Egeria in an operational mode serving different users in the Coco Pharmaceuticals business. Egeria is integrated with a variety of technologies in this environment, and it is set up to specifically support the scenarios within the labs. Follow [this link if you want to run the labs](/education/open-metadata-labs/overview). * Used directly from a prebuilt docker image from either [DockerHub](https://hub.docker.com/r/odpi/egeria) or [Quay.io](https://quay.io/repository/odpi/egeria). This docker image includes all the Egeria runtimes and can be used to experiment with different features of Egeria. If this option is for you, [go to the docker tutorial](/education/tutorials/docker-tutorial/overview). -* Downloaded and built to create your own customized version of Egeria. Egeria is highly customizable, use this method if you wish to deploy a customized Egeria for your organization. Go to [Starting with the code](#starting-with-the-code) if this is for you. +* Customized to support the specific needs of your organization. Customizing Egeria typically begins with downloading and building Egeria's source code. This requires Java. @@ -37,15 +37,14 @@ Once you have Java installed, you are ready to begin: ??? education "Installing Egeria" --8<-- "snippets/tasks/task-installing-egeria.md" -Once Egeria is installed, it is ready to be used. +Once Egeria is installed, it is ready to be used, or you can use it to set up IntelliJ. ## Tutorials for using Egeria -The [open metadata labs](/education/open-metadata-labs/overview) show how Egeria can be used in multiple scenarios. The labs are organized by user role, allowing you to focus on the aspects of Egeria that interests you. - The installed assembly gives you the option to run the platform directly from this assembly and/or customize the assembly and build it into a Docker image that can be used as part of a cloud-deployment. ??? education "Working with the OMAG Server Platform" + ### OMAG Server Platform tutorial The [OMAG Server Platform tutorial](/education/tutorials/omag-server-tutorial) takes you through the process of starting and stopping the platform; configuring, starting and stopping servers and querying the status of the platform and its servers. ??? education "Building a customized docker image" @@ -53,7 +52,28 @@ The installed assembly gives you the option to run the platform directly from th ## Tutorials for developing with Egeria -The Egeria community typically uses IntelliJ for its development. Information on how to set up your copy of IntelliJ with Egeria and build new components that work with Egeria are found in the [Using IntelliJ tutorial](/education/tutorials/intellij-tutorial/overview). +The Egeria community typically uses IntelliJ for its development. + +Customizing Egeria typically begins with downloading and building Egeria's source code. This requires Java. + +??? tip "Installing Java" +--8<-- "snippets/tasks/task-installing-java.md" + +Once you have Java installed, you are ready to begin: + +??? education "Downloading Egeria's source code" +--8<-- "snippets/tasks/task-downloading-egeria-source.md" + +??? education "Building Egeria" +--8<-- "snippets/tasks/task-building-egeria-source.md" + +??? education "Installing Egeria" +--8<-- "snippets/tasks/task-installing-egeria.md" + +Once Egeria is installed, it is ready to be used. + + +Information on how to set up your copy of IntelliJ with Egeria and build new components that work with Egeria are found in the [Using IntelliJ tutorial](/education/tutorials/intellij-tutorial/overview). ## Tutorials for contributing to Egeria diff --git a/site/docs/education/tutorials/installing-egeria-tutorial.md b/site/docs/education/tutorials/installing-egeria-tutorial.md deleted file mode 100644 index baa4677d5c..0000000000 --- a/site/docs/education/tutorials/installing-egeria-tutorial.md +++ /dev/null @@ -1,7 +0,0 @@ - - - ---8<-- "snippets/tasks/task-installing-egeria.md" - ----8<-- "snippets/abbr.md" - diff --git a/site/docs/education/tutorials/intellij-tutorial/overview.md b/site/docs/education/tutorials/intellij-tutorial/overview.md index 8d211fb459..fd4f9f063b 100644 --- a/site/docs/education/tutorials/intellij-tutorial/overview.md +++ b/site/docs/education/tutorials/intellij-tutorial/overview.md @@ -9,7 +9,7 @@ See the overview video of IntelliJ on its homepage. ## Managing your IntelliJ environment ---8<-- "docs/education/tutorials/intellij-tutorial/task-installing-intellij.md" +--8<-- "snippets/tasks/task-installing-intellij.md" --8<-- "docs/education/tutorials/intellij-tutorial/task-loading-egeria-into-intellij.md" --8<-- "docs/education/tutorials/intellij-tutorial/task-building-egeria-in-intellij.md" --8<-- "docs/education/tutorials/intellij-tutorial/task-installing-egeria-via-intellij.md" diff --git a/site/docs/guides/developer/integration-connectors/overview.md b/site/docs/guides/developer/integration-connectors/overview.md index 7962448ca9..1d812fee9f 100644 --- a/site/docs/guides/developer/integration-connectors/overview.md +++ b/site/docs/guides/developer/integration-connectors/overview.md @@ -382,7 +382,7 @@ Audit log messages help the people operating Egeria to be sure your integration Your integration connector implementation should be built and packaged in a *jar* file. This jar file contains your connector provider and connector implementation. It may optionally contain any dependent client libraries to the third party connector that are called directly by your integration connector. This is necessary if these client libraries are not available in their own jar file. -The connector jar file (and any jar files for the dependent third party client libraries not included in your connector's jar file) need to be added to the [OMAG Server Platform](/concepts/omag-server-platform) class path. The easiest way to do this is to copy the JAR files into the `lib` directory of your OMAG Server Platform's [install directory](/education/tutorials/installing-egeria-tutorial). +The connector jar file (and any jar files for the dependent third party client libraries not included in your connector's jar file) need to be added to the [OMAG Server Platform](/concepts/omag-server-platform) class path. The easiest way to do this is to copy the JAR files into the `extra` directory of your OMAG Server Platform's [assembly](/education/tutorials/building-egeria-tutorial/overview). Once you have installed the connector, configure it in the integration daemon, connected to a metadata access store. diff --git a/site/mkdocs.yml b/site/mkdocs.yml index 9f0b06c7da..966c2788fc 100644 --- a/site/mkdocs.yml +++ b/site/mkdocs.yml @@ -199,16 +199,14 @@ nav: - Learning Overview: education/index.md - Tutorials: - Tutorials: education/tutorials/index.md - - Running Egeria: - - Downloading Egeria: education/tutorials/downloading-egeria-tutorial/overview.md - - Building Egeria: education/tutorials/building-egeria-tutorial/overview.md - - Installing Egeria: education/tutorials/installing-egeria-tutorial.md + - Setting up Egeria: education/tutorials/building-egeria-tutorial/overview.md - Using Egeria: - Open Metadata Labs: education/open-metadata-labs/overview.md - Platform and Servers: education/tutorials/omag-server-tutorial/overview.md - - Reports and utilities: education/tutorials/omag-client-tutorial.md + - Reports and Utilities: education/tutorials/omag-client-tutorial.md - Sample Clients: education/tutorials/running-samples-tutorial.md - Developing with Egeria: + - Setting up IntelliJ: education/tutorials/developer-intellij-tutorial/overview.md - Testing Egeria: education/tutorials/testing-egeria-tutorial.md - Tools: - Git and GitHub: education/tutorials/git-and-git-hub-tutorial/overview.md diff --git a/site/snippets/tasks/task-building-with-maven.md b/site/snippets/tasks/task-building-with-maven.md index 738c052fe1..9121923618 100644 --- a/site/snippets/tasks/task-building-with-maven.md +++ b/site/snippets/tasks/task-building-with-maven.md @@ -14,6 +14,9 @@ When the Maven command is run, it passes through the hierarchy of modules multip !!! tip "Maven repositories" This processing includes locating and downloading external libraries and dependencies, typically from an online open source repository called Maven Central. The directory where these external dependencies is stored locally is called `.m2`. +??? tip "Installing Maven" + --8<-- "snippets/tasks/task-installing-maven.md" + !! cli "Rebuild a module with Maven" From the module's directory issue command: ```shell diff --git a/site/snippets/tasks/task-installing-egeria.md b/site/snippets/tasks/task-installing-egeria.md index 8458b9c584..29de9ccd1c 100644 --- a/site/snippets/tasks/task-installing-egeria.md +++ b/site/snippets/tasks/task-installing-egeria.md @@ -3,8 +3,6 @@ ### Installing Egeria -Change to the top level `egeria` directory where your local copy of `egeria.git` is downloaded to. - --8<-- "snippets/tasks/terminal-installing-egeria.md" diff --git a/site/snippets/tasks/task-installing-intellij.md b/site/snippets/tasks/task-installing-intellij.md new file mode 100644 index 0000000000..c9b9ca5b4c --- /dev/null +++ b/site/snippets/tasks/task-installing-intellij.md @@ -0,0 +1,18 @@ + + + +### Installing Intellij + +Link to the [download](https://www.jetbrains.com/idea/download/) page and follow the instructions. + +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" + +