Skip to content

Commit

Permalink
Merge pull request #644 from planetf1/docupd
Browse files Browse the repository at this point in the history
Miscellaneous doc updates
  • Loading branch information
planetf1 authored Dec 21, 2022
2 parents aac6a43 + 60adbe5 commit 052c405
Show file tree
Hide file tree
Showing 9 changed files with 44 additions and 20 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ The connection definition to use on the [administration commands that configure
"embeddedConnections" : [
{
"class": "EmbeddedConnection",
"embeddedConnection :
"embeddedConnection" :
{
"class": "Connection",
"qualifiedName": "Kafka Open Metadata Topic Connector",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ If you experience problems, check memory consumption on your nodes. A minimum of
a 3 node cluster, 2GB per node; or a desktop environment with 6GB dedicated is recommended.

Please provide any feeback via a github issue at https://github.com/odpi/egeria or
join us on slack via https://http://slack.lfai.foundation
join us on slack via https://http://slack.lfaidata.foundation

- The ODPi Egeria team
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ metadata server 'mds1' and a view server 'view1'. The UI organization name is 'o
A job is started to perform this configuration and may take up to 10 minutes to complete.

Please provide any feeback via a github issue at https://github.com/odpi/egeria or
join us on slack via https://http://slack.lfai.foundation
join us on slack via https://http://slack.lfaidata.foundation

- The ODPi Egeria team
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ metadata server 'mds1' and a view server 'view1'. The UI organization name is 'o
A job is started to perform this configuration and may take up to 10 minutes to complete.

Please provide any feeback via a github issue at https://github.com/odpi/egeria or
join us on slack via https://http://slack.lfai.foundation
join us on slack via https://http://slack.lfaidata.foundation

- The ODPi Egeria team
```
Expand Down
2 changes: 1 addition & 1 deletion site/docs/education/open-metadata-labs/running-natively.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,6 @@ You need to start four OMAG Server Platforms at the following URLs - remembering

## Help

For additional help refer to our slack channels at http://slack.lfai.foundation
For additional help refer to our slack channels at http://slack.lfaidata.foundation

--8<-- "snippets/abbr.md"
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,42 @@ the activity in the project and process new content.

Egeria has the following repositories:

| Repository | Purpose |
|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [`egeria` :material-github:](https://github.com/odpi/egeria){ target=gh } | contains the core Egeria function along with samples, tutorials and documentation. |
| [`egeria-connector-xtdb` :material-github:](https://github.com/odpi/egeria-connector-xtdb){ target=gh } | contains a native repository connector to use [XTDB :material-dock-window:](https://xtdb.com){ target=xtdb } as a pluggable back-end for an Egeria [metadata access store](/concepts/metadata-access-store). |
| [`egeria-connector-hadoop-ecosystem` :material-github:](https://github.com/odpi/egeria-connector-hadoop-ecosystem){ target=gh } | contains connectors to integrate technologies from the Hadoop ecosystem into the open metadata ecosystem. |
| [`egeria-connector-ibm-information-server` :material-github:](https://github.com/odpi/egeria-connector-ibm-information-server){ target=gh } | contains connectors to integrate IBM Information Server into the open metadata ecosystem. |
| [`data-governance` :material-github:](https://github.com/odpi/data-governance){ target=gh } | contains Egeria's Guidance on Governance (GoG) as well as large media files such as presentations and movies. |
| [`egeria-dev-projects` :material-github:](https://github.com/odpi/egeria-dev-projects){ target=gh } | contains fun projects for developers to help them learn about the Egeria technology. |
| [`egeria-palisade` :material-github:](https://github.com/odpi/egeria-palisade){ target=gh } | contains content from the collaboration between the Egeria project and the [Palisade :material-dock-window:](https://github.com/gchq/palisade){ target=palisade } project. |
| Repository | Purpose |
| --- | --- |
| [`data-governance` :material-github:](https://github.com/odpi/data-governance){ target=gh } | Egeria's Guidance on Governance as well as large media files such as presentations and movies |
| [`egeria-api-mocks` :material-github:](https://github.com/odpi/egeria-api-mocks){ target=gh } | |
| [`egeria-charts` :material-github:](https://github.com/odpi/egeria-charts){ target=gh } | Helm chart repository |
| [`egeria-connector-hadoop-ecosystem` :material-github:](https://github.com/odpi/egeria-connector-hadoop-ecosystem){ target=gh } | Hadoop ecosystem connectors for Egeria: repository proxy connector for Apache Atlas. |
| [`egeria-connector-hivemetastore` :material-github:](https://github.com/odpi/egeria-connector-hivemetastore){ target=gh } | Egeria repository connector for Hive metastore. Initially targeted at spark metadata |
| [`egeria-connector-ibm-information-server` :material-github:](https://github.com/odpi/egeria-connector-ibm-information-server){ target=gh } | IBM Information Server connectors for Egeria: repository proxy connector for IGC, data engine proxy connector for DataStage. |
| [`egeria-connector-integration-event-schema` :material-github:](https://github.com/odpi/egeria-connector-integration-event-schema){ target=gh } | Provides an integration connector that extract event schemata from a schema registry (including Confluent schema registry). The connector will be a polling connector and will look in Egeria for new topics that if present in the confluent registry, the associate schema elements will be brought into Egeria. |
| [`egeria-connector-integration-lineage-event-driven-sample` :material-github:](https://github.com/odpi/egeria-connector-integration-lineage-event-driven-sample){ target=gh } | Sample showing how to bring lineage into Egeria |
| [`egeria-connector-integration-topic-strimzi` :material-github:](https://github.com/odpi/egeria-connector-integration-topic-strimzi){ target=gh } | Strimzi Egeria integration connector for Kafka Topics |
| [`egeria-connector-jdbc` :material-github:](https://github.com/odpi/egeria-connector-jdbc){ target=gh } | JDBC connectors for Egeria (Integration and Resource) |
| [`egeria-connector-omrs-caching` :material-github:](https://github.com/odpi/egeria-connector-omrs-caching){ target=gh } | Provides an OMRS repository proxy connector that has an embedded repository that can be used to cache entities and relationships. |
| [`egeria-connector-repository-file-sample` :material-github:](https://github.com/odpi/egeria-connector-repository-file-sample){ target=gh } | Provides a repository proxy sample that uses polling. The target is a file folder |
| [`egeria-connector-sas-viya` :material-github:](https://github.com/odpi/egeria-connector-sas-viya){ target=gh } | |
| [`egeria-connector-xtdb` :material-github:](https://github.com/odpi/egeria-connector-xtdb){ target=gh } | Pluggable repository for Egeria, using XTDB (formerly "Crux") as the back-end to natively support historical metadata. |
| [`egeria-database-connectors` :material-github:](https://github.com/odpi/egeria-database-connectors){ target=gh } | Connectors for exchanging metadata |
| [`egeria-dev-projects` :material-github:](https://github.com/odpi/egeria-dev-projects){ target=gh } | Fun projects for developers to help them learn about the Egeria technology |
| [`egeria-docs` :material-github:](https://github.com/odpi/egeria-docs){ target=gh } | Documentation repository for the Egeria project. |
| [`egeria-dojo-developer` :material-github:](https://github.com/odpi/egeria-dojo-developer){ target=gh } | Provides the starting project structure for the developer dojo. The particupant creates a clone of it and works from there - they do not merge their code back into the repository. There is also a branch which includes the sample answers that they cna refer to if they get stuck. |
| [`egeria-js-commons` :material-github:](https://github.com/odpi/egeria-js-commons){ target=gh } | Common module for storing static data such as key value objects, SVGs, icon mappings, API urls. |
| [`egeria-jupyter-notebooks` :material-github:](https://github.com/odpi/egeria-jupyter-notebooks){ target=gh } | Egeria Jupiter notebooks used in the Open Metadata Labs |
| [`egeria-k8s-operator` :material-github:](https://github.com/odpi/egeria-k8s-operator){ target=gh } | Egeria Kubernetes operator |
| [`egeria-python` :material-github:](https://github.com/odpi/egeria-python){ target=gh } | Python library for Egeria |
| [`egeria-react-ui` :material-github:](https://github.com/odpi/egeria-react-ui){ target=gh } | A multi-tenant, role based Egeria React UI for Open Metadata, that has eco-system and solutions capabilities. |
| [`egeria-samples-api` :material-github:](https://github.com/odpi/egeria-samples-api){ target=gh } | A collection of samples illustrating the different APIs of Egeria. |
| [`egeria-samples` :material-github:](https://github.com/odpi/egeria-samples){ target=gh } | |
| [`egeria-template-newrepo` :material-github:](https://github.com/odpi/egeria-template-newrepo){ target=gh } | Template for new Egeria repository |
| [`egeria-ui-components` :material-github:](https://github.com/odpi/egeria-ui-components){ target=gh } | Encapsulated reactjs components with business logic inside. |
| [`egeria-ui-core` :material-github:](https://github.com/odpi/egeria-ui-core){ target=gh } | Core library that includes generic reactjs components used across the user interface. |
| [`egeria-ui` :material-github:](https://github.com/odpi/egeria-ui){ target=gh } | User interface instance using main Egeria functionalities. |
| [`egeria` :material-github:](https://github.com/odpi/egeria){ target=gh } | Egeria core |
| [`happi-graph` :material-github:](https://github.com/odpi/happi-graph){ target=gh } | Generic graph rendering solution. |

All of these repositories are publicly visible. However, if you want to contribute new content then you need
to create a GitHub account. This can be done from [the top of the GitHub home page :material-dock-window:](https://github.com){ target=gh }.


---8<-- "snippets/abbr.md"
---8<-- "snippets/abbr.md"
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ to be set:

In addition an additional parameter is provided which causes ssl verification to be skipped:

* `strict.ssl` true / false : If set to true skips checks on certificate
* `strict.ssl` true / false : If set to false skips checks on certificate (default = true)

For further details on these and other less common configuration options, refer to the Spring Docs

Expand All @@ -89,15 +89,15 @@ In addition, for any executable jars provided by Egeria - such as samples, an ad
parameter will cause ssl verification to be skipped. This is only recommended for test
and development

* `strict.ssl` true / false : If set to true skips checks on certificate
* `strict.ssl` true / false : If set to false skips checks on certificate (default = true)

Note that in the case of Java Clients, these are system properties, and do
not use spring conventions.

## Other clients

Similar principles to those documented for java should apply. If you need further assistance please
contact the team on our slack channel at http://slack.lfai.foundation . A Pull Request (or issue) with contributed documentation
contact the team on our slack channel at http://slack.lfaidata.foundation . A Pull Request (or issue) with contributed documentation
is very welcome !

## Example script to launch Egeria
Expand Down
2 changes: 1 addition & 1 deletion site/docs/guides/project-operations.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ All participants in the Egeria community are bound by the project's [Code of Con

As a member you are able to attend our meetings, just to listen, or to play an active part in the discussion. The online meetings are recorded to allow community members to catch up if they are not able to attend the live meeting. When you attend the community meetings specifically, your name will be recorded in the meeting minutes along with any remarks or suggestions you make. The agenda and minutes of our community meetings are publicly available on the [Egeria wiki :material-dock-window:](https://github.com/odpi/egeria/wiki){ target=gh }.

A member may make contributions to the Egeria content by submitting a GitHub pull request on the appropriate Git repository. This will be reviewed and processed by the [Egeria maintainers](#maintainers). The process for making a contribution is described in the [Egeria Dojo](/getting-started/dojo/introduction) education. Each contribution is signed by the contributor to confirm they agree to our [Developer Certificate of Origin (DCO)](/guides/developer/guidelines/#sign-commits-to-accept-dco).
A member may make contributions to the Egeria content by submitting a GitHub pull request on the appropriate Git repository. This will be reviewed and processed by the [Egeria maintainers](#maintainers). The process for making a contribution is described in the [Egeria Dojo](/getting-started/dojo/introduction) education. Each contribution is signed-off by the contributor to confirm they agree to our [Developer Certificate of Origin (DCO)](/guides/contributor/guidelines/#sign-commits-to-accept-dco).

Community members can progress to be Egeria [contributors](#contributors) and then Egeria [maintainers](#maintainers).

Expand Down
2 changes: 1 addition & 1 deletion site/docs/release-notes/2-3.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
platforms, servers, services and cohort memberships.
* Type Explorer & Repository Explorer, previously found in the Polymer based UI, are now available
in Presentation Server.
* Raise a github issue or Contact the Egeria team via slack at slack.odpi.com if you experience issues or have questions.
* Raise a github issue or Contact the Egeria team via slack at https://slack.lfaidata.foundation if you experience issues or have questions.
* The Egeria Docker image is now based on Redhat's UBI-8 openjdk-11 image, to improve security & operational support. See issue #3580
* Bug Fixes & ongoing feature work

Expand Down

0 comments on commit 052c405

Please sign in to comment.