Merge pull request #941 from mandy-chessell/code2024

Move release note snippets
odpi · Jun 13, 2024 · 49f82e5 · 49f82e5
2 parents 3e75a21 + 51cb930
commit 49f82e5
Show file tree

Hide file tree

Showing 57 changed files with 103 additions and 105 deletions.
diff --git a/site/docs/concepts/engine-host.md b/site/docs/concepts/engine-host.md
@@ -18,7 +18,7 @@ Typically, an engine host is deployed close to where the artifacts/resources/dat
 
 The metadata interfaces needed by the governance engines are provided by the [Open Metadata Engine Services (OMES)](/services/omes) (or engine services for short). The engine services also run in the engine host.
 
---8<-- "docs/concepts/governance-service-types.md"
+--8<-- "snippets/concepts/governance-service-types.md"
 
 The name and URL root of the server where the partner metadata service is running is needed to configure an engine service.  This is the metadata service used to access open metadata when a governance service runs.  The open metadata server configured for the engine host is used to retrieve the [governance engine definitions](/concepts/governance-engine-definition) for the governance engines configured for each engine service.    The metadata access servers used by the engine services does not need to be the same metadata server as the one used by the engine host server. This enables the management of metadata about the assets to be maintained close to the assets, and the definitions of the governance engines, services and processes to be maintained close to the governance team:
 

diff --git a/site/docs/concepts/governance-action-process.md b/site/docs/concepts/governance-action-process.md
@@ -3,6 +3,6 @@
 
 # Governance Action Process
 
---8<-- "docs/concepts/governance-action-process-intro.md"
+--8<-- "snippets/concepts/governance-action-process-intro.md"
 
 --8<-- "snippets/abbr.md"
diff --git a/site/docs/concepts/governance-action-service.md b/site/docs/concepts/governance-action-service.md
@@ -3,7 +3,7 @@
 
 # Governance Action Service
 
---8<-- "snippets/governance-action/governance-action-service-intro.md"
+--8<-- "snippets/connectors/governance-action-service-intro.md"
 
 
 

diff --git a/site/docs/concepts/governance-engine.md b/site/docs/concepts/governance-engine.md
@@ -10,7 +10,7 @@ hide:
 
 A *governance engine* provides services that automate governance activities - from validating that the digital landscape is operating correctly, ensuring metadata is complete and correct to performing scheduled maintenance.  Its capability is implemented by a collection of related [governance services](/concepts/governance-service).
 
---8<-- "docs/concepts/governance-service-types.md"
+--8<-- "snippets/concepts/governance-service-types.md"
 
 When a governance engine is called, it is passed a [governance request type](/concepts/governance-request-type) and request parameters.  This is mapped to a call to a governance service through the [governance engine definition](/concepts/governance-engine-definition).
 

diff --git a/site/docs/concepts/governance-service.md b/site/docs/concepts/governance-service.md
@@ -5,7 +5,7 @@
 
 A governance service is a specialized [connector](/concepts/connector) that implements a specific [type of engine action](/concepts/engine-action).
 
---8<-- "docs/concepts/governance-service-types.md"
+--8<-- "snippets/concepts/governance-service-types.md"
 
 ## Implementing your own governance services
 

diff --git a/site/docs/connectors/index.md b/site/docs/connectors/index.md
diff --git a/...education/egeria-dojo/metadata-governance/using-automated-governance-actions.md b/...education/egeria-dojo/metadata-governance/using-automated-governance-actions.md
@@ -9,7 +9,7 @@ The open metadata ecosystem collects, links and disseminates metadata from many
     --8<-- "docs/patterns/metadata-governance/governance-engines.md"
 
 ??? intermediate "Designing your governance processes (30 mins)"
-    --8<-- "docs/concepts/governance-action-process-intro.md"
+    --8<-- "snippets/concepts/governance-action-process-intro.md"
 
 ??? beginner "Setting up an engine host, governance engines and services (30 mins)"
     --8<-- "docs/patterns/metadata-governance/setting-up-the-engine-host.md"

