From b8b30d8c8589e67ab0fe312f869156127e90cb81 Mon Sep 17 00:00:00 2001 From: sureshms Date: Mon, 9 Aug 2021 19:28:15 -0700 Subject: [PATCH 1/2] Doc cleanup - fixing gitbook rendering issues --- docs/SUMMARY.md | 8 +++---- .../schemas/entities/README.md | 22 +++++++++---------- 2 files changed, 15 insertions(+), 15 deletions(-) diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 2beb904c41d..7f8162160b2 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -20,15 +20,15 @@ * [Bot](openmetadata-apis/schemas/entities/bots.md) * [Dashboard](openmetadata-apis/schemas/entities/data/dashboard.md) * [Database](openmetadata-apis/schemas/entities/data/database.md) - * [Database Service](openmetadata-apis/schemas/entities/services/databaseservice.md) + * [Database Service](openmetadata-apis/schemas/entities/services/databaSeservice.md) * [Feed](openmetadata-apis/schemas/entities/feed/thread.md) * [Metrics](openmetadata-apis/schemas/entities/data/metrics.md) * [Pipeline](openmetadata-apis/schemas/entities/data/pipeline.md) * [Report](openmetadata-apis/schemas/entities/data/report.md) * [Table](openmetadata-apis/schemas/entities/data/table.md) - * [Team](openmetadata-apis/schemas/entities/team/team.md) - * [Tag Categoty](openmetadata-apis/schemas/entities/tags/tagcategory.md) - * [User](openmetadata-apis/schemas/entities/team/user.md) + * [Team](openmetadata-apis/schemas/entities/teams/team.md) + * [Tag Categoty](openmetadata-apis/schemas/entities/tags/tagCategory.md) + * [User](openmetadata-apis/schemas/entities/teams/user.md) * [APIs](openmetadata-apis/apis/README.md) * [Overview](openmetadata-apis/apis/overview.md) diff --git a/docs/openmetadata-apis/schemas/entities/README.md b/docs/openmetadata-apis/schemas/entities/README.md index 09675b5be29..bb9be3d351e 100644 --- a/docs/openmetadata-apis/schemas/entities/README.md +++ b/docs/openmetadata-apis/schemas/entities/README.md @@ -69,24 +69,24 @@ Metadata system has the following core entities: ## List of Schema Entities {% page-ref page="bots.md" %} -{% page-ref page="dashboard.md" %} +{% page-ref page="data/dashboard.md" %} -{% page-ref page="database.md" %} +{% page-ref page="data/database.md" %} -{% page-ref page="databaseservice.md" %} +{% page-ref page="services/databaseService.md" %} -{% page-ref page="thread.md" %} +{% page-ref page="feed/thread.md" %} -{% page-ref page="metrics.md" %} +{% page-ref page="data/metrics.md" %} -{% page-ref page="pipeline.md" %} +{% page-ref page="data/pipeline.md" %} -{% page-ref page="report.md" %} +{% page-ref page="data/report.md" %} -{% page-ref page="table.md" %} +{% page-ref page="data/table.md" %} -{% page-ref page="tagcategory.md" %} +{% page-ref page="tags/tagCategory.md" %} -{% page-ref page="team.md" %} +{% page-ref page="teams/team.md" %} -{% page-ref page="user.md" %} \ No newline at end of file +{% page-ref page="teams/user.md" %} \ No newline at end of file From 0d6791d7bfbee77cc8bb69056e5c76a25429bd52 Mon Sep 17 00:00:00 2001 From: sureshms Date: Mon, 9 Aug 2021 19:58:52 -0700 Subject: [PATCH 2/2] Doc cleanup - fixing gitbook rendering issues - part4 --- docs/SUMMARY.md | 4 +-- .../schemas/entities/README.md | 4 +-- ...databaseService.md => database-service.md} | 0 .../tags/{tagCategory.md => tag-category.md} | 0 .../openmetadata-apis/schemas/types/README.md | 14 ++++---- .../types/{auditLog.md => audit-log.md} | 0 .../schemas/types/collectionDescriptor.md | 35 ------------------- .../types/{dailyCount.md => daily-count.md} | 0 ...entityReference.md => entity-reference.md} | 0 .../types/{entityUsage.md => entity-usage.md} | 0 .../{jdbcConnection.md => jdbc-connection.md} | 0 .../types/{tagLabel.md => tag-label.md} | 0 .../{usageDetails.md => usage-details.md} | 0 13 files changed, 11 insertions(+), 46 deletions(-) rename docs/openmetadata-apis/schemas/entities/services/{databaseService.md => database-service.md} (100%) rename docs/openmetadata-apis/schemas/entities/tags/{tagCategory.md => tag-category.md} (100%) rename docs/openmetadata-apis/schemas/types/{auditLog.md => audit-log.md} (100%) delete mode 100644 docs/openmetadata-apis/schemas/types/collectionDescriptor.md rename docs/openmetadata-apis/schemas/types/{dailyCount.md => daily-count.md} (100%) rename docs/openmetadata-apis/schemas/types/{entityReference.md => entity-reference.md} (100%) rename docs/openmetadata-apis/schemas/types/{entityUsage.md => entity-usage.md} (100%) rename docs/openmetadata-apis/schemas/types/{jdbcConnection.md => jdbc-connection.md} (100%) rename docs/openmetadata-apis/schemas/types/{tagLabel.md => tag-label.md} (100%) rename docs/openmetadata-apis/schemas/types/{usageDetails.md => usage-details.md} (100%) diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 7f8162160b2..c731789a2ca 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -20,14 +20,14 @@ * [Bot](openmetadata-apis/schemas/entities/bots.md) * [Dashboard](openmetadata-apis/schemas/entities/data/dashboard.md) * [Database](openmetadata-apis/schemas/entities/data/database.md) - * [Database Service](openmetadata-apis/schemas/entities/services/databaSeservice.md) + * [Database Service](openmetadata-apis/schemas/entities/services/databaseService.md) * [Feed](openmetadata-apis/schemas/entities/feed/thread.md) * [Metrics](openmetadata-apis/schemas/entities/data/metrics.md) * [Pipeline](openmetadata-apis/schemas/entities/data/pipeline.md) * [Report](openmetadata-apis/schemas/entities/data/report.md) * [Table](openmetadata-apis/schemas/entities/data/table.md) * [Team](openmetadata-apis/schemas/entities/teams/team.md) - * [Tag Categoty](openmetadata-apis/schemas/entities/tags/tagCategory.md) + * [Tag Category](openmetadata-apis/schemas/entities/tags/tagCategory.md) * [User](openmetadata-apis/schemas/entities/teams/user.md) * [APIs](openmetadata-apis/apis/README.md) * [Overview](openmetadata-apis/apis/overview.md) diff --git a/docs/openmetadata-apis/schemas/entities/README.md b/docs/openmetadata-apis/schemas/entities/README.md index bb9be3d351e..74c65825166 100644 --- a/docs/openmetadata-apis/schemas/entities/README.md +++ b/docs/openmetadata-apis/schemas/entities/README.md @@ -73,7 +73,7 @@ Metadata system has the following core entities: {% page-ref page="data/database.md" %} -{% page-ref page="services/databaseService.md" %} +{% page-ref page="services/database-service.md" %} {% page-ref page="feed/thread.md" %} @@ -85,7 +85,7 @@ Metadata system has the following core entities: {% page-ref page="data/table.md" %} -{% page-ref page="tags/tagCategory.md" %} +{% page-ref page="tags/tag-category.md" %} {% page-ref page="teams/team.md" %} diff --git a/docs/openmetadata-apis/schemas/entities/services/databaseService.md b/docs/openmetadata-apis/schemas/entities/services/database-service.md similarity index 100% rename from docs/openmetadata-apis/schemas/entities/services/databaseService.md rename to docs/openmetadata-apis/schemas/entities/services/database-service.md diff --git a/docs/openmetadata-apis/schemas/entities/tags/tagCategory.md b/docs/openmetadata-apis/schemas/entities/tags/tag-category.md similarity index 100% rename from docs/openmetadata-apis/schemas/entities/tags/tagCategory.md rename to docs/openmetadata-apis/schemas/entities/tags/tag-category.md diff --git a/docs/openmetadata-apis/schemas/types/README.md b/docs/openmetadata-apis/schemas/types/README.md index 700114c4fea..6f216add976 100644 --- a/docs/openmetadata-apis/schemas/types/README.md +++ b/docs/openmetadata-apis/schemas/types/README.md @@ -5,20 +5,20 @@ JSON schema supports many native types - `null`, `boolean`, `object`, `array`, ` ## List of Schema Types {% page-ref page="basic.md" %} -{% page-ref page="collectionDescriptor.md" %} +{% page-ref page="collection-descriptor.md" %} -{% page-ref page="dailyDount.md" %} +{% page-ref page="daily-count.md" %} -{% page-ref page="entityReference.md" %} +{% page-ref page="entity-reference.md" %} -{% page-ref page="entityUsage.md" %} +{% page-ref page="entity-usage.md" %} -{% page-ref page="jdbcConnection.md" %} +{% page-ref page="jdbc-connection.md" %} {% page-ref page="profile.md" %} {% page-ref page="schedule.md" %} -{% page-ref page="tagLabel.md" %} +{% page-ref page="tag-label.md" %} -{% page-ref page="usageDetails.md" %} +{% page-ref page="usage-details.md" %} diff --git a/docs/openmetadata-apis/schemas/types/auditLog.md b/docs/openmetadata-apis/schemas/types/audit-log.md similarity index 100% rename from docs/openmetadata-apis/schemas/types/auditLog.md rename to docs/openmetadata-apis/schemas/types/audit-log.md diff --git a/docs/openmetadata-apis/schemas/types/collectionDescriptor.md b/docs/openmetadata-apis/schemas/types/collectionDescriptor.md deleted file mode 100644 index 8a17db2c11d..00000000000 --- a/docs/openmetadata-apis/schemas/types/collectionDescriptor.md +++ /dev/null @@ -1,35 +0,0 @@ -# Schema for collection descriptor - -Type used for capturing the details of a collection. - -$id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/collectionDescriptor.json - -Type: `object` - -## Properties - - collection - - $ref: [#/definitions/collectionInfo](#/definitions/collectionInfo) - - -## Definitions -**_collectionInfo_** - - - Collection Info. - - Type: `object` - - **_Properties_** - - name - - Unique name that identifies a collection. - - Type: `string` - - documentation - - Description of collection. - - Type: `string` - - href - - URL of the API endpoint where given collections are available. - - Type: `string` - - String format must be a "uri" - - images - - $ref: [profile.json#/definitions/imageList](#profile.jsondefinitionsimagelist) - - - -_Generated with [json-schema-md-doc](https://brianwendt.github.io/json-schema-md-doc/)_ _Mon Aug 09 2021 19:12:30 GMT-0700 (Pacific Daylight Time)_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/types/dailyCount.md b/docs/openmetadata-apis/schemas/types/daily-count.md similarity index 100% rename from docs/openmetadata-apis/schemas/types/dailyCount.md rename to docs/openmetadata-apis/schemas/types/daily-count.md diff --git a/docs/openmetadata-apis/schemas/types/entityReference.md b/docs/openmetadata-apis/schemas/types/entity-reference.md similarity index 100% rename from docs/openmetadata-apis/schemas/types/entityReference.md rename to docs/openmetadata-apis/schemas/types/entity-reference.md diff --git a/docs/openmetadata-apis/schemas/types/entityUsage.md b/docs/openmetadata-apis/schemas/types/entity-usage.md similarity index 100% rename from docs/openmetadata-apis/schemas/types/entityUsage.md rename to docs/openmetadata-apis/schemas/types/entity-usage.md diff --git a/docs/openmetadata-apis/schemas/types/jdbcConnection.md b/docs/openmetadata-apis/schemas/types/jdbc-connection.md similarity index 100% rename from docs/openmetadata-apis/schemas/types/jdbcConnection.md rename to docs/openmetadata-apis/schemas/types/jdbc-connection.md diff --git a/docs/openmetadata-apis/schemas/types/tagLabel.md b/docs/openmetadata-apis/schemas/types/tag-label.md similarity index 100% rename from docs/openmetadata-apis/schemas/types/tagLabel.md rename to docs/openmetadata-apis/schemas/types/tag-label.md diff --git a/docs/openmetadata-apis/schemas/types/usageDetails.md b/docs/openmetadata-apis/schemas/types/usage-details.md similarity index 100% rename from docs/openmetadata-apis/schemas/types/usageDetails.md rename to docs/openmetadata-apis/schemas/types/usage-details.md