diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 65277706d2f..20edba6ae41 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -123,4 +123,4 @@ * [BulkSink](open-source-community/developer/build-a-connector/bulksink.md) * [Run Integration Tests](open-source-community/developer/run-integration-tests.md) * [UX Style Guide](open-source-community/developer/ux-style-guide.md) - * [Generate typescript types from JSON schema](open-source-community/developer/generate-typescript-types-from-json-schema.md) + * [Generate Typescript Types From JSON Schema](open-source-community/developer/generate-typescript-types-from-json-schema.md) diff --git a/docs/open-source-community/developer/generate-typescript-types-from-json-schema.md b/docs/open-source-community/developer/generate-typescript-types-from-json-schema.md index 25abc2dd528..bd056b660a3 100644 --- a/docs/open-source-community/developer/generate-typescript-types-from-json-schema.md +++ b/docs/open-source-community/developer/generate-typescript-types-from-json-schema.md @@ -4,17 +4,17 @@ description: >- schema. --- -# Generate typescript types from JSON schema +# Generate Typescript Types From JSON Schema We are using [quicktype](https://quicktype.io) to generate types from JSON Schema. -Install quicktype dependency globally using npm +Make sure you have `quicktype` installed if not then install it using command given below from `openmetadata` root folder. ``` -npm install -g quicktype +npm install ``` -Now go to the UI folder `src/main/resources/ui` and from there run the command given below. +Now go to the UI folder `openmetadata-ui/src/main/resources/ui` and from there run the command given below. ``` npm run json2ts @@ -22,4 +22,4 @@ npm run json2ts The above command will take some time to execute and generate types. -After that, you can go to the generated `src/main/resources/ui/src/generated/*` folder and see the all generated types. +After that, you can go to the generated `openmetadata-ui/src/main/resources/ui/src/generated/*` folder and see the all generated types.