diff --git a/site/docs/release-notes/latest.md b/site/docs/release-notes/latest.md
@@ -1 +1 @@
---8<-- "docs/release-notes/4-3.md"
+--8<-- "snippets/release-notes/4-3.md"
diff --git a/site/docs/release-notes/next.md b/site/docs/release-notes/next.md
@@ -1 +1 @@
---8<-- "docs/release-notes/5-0.md"
+--8<-- "snippets/release-notes/5-0.md"
diff --git a/site/docs/release-notes/overview.md b/site/docs/release-notes/overview.md
@@ -22,12 +22,10 @@ The project aims to produce a new release of Core Egeria about once every 6 week
 
 The table below shows the planned dates for future releases.  The branch date is the date that a copy of the main branch is taken.  This copy is the candidate code for the release.  We then run tests on this copy and release to maven central once any issues have been resolved.  Any fixes that are necessary are made to the main branch and then back-ported to the release branch.  It typically takes a week to go from making the release branch to the new release going to maven central.
 
-| Release | Branch date        | Release Date        | Core theme           |
-|---------|--------------------|---------------------|----------------------|
-| 4.2     | 17th July 2023     | 20th July 2023      | Runtime optimization |
-| 4.3     | 4th September 2023 | 13th September 2023 | New assemblies       |
-| 5.0     | 10th June 2024     |                     | Survey Framework     |
-| 5.1     | 2nd September 2024 |                     |                      |
+| Release | Branch date        | Release Date        | Core theme       |
+|---------|--------------------|---------------------|------------------|
+| 5.0     | 10th June 2024     |                     | Survey Framework |
+| 5.1     | 2nd September 2024 |                     | View Services    |
 
 
 !!! attention "Backwards compatibility"

diff --git a/site/docs/release-notes/previous.md b/site/docs/release-notes/previous.md
@@ -5,130 +5,130 @@
 # Earlier releases
 
 ???+ info "Release 4.2 (July 2023)"
-    --8<-- "docs/release-notes/4-2.md"
+    --8<-- "snippets/release-notes/4-2.md"
 
 ???+ info "Release 4.1 (May 2023)"
-    --8<-- "docs/release-notes/4-1.md"
+    --8<-- "snippets/release-notes/4-1.md"
 
 ???+ info "Release 4.0 (March 2023)"
-    --8<-- "docs/release-notes/4-0.md"
+    --8<-- "snippets/release-notes/4-0.md"
 
 ??? info "v3.x Releases"
 
     ???+ info "Release 3.15 (January 2023)"
-        --8<-- "docs/release-notes/3-15.md"
+        --8<-- "snippets/release-notes/3-15.md"
 
     ???+ info "Release 3.14 (December 2022)"
-        --8<-- "docs/release-notes/3-14.md"
+        --8<-- "snippets/release-notes/3-14.md"
 
     ???+ info "Release 3.13 (November 2022)"
-        --8<-- "docs/release-notes/3-13.md"
+        --8<-- "snippets/release-notes/3-13.md"
 
     ??? info "Release 3.12 (October 2022)"
-        --8<-- "docs/release-notes/3-12.md"
+        --8<-- "snippets/release-notes/3-12.md"
 
     ??? info "Release 3.11 (September 2022)"
-        --8<-- "docs/release-notes/3-11.md"
+        --8<-- "snippets/release-notes/3-11.md"
 
     ??? info "Release 3.10 (July 2022)"
-        --8<-- "docs/release-notes/3-10.md"
+        --8<-- "snippets/release-notes/3-10.md"
 
     ??? info "Release 3.9 (June 2022)"
-        --8<-- "docs/release-notes/3-9.md"
+        --8<-- "snippets/release-notes/3-9.md"
 
     ??? info "Release 3.8 (May 2022)"
-        --8<-- "docs/release-notes/3-8.md"
+        --8<-- "snippets/release-notes/3-8.md"
 
     ??? info "Release 3.7 (April 2022)"
-        --8<-- "docs/release-notes/3-7.md"
+        --8<-- "snippets/release-notes/3-7.md"
 
     ??? info "Release 3.6 (March 2022)"
