From 0c7e4f716ec931d4d5d8cfd795e4c6f2627b87ef Mon Sep 17 00:00:00 2001 From: Pere Miquel Brull Date: Tue, 2 Aug 2022 12:58:46 +0200 Subject: [PATCH] Docs - Add schemas navigation info (#6494) Docs - Add schemas navigation info (#6494) --- .../content/deployment/upgrade/kubernetes.md | 9 +++++++++ .../metadata-standard/schemas.md | 20 ++++++++++++++++++- .../metadata-standard/schemas/index.md | 8 -------- 3 files changed, 28 insertions(+), 9 deletions(-) delete mode 100644 openmetadata-docs/content/main-concepts/metadata-standard/schemas/index.md diff --git a/openmetadata-docs/content/deployment/upgrade/kubernetes.md b/openmetadata-docs/content/deployment/upgrade/kubernetes.md index 44bf66b319c..41a7909fd82 100644 --- a/openmetadata-docs/content/deployment/upgrade/kubernetes.md +++ b/openmetadata-docs/content/deployment/upgrade/kubernetes.md @@ -66,6 +66,15 @@ You can modify any configuration and deploy by passing your own `values.yaml`. + + +Make sure that, when using your own `values.yaml`, you are not overwriting elements such as the `image` of the containers. +This would prevent your new deployment to use the latest containers when running the upgrade. + +If you are running into any issues, double-check what are the default values of the helm revision. + + + ## Upgrade OpenMetdata We upgrade OpenMetadata with the below command: diff --git a/openmetadata-docs/content/main-concepts/metadata-standard/schemas.md b/openmetadata-docs/content/main-concepts/metadata-standard/schemas.md index b6a37676b77..9ad6390b769 100644 --- a/openmetadata-docs/content/main-concepts/metadata-standard/schemas.md +++ b/openmetadata-docs/content/main-concepts/metadata-standard/schemas.md @@ -3,4 +3,22 @@ title: Schemas slug: /main-concepts/metadata-standard/schemas --- -# Schemas \ No newline at end of file +# Schemas + +The OpenMetadata standard is powered by [JSON Schemas](https://json-schema.org/), as a readable and language-agnostic +solution that allows us to automatically generate code for the different pieces of the project. + + + +Curious about how OpenMetadata is built? You can take a look at the [High Level Design](/main-concepts/high-level-design). + + + +You can explore the JSON Schemas in different ways: +1. You can check all the definitions in [GitHub](https://github.com/open-metadata/OpenMetadata/tree/main/catalog-rest-service/src/main/resources/json/schema). + Navigating through the directories you can find, for example, the definition of a [Table](https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json). +2. If you prefer to stay in the docs, we also have you covered. We have converted the JSON Schemas to markdown files + that you can explore following the left menu titles, or navigating the structure by clicking on `Next` at the + end of each page. Again, this would be the structure of a [Table](/main-concepts/metadata-standard/schemas/entity/data/table). + In this generation we wanted to maintain the same structure as the GitHub repository. Any empty file means that you reached + a directory, but you can keep exploring until finding the right Entity, or you can also look for it using the Search Bar. diff --git a/openmetadata-docs/content/main-concepts/metadata-standard/schemas/index.md b/openmetadata-docs/content/main-concepts/metadata-standard/schemas/index.md deleted file mode 100644 index 612fc20d17f..00000000000 --- a/openmetadata-docs/content/main-concepts/metadata-standard/schemas/index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: index -slug: /main-concepts/metadata-standard/schemas ---- - -# schema - -Documentation file automatically generated at 2022-07-14 10:51:34.749986.