Skip to content

Commit

Permalink
Merge pull request #746 from mandy-chessell/dev-dojo
Browse files Browse the repository at this point in the history
Fix formatting and overuse of abbr.md
  • Loading branch information
mandy-chessell committed Apr 27, 2023
2 parents 1f920bf + 50ed841 commit 95280e2
Show file tree
Hide file tree
Showing 134 changed files with 71 additions and 157 deletions.
3 changes: 0 additions & 3 deletions site/docs/concepts/audit-log-intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,3 @@ The structure is defined by the Audit Log Framework (ALF). The Open Metadata Re
| 14 | `PerfMon` | This log record contains performance monitoring timing information for specific types of processing. It is not normally logged to any destination, but can be added when needed. |
| 0 | `<Unknown>` | Uninitialized Severity |



--8<-- "snippets/abbr.md"
2 changes: 0 additions & 2 deletions site/docs/connectors/discovery/discovery-service-intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,5 +24,3 @@ An open discovery service is designed to run at regular intervals to gather a de

![Open Discovery Service](/connectors/discovery/discovery-service.svg)


--8<-- "snippets/abbr.md"
Original file line number Diff line number Diff line change
Expand Up @@ -74,4 +74,3 @@ The interfaces for governance action services is defined in the [governance-acti

Since the watchdog governance action service calls the provisioning governance action process explicitly via the governance action, their implementations are somewhat tied together. The alternative is that the watchdog governance action service can invoke a [governance action process](/concepts/governance-action-process) that will choreograph the execution of one or more governance services based on a flow definition managed in open metadata. The governance action process separates the implementation of the watchdog governance action service from the follow-on governance actions since changes to the follow-on processing is maintained through open metadata rather than requiring code changes to the watchdog governance action service code.

--8<-- "snippets/abbr.md"
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,3 @@

The governance daemon connectors contain specialist connectors for the governance servers that make active use of open metadata.

--8<-- "snippets/abbr.md"
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,3 @@ An integration connector runs in an [Open Metadata Integration Service (OMIS)](/
> An integration connector is shown deployed in an integration service running in an integration daemon. The connector is linking to a third party technology and also calling the open metadata APIs of Egeria to manage the exchange of metadata.

---8<-- "snippets/abbr.md"
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,3 @@ A repository governance service can:
- Issue requests to find and retrieve metadata instances from any of the repositories connected via Open Metadata Repository Cohorts.
- Incrementally build and store an open metadata archive.

--8<-- "snippets/abbr.md"
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,3 @@ The *event mapper connector* provides a mechanism to translate events that signi
Event mappers are needed in a [repository proxy](/concepts/repository-proxy) server if the third party technology that it is integrating into the [open metadata repository cohort](/concepts/cohort-member) also has its own mechanisms for maintaining metadata. If the third party metadata repository's contents are static, or only updated through Egeria's mechanisms then no event mapper is needed. If no event mapper is present, then the repository proxy ignores [refresh event requests](/features/cohort-operation/overview) from other members of the connected cohorts. This means its metadata is only available through federated queries.


--8<-- "snippets/abbr.md"
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,5 @@ In the second pattern, called the *adapter repository connector*, the repository
> Repository connector and optional event mapper connector supporting an adapter to a third party metadata repository

--8<-- "snippets/abbr.md"


Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,3 @@ The Open Metadata Topic Connector implements the [OpenMetadataTopicConnector](ht
![Open Metadata Topic Connector](/connectors/resource/open-metadata-topic-connector-in-egeria.svg)


--8<-- "snippets/abbr.md"
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,3 @@ An *[audit log destination connector](/concepts/audit-log-destination-connector)

An audit log destination's purpose may be either to store, process or distribute audit log records to diagnostic systems. Its associated configuration controls which severities of audit log record it receives. The implementation for the audit log destination connector can make further choices about how each log record is processed.



---8<-- "snippets/abbr.md"
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ Members of an [Open Metadata Repository Cohort](/concepts/cohort-member) provide

![Cohort Member Client Connector](/connectors/runtime/cohort-member-client-connector.svg)

---8<-- "snippets/abbr.md"



Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,3 @@ Inside the cohort registry store there is one local registration record describi

A *[cohort registry store connector](/concepts/cohort-registry-store-connector)* manages the persistence of the cohort registry store. Egeria uses a connector to allow different storage methods for different deployment environments. Each member may choose their own implementation of the cohort registry store connector.

---8<-- "snippets/abbr.md"
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,3 @@ The configuration store connectors contain the connector implementations that ma

There is one configuration document store connector defined for each [OMAG Server Platform](/concepts/omag-server-platform).

--8<-- "snippets/abbr.md"
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,3 @@ The *open archive store connector* manages the storage of an [Open Metadata Arch

![Open Metadata Archive Store Connector](/connectors/runtime/open-metadata-archive-store-connector.svg)

--8<-- "snippets/abbr.md"
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,3 @@ There is one platform metadata security connector defined for each OMAG Server P

![Platform Metadata Security Connector](/connectors/runtime/platform-metadata-security-connector.svg)

--8<-- "snippets/abbr.md"
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,4 @@ the REST API calls.

![REST Client Connector](/connectors/runtime/rest-client-connector.svg)

---8<-- "snippets/abbr.md"

Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,3 @@ This connector is called each time a request is made to the server. It is calle
* [Writing a server metadata security connector](/guides/developer/runtime-connectors/server-metadata-security-connector)
* [Configuring the server metadata security connector](/guides/admin/servers/configuring-the-server-security-connector) in a server.

---8<-- "snippets/abbr.md"
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,3 @@ The picture below shows a practical example of using the secrets store connector

This pattern can also be used in the [Engine Host](/concepts/engine-host) with [Open Discovery Services](/concepts/open-discovery-service) and [governance action services](/concepts/governance-action-service).

---8<-- "snippets/abbr.md"
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,6 @@ ls

It should be the same as the contents of the git repository on GitHub.

--8<-- "snippets/abbr.md"



Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@
??? beginner "Resolve Egeria dependencies in AssetListen"
---8<-- "docs/education/tutorials/intellij-tutorial/intellij-resolve-external-dependencies.md"

--8<-- "snippets/abbr.md"



Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ Open up the **asset-listen** folder. You will see under the `resources` director
![Template repository projects](asset-listen-files.png)


--8<-- "snippets/abbr.md"



Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -169,4 +169,3 @@
* **Location**: egeria.omag.server.mds1.omas.assetowner.inTopic
* **Configuration Properties**: {producer={bootstrap.servers=localhost:9092}, local.server.id=fab57cdc-e7fb-4f23-8237-376c9fda492b, consumer={bootstrap.servers=localhost:9092, auto.commit.interval.ms=1}}

--8<-- "snippets/abbr.md"
Original file line number Diff line number Diff line change
Expand Up @@ -187,4 +187,3 @@
* **Location**: egeria.omag.server.mds1.omas.assetowner.inTopic
* **Configuration Properties**: {producer={bootstrap.servers=localhost:9092}, local.server.id=e6afd331-1853-42d0-a816-bb1eeb30c7b8, consumer={bootstrap.servers=localhost:9092, auto.commit.interval.ms=1}}

--8<-- "snippets/abbr.md"
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,3 @@ People are not good at repetitive admin tasks, particularly if these tasks are n
* [Validating your integration](/guides/integration/validating-your-integration)


--8<-- "snippets/abbr.md"
Original file line number Diff line number Diff line change
Expand Up @@ -33,5 +33,3 @@ The effort required to author and maintain a these standards, plus the governanc
??? education "Coco Pharmaceuticals Scenarios"
There are descriptions of creating glossaries and other materials for subject areas in the [Coco Pharmaceuticals Scenarios](/practices/coco-pharmaceuticals/scenarios/overview).


--8<-- "snippets/abbr.md"
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,3 @@
- [Governance Action Services](/guides/developer/governance-action-services/overview)


--8<-- "snippets/abbr.md"
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,3 @@
- [Setting up your Governance Program](/guides/planning/governance-program/overview)


--8<-- "snippets/abbr.md"
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,3 @@
- [Setting up your Governance Program](/guides/planning/governance-program/overview)


--8<-- "snippets/abbr.md"
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,3 @@
- [Governance Zoning](/features/governance-zoning/overview)


--8<-- "snippets/abbr.md"
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,3 @@
- [Incident reporting](/guides/planning/incident-reporting/overview)


--8<-- "snippets/abbr.md"
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,3 @@
- [DevOps OMAS](/services/omas/dev-ops/overview)


--8<-- "snippets/abbr.md"
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,3 @@
!!! education "Further information"
- [Lineage Management](/features/lineage-management/overview)

--8<-- "snippets/abbr.md"
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,3 @@ Your organization will have other governance initiatives covering different aspe
!!! education "Further information"
- [Setting up your Governance Program](/guides/planning/governance-program/overview)

--8<-- "snippets/abbr.md"
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,3 @@
- [Reference Data Management](/features/reference-data-management/overview)


--8<-- "snippets/abbr.md"
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,3 @@
- [Metadata Security Connectors](/features/metadata-security/overview)


--8<-- "snippets/abbr.md"
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,3 @@
- [Open Lineage log store](/features/lineage-management/overview/#openlineage-log-store)


--8<-- "snippets/abbr.md"
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
| 6 - Metadata Discovery | Data Content Analysis Results |
| 7 - Lineage | Business Context, Process Metadata |
--8<-- "snippets/abbr.md"




Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,3 @@ Metadata provides a window into your organization's resources and operations. I
- [Planning for security](/guides/planning/security/overview)


--8<-- "snippets/abbr.md"
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,3 @@
!!! education "Further information"
- [Configuring the Engine Host](/guides/admin/servers/configuring-an-engine-host)

--8<-- "snippets/abbr.md"
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,3 @@
- [People, roles and organizations](/features/people-roles-organizations/overview)


--8<-- "snippets/abbr.md"
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,3 @@
- Supporting users and groups


--8<-- "snippets/abbr.md"
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,3 @@
- [People, roles and organizations](/features/people-roles-organizations/overview)


--8<-- "snippets/abbr.md"
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,3 @@ The open metadata ecosystem collects, links and disseminates metadata from many
* [Synchronizing Security Information](/features/synchronized-access-control/overview)
* [Reference Data Management](/features/reference-data-management/overview)

--8<-- "snippets/abbr.md"
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,3 @@
- [Metadata discovery and stewardship](/features/discovery-and-stewardship/overview)


--8<-- "snippets/abbr.md"
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,3 @@
- [Governance Zoning](/features/metadata-archiving/overview)


--8<-- "snippets/abbr.md"
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,6 @@



--8<-- "snippets/abbr.md"




Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,4 +78,4 @@ The build scripts that use these technologies ensure the software is built in th

--8<-- "docs/education/tutorials/building-egeria-tutorial/task-building-with-maven.md"

--8<-- "snippets/abbr.md"

Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,4 @@ BUILD SUCCESSFUL in 10s
3 actionable tasks: 1 executed, 2 up-to-date
```

--8<-- "snippets/abbr.md"

Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,4 @@ The build can take 15 minutes to over an hour depending on the repository and on
Process finished with exit code 0
```

--8<-- "snippets/abbr.md"

Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ Change to the top level `egeria` directory where your local copy of `egeria.git`

--8<-- "docs/education/tutorials/building-egeria-tutorial/terminal-installing-egeria.md"

--8<-- "snippets/abbr.md"

Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,5 @@ Java can be installed by:

Alternatively you may wish to install from your package manager such as `homebrew` on MacOS.

--8<-- "snippets/abbr.md"


Original file line number Diff line number Diff line change
Expand Up @@ -40,5 +40,5 @@ Maven can be installed by downloading the software from the Apache maven website
On Windows, you should use [Windows Subsystem for Linux :material-dock-window:](https://docs.microsoft.com/en-us/windows/wsl/){ target=ms } Version 2 or above, install an appropriate Linux distribution, and follow the instructions for that Linux distribution.


--8<-- "snippets/abbr.md"


Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ Changes to be committed:

Now you are ready to commit your contribution to your clone.

---8<-- "snippets/abbr.md"

Original file line number Diff line number Diff line change
Expand Up @@ -65,4 +65,4 @@ Now you are ready to [create a branch for your changes](/education/tutorials/git
* Further details on the [fork](https://guides.github.com/activities/forking/) command.


---8<-- "snippets/abbr.md"

Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,3 @@ Make a note of this issue number because you will need it later.

Now you are ready to work on your contribution.

---8<-- "snippets/abbr.md"
Original file line number Diff line number Diff line change
Expand Up @@ -58,4 +58,4 @@ upstream https://github.com/odpi/egeria.git (push)

Now you can make your changes to the content.

---8<-- "snippets/abbr.md"

Original file line number Diff line number Diff line change
Expand Up @@ -103,4 +103,4 @@ ls

It should be the same as the contents of the git repository on GitHub.

---8<-- "snippets/abbr.md"

Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@ Select the `Sign up` option.

Once you have created your account then sign in.

---8<-- "snippets/abbr.md"

Original file line number Diff line number Diff line change
Expand Up @@ -53,4 +53,4 @@ $ git push -d origin example-branch
You may need to use `-D` if not all changes are merged, but check carefully!


---8<-- "snippets/abbr.md"

Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,3 @@ Git can be installed:
- On Linux operating systems, by using your distribution's package manager (`yum install git`, `apt-get install git`, etc).
- On Windows, you should use [Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/) Version 2 or above, install an appropriate Linux distribution, and follow the instructions for Linux.

---8<-- "snippets/abbr.md"
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,4 @@ However, IntelliJ does not understand the egeria structure - only Maven
does, so the Maven build is important to to verify your changes are
OK at the project level.

---8<-- "snippets/abbr.md"

Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@ Any changes, additions and deletions that you make to the files under the git re
![Git->Add option](intellij-git-add-option.png)


---8<-- "snippets/abbr.md"

Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ If your development work is using the main Egeria libraries rather than developi
--8<-- "docs/education/tutorials/intellij-tutorial/intellij-open-terminal.md"
--8<-- "docs/education/tutorials/building-egeria-tutorial/terminal-installing-egeria.md"

--8<-- "snippets/abbr.md"

Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,4 @@ Start up IntelliJ.
??? tip "Check your lombok setup"
---8<-- "docs/education/tutorials/intellij-tutorial/intellij-lombok-plugin.md"

---8<-- "snippets/abbr.md"

Loading

0 comments on commit 95280e2

Please sign in to comment.