-        --8<-- "docs/release-notes/3-6.md"
+        --8<-- "snippets/release-notes/3-6.md"
 
     ??? info "Release Release 3.5 (February 2022)"
-        --8<-- "docs/release-notes/3-5.md"
+        --8<-- "snippets/release-notes/3-5.md"
 
     ??? info "Release 3.4 (December 2021)"
-        --8<-- "docs/release-notes/3-4.md"
+        --8<-- "snippets/release-notes/3-4.md"
 
     ??? info "Release 3.3 (November 2021)"
-        --8<-- "docs/release-notes/3-3.md"
+        --8<-- "snippets/release-notes/3-3.md"
 
     ??? info "Release 3.2 (October 2021)"
-        --8<-- "docs/release-notes/3-2.md"
+        --8<-- "snippets/release-notes/3-2.md"
 
     ??? info "Release 3.1 (September 2021)"
-        --8<-- "docs/release-notes/3-1.md"
+        --8<-- "snippets/release-notes/3-1.md"
 
     ??? info "Release 3.0 (August 2021)"
-        --8<-- "docs/release-notes/3-0.md"
+        --8<-- "snippets/release-notes/3-0.md"
 
 ??? info "v2.x Releases"
 
     ??? info "Release 2.11 (July 2021)"
-        --8<-- "docs/release-notes/2-11.md"
+        --8<-- "snippets/release-notes/2-11.md"
 
     ??? info "Release 2.10 (June 2021)"
-        --8<-- "docs/release-notes/2-10.md"
+        --8<-- "snippets/release-notes/2-10.md"
 
     ??? info "Release 2.9 (May 2021)"
-        --8<-- "docs/release-notes/2-9.md"
+        --8<-- "snippets/release-notes/2-9.md"
 
     ??? info "Release 2.8 (April 2021)"
-        --8<-- "docs/release-notes/2-8.md"
+        --8<-- "snippets/release-notes/2-8.md"
 
     ??? info "Release 2.7 (March 2021)"
-        --8<-- "docs/release-notes/2-7.md"
+        --8<-- "snippets/release-notes/2-7.md"
 
     ??? info "Release 2.6 (February 2021)"
-        --8<-- "docs/release-notes/2-6.md"
+        --8<-- "snippets/release-notes/2-6.md"
 
     ??? info "Release 2.5 (December 2020)"
-        --8<-- "docs/release-notes/2-5.md"
+        --8<-- "snippets/release-notes/2-5.md"
 
     ??? info "Release 2.4 (November 2020)"
-        --8<-- "docs/release-notes/2-4.md"
+        --8<-- "snippets/release-notes/2-4.md"
 
     ??? info "Release 2.3 (October 2020)"
-        --8<-- "docs/release-notes/2-3.md"
+        --8<-- "snippets/release-notes/2-3.md"
 
     ??? info "Release 2.2 (September 2020)"
-        --8<-- "docs/release-notes/2-2.md"
+        --8<-- "snippets/release-notes/2-2.md"
 
     ??? info "Release 2.1 (August 2020)"
-        --8<-- "docs/release-notes/2-1.md"
+        --8<-- "snippets/release-notes/2-1.md"
 
     ??? info "Release 2.0 (July 2020)"
-        --8<-- "docs/release-notes/2-0.md"
+        --8<-- "snippets/release-notes/2-0.md"
 
 ??? info "v1.x Releases"
 
     ??? info "Release 1.8 (June 2020)"
-        --8<-- "docs/release-notes/1-8.md"
+        --8<-- "snippets/release-notes/1-8.md"
 
     ??? info "Release 1.7 (May 2020)"
-        --8<-- "docs/release-notes/1-7.md"
+        --8<-- "snippets/release-notes/1-7.md"
 
     ??? info "Release 1.6 (April 2020)"
-        --8<-- "docs/release-notes/1-6.md"
+        --8<-- "snippets/release-notes/1-6.md"
 
     ??? info "Release 1.5 (March 2020)"
-        --8<-- "docs/release-notes/1-5.md"
+        --8<-- "snippets/release-notes/1-5.md"
 
     ??? info "Release 1.4 (February 2020)"
