yujunjun/datahub
2
0
Fork 0
mirror of https://github.com/datahub-project/datahub.git synced 2025-08-15 12:46:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix(docs): replaced outdated docs command for building breaking changes of the metadata model (#7759)

Browse Source 
Co-authored-by: Shirshanka Das <shirshanka@apache.org>
This commit is contained in:
Arne Jacobs 2023-04-10 21:09:55 +02:00 committed by GitHub
parent 294c5ff507
commit 041df376cb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/how/add-new-aspect.md
View File

@ -9,7 +9,7 @@ We'll use the [CorpUserEditableInfo](https://github.com/datahub-project/datahub/
3. Rebuild the rest.li [IDL & snapshot](https://linkedin.github.io/rest.li/modeling/compatibility_check) by running the following command from the project root
```
./gradlew :gms:impl:build -Prest.model.compatibility=ignore
./gradlew :metadata-service:restli-servlet-impl:build -Prest.model.compatibility=ignore
```
4. To surface the new aspect at the top-level [resource endpoint](https://linkedin.github.io/rest.li/user_guide/restli_server#writing-resources), extend the resource data model (e.g. [`CorpUser`](https://github.com/datahub-project/datahub/blob/master/gms/api/src/main/pegasus/com/linkedin/identity/CorpUser.pdl)) with an optional field (e.g. [`editableInfo`](https://github.com/datahub-project/datahub/blob/master/gms/api/src/main/pegasus/com/linkedin/identity/CorpUser.pdl#L21)). You'll also need to extend the `toValue` & `toSnapshot` methods of the top-level resource (e.g. [`CorpUsers`](https://github.com/datahub-project/datahub/blob/master/gms/impl/src/main/java/com/linkedin/metadata/resources/identity/CorpUsers.java)) to convert between the snapshot & value models.

2
docs/modeling/extending-the-metadata-model.md
View File

@ -239,7 +239,7 @@ If you opted for the open-source fork approach, where you are editing models in
Read on to understand how to re-build DataHub for the oss-fork option.
**_NOTE_**: If you have updated any existing types or see an `Incompatible changes` warning when building, you will need to run
`./gradlew :gms:impl:build -Prest.model.compatibility=ignore`
`./gradlew :metadata-service:restli-servlet-impl:build -Prest.model.compatibility=ignore`
before running `build`.
Then, run `./gradlew build` from the repository root to rebuild Datahub with access to your new entity.