Merge pull request #170 from open-metadata/docUpdate.part13

Doc update.part13

catalog-rest-service/src/main/resources/json/data/tags/personalDataTags.json

@@ -1,7 +1,7 @@
 {
   "name": "PersonalData",
   "categoryType": "Classification",
-  "description": "Tags related classifying Personal data as defined by GDPR.",
+  "description": "Tags related classifying **Personal data** as defined by **GDPR.**\n\n\n\n**_Note to Legal_**\n\n_This tag category is provided as a starting point. Please review and update the tags based on your company policy. Also, add a reference to your GDPR policy document in this description._",
   "children": [
     {
       "name": "Personal",

catalog-rest-service/src/main/resources/json/data/tags/piiTags.json

@@ -1,7 +1,7 @@
 {
   "name": "PII",
   "categoryType": "Classification",
-  "description": "Personally Identifiable Information information that, when used alone or with other relevant data, can identify an individual.",
+  "description": "Personally Identifiable Information information that, when used alone or with other relevant data, can identify an individual.\n\n\n\n**_Note to Legal_**\n\n_This tag category is provided as a starting point. Please review and update the tags based on your company policy. Also, add a reference to your PII policy document in this description._",
   "children": [
     {
       "name": "None",

catalog-rest-service/src/main/resources/json/data/tags/tierTags.json

@@ -1,27 +1,27 @@
 {
   "name": "Tier",
   "categoryType": "Descriptive",
-  "description": "Tags related to tiering of the data. Tiers capture the business importance of data.",
+  "description": "Tags related to tiering of the data. Tiers capture the business importance of data. When a data asset is tagged with `Tier` tag, all the upstream data assets used for producing it will also be labeled with the same tag. This will help upstream data asset owners to understand the critical purposes their data is being used.",
   "children": [
     {
       "name": "Tier1",
-      "description": "todo"
+      "description": "**Critical Source of Truth business data assets of an organization**\n\n- Used in critical metrics and dashboards to drive business and product decisions\n\n- Used in critical compliance reporting to regulators, govt entities, and third party\n\n- Used in brand or revenue impacting online user-facing experiences (search results, advertisement, promotions, and experimentation)\n\n- Other high impact use, such as ML models and fraud detection\n\n- Source used to derive other critical Tier-1 datasets"
     },
     {
       "name": "Tier2",
-      "description": "todo"
+      "description": "**Important business datasets for your company (not as critical as Tier 1)**\n\n- Used in important business metrics, product metrics, and dashboards to drive internal decisions\n\n- Used in important compliance reporting to major regulators, govt entities, and third party\n\n- Used for less critical online user-facing experiences (user activity, user behavior)\n\n- Source used to derive other critical Tier-2 datasets"
     },
     {
       "name": "Tier3",
-      "description": "todo"
+      "description": "**Department/group level datasets that are typically non-business and general internal system**\n\n- Used in product metrics, and dashboards to drive product decisions\n\n- Used to track operational metrics of internal systems\n\n- Source used to derive other critical Tier-3 datasets"
     },
     {
       "name": "Tier4",
-      "description": "todo"
+      "description": "**Team level datasets that are typically non-business and general internal system**\n\n- Used in product metrics, and dashboards to drive team decisions\n\n- Used to track operational metrics of internal systems owned by the team\n\n- Source used to derive other critical Tier-4 datasets"
     },
     {
       "name": "Tier5",
-      "description": "todo"
+      "description": "**Private/Unused data assets - No impact beyond individual users**\n\n- Data assets without any ownership with no usage in the last 60 days\n\n- Data assets owned by individuals without team ownership\n\n"
     }
   ]
 }

catalog-rest-service/src/main/resources/json/data/tags/userTags.json

@@ -1,7 +1,7 @@
 {
   "name": "User",
   "categoryType": "Descriptive",
-  "description": "Tags related to describing User related data.",
+  "description": "Tags related to describing User related data. These tags are used to label data assets to describe the user data in those assets. Example - a table column can be labeled with `User.PhoneNumber` tag. The associated `PII` and `PersonalData` tags are automatically applied. This is done to help users producing the data  focus on describing the data without being policy experts. The associated tags take care of applying classification tags automatically.",
   "children": [
     {
       "name": "Address",

catalog-rest-service/src/main/resources/ui/src/jsons/tiersData.json

@@ -9,10 +9,10 @@
           "text": "Used in critical metrics and dashboards to drive business and product decisions"
         },
         {
-          "text": "Used in critical compliance reporting to regulators, govt entities and third party"
+          "text": "Used in critical compliance reporting to regulators, govt entities, and third party"
         },
         {
-          "text": "Used in brand or revenue impacting online user facing experiences (search results, advertisement, promotions, experimentation)"
+          "text": "Used in brand or revenue impacting online user-facing experiences (search results, advertisement, promotions, experimentation)"
         },
         {
           "text": "Other high impact use, such as ML models, fraud detection, and brand affecting use cases"
@@ -31,13 +31,13 @@
           "text": "Used in important business metrics, product metrics, and dashboards to drive internal decisions"
         },
         {
-          "text": "Used in important compliance reporting to major regulators, govt entities and third party"
+          "text": "Used in important compliance reporting to major regulators, govt entities, and third party"
         },
         {
-          "text": "Used for less critical online user facing experiences (user activitity, user behavior)"
+          "text": "Used for less critical online user-facing experiences (user activity, user behavior)"
         },
         {
-          "text": "Source used to derive other critical Tier-1 datasets"
+          "text": "Source used to derive other critical Tier-2 datasets"
         }
       ]
     },
@@ -53,14 +53,14 @@
           "text": "Used to track operational metrics of internal systems"
         },
         {
-          "text": "Source used to derive other critical Tier-1 datasets"
+          "text": "Source used to derive other critical Tier-3 datasets"
         }
       ]
     },
     {
       "title": "Tier 4",
       "id": "Tier.Tier4",
-      "description": "Team level dataset that are typically non-business and general internal system",
+      "description": "Team level datasets that are typically non-business and general internal system",
       "contents": [
         {
           "text": "Used in product metrics, and dashboards to drive team decisions"
@@ -69,7 +69,7 @@
           "text": "Used to track operational metrics of internal systems owned by the team"
         },
         {
-          "text": "Source used to derive other critical Tier-1 datasets"
+          "text": "Source used to derive other critical Tier-4 datasets"
         }
       ]
     },

ingestion/examples/shopify_schemas/database.json

@@ -1,7 +1,7 @@
 {
   "id": null,
   "name": "shopify",
-  "description": "This database contains tables related to shopify order and related dimensions",
+  "description": "This **mock** database contains tables related to shopify sales and orders with related dimension tables.",
   "service": {
     "id": "b946d870-03b2-4d33-a075-13665a7a76b9",
     "type": "BIGQUERY"