-        --8<-- "docs/release-notes/1-4.md"
+        --8<-- "snippets/release-notes/1-4.md"
 
     ??? info "Release 1.3 (January 2020)"
-        --8<-- "docs/release-notes/1-3.md"
+        --8<-- "snippets/release-notes/1-3.md"
 
     ??? info "Release 1.2 (December 2019)"
-        --8<-- "docs/release-notes/1-2.md"
+        --8<-- "snippets/release-notes/1-2.md"
 
     ??? info "Release 1.1 (November 2019)"
-        --8<-- "docs/release-notes/1-1.md"
+        --8<-- "snippets/release-notes/1-1.md"
 
     ??? info "Release 1.0 (February 2019)"
-        --8<-- "docs/release-notes/1-0.md"
+        --8<-- "snippets/release-notes/1-0.md"
 
 ### Additional Help and Support
 

diff --git a/site/docs/release-notes/roadmap.md b/site/docs/release-notes/roadmap.md
@@ -130,7 +130,7 @@ Aim to simplify the process of deploying the OMAG Server Platform and its connec
 - The [Kubernetes Helm charts :material-dock-window:](https://github.com/odpi/egeria-charts){ target=gh } make use of the docker image to create a rich Egeria deployment used in the [open metadata labs](/education/open-metadata-labs/overview).
 - The [Kubernetes operators :material-dock-window:](https://github.com/odpi/egeria-k8s-operator){ target=gh } are in development. They will provide an easy way to control an Egeria deployment running on Kubernetes.
 
-Support for docker compose was removed in [release 3.5](3-5.md).
+Support for docker compose was removed in [release 3.5](../../snippets/release-notes/3-5.md).
 
 ## Understanding the roadmap
 

diff --git a/...ncepts/governance-action-process-intro.md → ...ncepts/governance-action-process-intro.md b/...ncepts/governance-action-process-intro.md → ...ncepts/governance-action-process-intro.md
diff --git a/...docs/concepts/governance-service-types.md → ...pets/concepts/governance-service-types.md b/...docs/concepts/governance-service-types.md → ...pets/concepts/governance-service-types.md
diff --git a/site/docs/release-notes/1-0.md → site/snippets/release-notes/1-0.md b/site/docs/release-notes/1-0.md → site/snippets/release-notes/1-0.md
@@ -15,7 +15,7 @@ Release 1.0 provides the open metadata integration and exchange between metadata
 
 ??? info "Egeria Implementation Status at Release 1.0"
 
-    ![Egeria Implementation Status](functional-organization-showing-implementation-status-for-1.0.png)
+    ![Egeria Implementation Status](/release-notes/functional-organization-showing-implementation-status-for-1.0.png)
 
      Link to Egeria's [Roadmap](/release-notes/roadmap) for more details about the Open Metadata and Governance vision, strategy and content.
 

diff --git a/site/docs/release-notes/1-1.md → site/snippets/release-notes/1-1.md b/site/docs/release-notes/1-1.md → site/snippets/release-notes/1-1.md
@@ -46,7 +46,7 @@ Below are the highlights:
 
 ??? info "Egeria Implementation Status at Release 1.1"
 
-    ![Egeria Implementation Status](functional-organization-showing-implementation-status-for-1.1.png)
+    ![Egeria Implementation Status](/release-notes/functional-organization-showing-implementation-status-for-1.1.png)
 
     Link to Egeria's [Roadmap](/release-notes/roadmap/) for more details about the Open Metadata and Governance vision, strategy and content.
 

diff --git a/site/docs/release-notes/1-2.md → site/snippets/release-notes/1-2.md b/site/docs/release-notes/1-2.md → site/snippets/release-notes/1-2.md
@@ -45,7 +45,7 @@ Below are the highlights:
 
 ### Egeria Implementation Status at Release 1.2
 
-![Egeria Implementation Status](functional-organization-showing-implementation-status-for-1.2.png)
+![Egeria Implementation Status](/release-notes/functional-organization-showing-implementation-status-for-1.2.png)
 
  Link to Egeria's [Roadmap](/release-notes/roadmap) for more details about the
  Open Metadata and Governance vision, strategy and content.

diff --git a/site/docs/release-notes/1-3.md → site/snippets/release-notes/1-3.md b/site/docs/release-notes/1-3.md → site/snippets/release-notes/1-3.md
@@ -53,7 +53,7 @@ Below are the highlights of the 1.3 release:
 
 ### Egeria Implementation Status at Release 1.3
 
-![Egeria Implementation Status](functional-organization-showing-implementation-status-for-1.3.png)
+![Egeria Implementation Status](/release-notes/functional-organization-showing-implementation-status-for-1.3.png)
 
  Link to Egeria's [Roadmap](/release-notes/roadmap/) for more details about the
  Open Metadata and Governance vision, strategy and content.

diff --git a/site/docs/release-notes/1-4.md → site/snippets/release-notes/1-4.md b/site/docs/release-notes/1-4.md → site/snippets/release-notes/1-4.md
@@ -7,7 +7,7 @@ Release 1.4 focused on bug fixes and documentation.
 
 ### Egeria Implementation Status at Release 1.4
 
-![Egeria Implementation Status](functional-organization-showing-implementation-status-for-1.4.png)
+![Egeria Implementation Status](/release-notes/functional-organization-showing-implementation-status-for-1.4.png)
 
  Link to Egeria's [Roadmap](/release-notes/roadmap/) for more details about the
  Open Metadata and Governance vision, strategy and content.

diff --git a/site/docs/release-notes/1-5.md → site/snippets/release-notes/1-5.md b/site/docs/release-notes/1-5.md → site/snippets/release-notes/1-5.md
@@ -34,7 +34,7 @@ Additional, in Tech Preview, Data Engine OMAS, and a data engine proxy server.
 
 ### Egeria Implementation Status at Release 1.5
 
-![Egeria Implementation Status](functional-organization-showing-implementation-status-for-1.5.png)
+![Egeria Implementation Status](/release-notes/functional-organization-showing-implementation-status-for-1.5.png)
 
  Link to Egeria's [Roadmap](../roadmap) for more details about the
  Open Metadata and Governance vision, strategy and content.

diff --git a/site/docs/release-notes/1-6.md → site/snippets/release-notes/1-6.md b/site/docs/release-notes/1-6.md → site/snippets/release-notes/1-6.md
@@ -26,7 +26,7 @@ Below are the highlights:
 
 ### Egeria Implementation Status at Release 1.6
 
-![Egeria Implementation Status](functional-organization-showing-implementation-status-for-1.6.png)
+![Egeria Implementation Status](/release-notes/functional-organization-showing-implementation-status-for-1.6.png)
 
  Link to Egeria's [Roadmap](/release-notes/roadmap/) for more details about the Open Metadata and Governance vision, strategy and content.
 

diff --git a/site/docs/release-notes/1-7.md → site/snippets/release-notes/1-7.md b/site/docs/release-notes/1-7.md → site/snippets/release-notes/1-7.md
@@ -25,7 +25,7 @@ Below are the highlights:
 
 ### Egeria Implementation Status at Release 1.7
 
-![Egeria Implementation Status](functional-organization-showing-implementation-status-for-1.7.png)
+![Egeria Implementation Status](/release-notes/functional-organization-showing-implementation-status-for-1.7.png)
 
  Link to Egeria's [Roadmap](/release-notes/roadmap/) for more details about the
  Open Metadata and Governance vision, strategy and content.

diff --git a/site/docs/release-notes/1-8.md → site/snippets/release-notes/1-8.md b/site/docs/release-notes/1-8.md → site/snippets/release-notes/1-8.md
@@ -20,7 +20,7 @@ Below are the highlights of Release 1.8:
 
 ### Egeria Implementation Status at Release 1.8
 
-![Egeria Implementation Status](functional-organization-showing-implementation-status-for-1.8.png)
+![Egeria Implementation Status](/release-notes/functional-organization-showing-implementation-status-for-1.8.png)
 
  Link to Egeria's [Roadmap](/release-notes/roadmap/) for more details about the
  Open Metadata and Governance vision, strategy and content.

diff --git a/site/docs/release-notes/2-0.md → site/snippets/release-notes/2-0.md b/site/docs/release-notes/2-0.md → site/snippets/release-notes/2-0.md
@@ -17,7 +17,7 @@ Below are the highlights:
 
 ### Egeria Implementation Status at Release 2.0
 
- ![Egeria Implementation Status](functional-organization-showing-implementation-status-for-2.0.png)
+ ![Egeria Implementation Status](/release-notes/functional-organization-showing-implementation-status-for-2.0.png)
 
  Link to Egeria's [Roadmap](/release-notes/roadmap/) for more details about the
  Open Metadata and Governance vision, strategy and content.

diff --git a/site/docs/release-notes/2-1.md → site/snippets/release-notes/2-1.md b/site/docs/release-notes/2-1.md → site/snippets/release-notes/2-1.md
@@ -18,7 +18,7 @@ The highlights include:
 
 ### Egeria Implementation Status at Release 2.1
 
- ![Egeria Implementation Status](functional-organization-showing-implementation-status-for-2.1.png)
+ ![Egeria Implementation Status](/release-notes/functional-organization-showing-implementation-status-for-2.1.png)
 
  Link to Egeria's [Roadmap](/release-notes/roadmap/) for more details about the
  Open Metadata and Governance vision, strategy and content.

diff --git a/site/docs/release-notes/2-10.md → site/snippets/release-notes/2-10.md b/site/docs/release-notes/2-10.md → site/snippets/release-notes/2-10.md
@@ -155,7 +155,7 @@ point Java 8 will no longer be supported for new releases.
 
 ### Egeria Implementation Status at Release 2.10
 
-![Egeria Implementation Status](functional-organization-showing-implementation-status-for-2.10.png)
+![Egeria Implementation Status](/release-notes/functional-organization-showing-implementation-status-for-2.10.png)
 
 Link to Egeria's [Roadmap](/release-notes/roadmap/) for more details about the
 Open Metadata and Governance vision, strategy and content.

diff --git a/site/docs/release-notes/2-11.md → site/snippets/release-notes/2-11.md b/site/docs/release-notes/2-11.md → site/snippets/release-notes/2-11.md
@@ -157,6 +157,6 @@
     For details, see the [commit history in GitHub :material-dock-window:](https://github.com/odpi/egeria/commits/egeria-release-2.11){ target=gh }.
 
 ??? status "Implementation status"
-    ![Egeria implementation status](functional-organization-showing-implementation-status-for-2-11.svg)](/release-notes/roadmap/)
+    ![Egeria implementation status](/release-notes/functional-organization-showing-implementation-status-for-2-11.svg)](/release-notes/roadmap/)
 
 --8<-- "snippets/abbr.md"
diff --git a/site/docs/release-notes/2-2.md → site/snippets/release-notes/2-2.md b/site/docs/release-notes/2-2.md → site/snippets/release-notes/2-2.md
@@ -20,7 +20,7 @@ Below are the highlights of this release:
 
 ### Egeria Implementation Status at Release 2.2
 
- ![Egeria Implementation Status](functional-organization-showing-implementation-status-for-2.2.png)
+ ![Egeria Implementation Status](/release-notes/functional-organization-showing-implementation-status-for-2.2.png)
 
  Link to Egeria's [Roadmap](/release-notes/roadmap/) for more details about the
  Open Metadata and Governance vision, strategy and content.

diff --git a/site/docs/release-notes/2-3.md → site/snippets/release-notes/2-3.md b/site/docs/release-notes/2-3.md → site/snippets/release-notes/2-3.md
@@ -33,7 +33,7 @@
 
 ### Egeria Implementation Status at Release 2.3
 
-![Egeria Implementation Status](functional-organization-showing-implementation-status-for-2.3.png)
+![Egeria Implementation Status](/release-notes/functional-organization-showing-implementation-status-for-2.3.png)
 
  Link to Egeria's [Roadmap](/release-notes/roadmap/) for more details about the
  Open Metadata and Governance vision, strategy and content.