Docs - Add schemas navigation info (#6494)

Docs - Add schemas navigation info (#6494)
This commit is contained in:
Pere Miquel Brull 2022-08-02 12:58:46 +02:00 committed by GitHub
parent 6175b821c5
commit 0c7e4f716e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 28 additions and 9 deletions

View File

@ -66,6 +66,15 @@ You can modify any configuration and deploy by passing your own `values.yaml`.
</Note>
<Tip>
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.
</Tip>
## Upgrade OpenMetdata
We upgrade OpenMetadata with the below command:

View File

@ -3,4 +3,22 @@ title: Schemas
slug: /main-concepts/metadata-standard/schemas
---
# Schemas
# 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.
<Note>
Curious about how OpenMetadata is built? You can take a look at the [High Level Design](/main-concepts/high-level-design).
</Note>
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.

View File

@ -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.