chore(ui): add support for service documentation md file (#10666)

* chore(ui): add support for service documentation md file

* sync local

* chore: add method for fetching markdown file

* chore: move fields to connections

openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Mysql/connections/fields/databaseName.md

@@ -0,0 +1 @@
+Optional name to give to the database in OpenMetadata. If left blank, we will use default as the database name.

openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Mysql/connections/fields/databaseSchema.md

@@ -0,0 +1 @@
+databaseSchema of the data source. This is optional parameter, if you would like to restrict the metadata reading to a single databaseSchema. When left blank, OpenMetadata Ingestion attempts to scan all the databaseSchema.

openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Mysql/connections/fields/hostPort.md

@@ -0,0 +1,3 @@
+Host and port of the Postgres service.
+
+**Example**: `localhost:8000`

openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Mysql/connections/fields/password.md

@@ -0,0 +1,2 @@
+Password to connect to Postgres.
+Should be strong and contain `@$#[0-9][a-z][A-Z]`

openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Mysql/connections/fields/scheme.md

@@ -0,0 +1 @@
+SQLAlchemy driver scheme options.

openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Mysql/connections/fields/sslCA.md

@@ -0,0 +1,2 @@
+Provide the path to ssl ca file
+Provide the path to ssl client certificate file (ssl_cert)

openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Mysql/connections/fields/sslCert.md

@@ -0,0 +1 @@
+Provide the path to ssl client certificate file (ssl_cert)

openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Mysql/connections/fields/sslKey.md

@@ -0,0 +1 @@
+Provide the path to ssl client certificate file (ssl_key)

openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Mysql/connections/fields/username.md

@@ -0,0 +1 @@
+Username to connect to Postgres. This user should have privileges to read all the metadata in Postgres.

openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Mysql/requirements.md

@@ -0,0 +1 @@
+<!-- requirement here -->

openmetadata-ui/src/main/resources/ui/src/locale/languages/en-us.json

@@ -228,6 +228,7 @@
     "display-name": "Display Name",
     "distinct": "Distinct",
     "doc-plural": "Docs",
+    "documentation": "Documentation",
     "documentation-lowercase": "documentation",
     "domain": "Domain",
     "downstream-depth": "Downstream Depth",
@@ -611,6 +612,7 @@
     "reply-lowercase": "reply",
     "reply-lowercase-plural": "replies",
     "request-tag-plural": "Request Tags",
+    "requirement-plural": "Requirements",
     "reset": "Reset",
     "reset-your-password": "Reset your Password",
     "resource-permission-lowercase": "resource permission",
@@ -1120,6 +1122,7 @@
     "select-token-expiration": "Select Token Expiration",
     "service-created-entity-description": "The <Service Name> has been created successfully. Visit the newly created service to take a look at the details. {{entity}}",
     "service-name-length": "Service name length must be between 1 and 128 characters",
+    "service-requirements-description": "Every service comes with its standard set of requirements and here are the basics of what you’d need to connect.",
     "service-with-delimiters-not-allowed": "Service name with delimiters are not allowed",
     "service-with-space-not-allowed": "Service name with spaces are not allowed",
     "session-expired": "Your session has timed out! Please sign in again to access OpenMetadata.",

openmetadata-ui/src/main/resources/ui/src/locale/languages/fr-fr.json

@@ -228,6 +228,7 @@
     "display-name": "Nom d'Affichage",
     "distinct": "Distinct",
     "doc-plural": "Docs",
+    "documentation": "Documentation",
     "documentation-lowercase": "documentation",
     "domain": "Domain",
     "downstream-depth": "Downstream Depth",
@@ -611,6 +612,7 @@
     "reply-lowercase": "reply",
     "reply-lowercase-plural": "replies",
     "request-tag-plural": "Demander des tags",
+    "requirement-plural": "Requirements",
     "reset": "Reset",
     "reset-your-password": "Reset your Password",
     "resource-permission-lowercase": "resource permission",
@@ -1120,6 +1122,7 @@
     "select-token-expiration": "Sélectionner une expiration pour le Jeton",
     "service-created-entity-description": "The <Service Name> has been created successfully. Visit the newly created service to take a look at the details. {{entity}}",
     "service-name-length": "Service name length must be between 1 and 128 characters",
+    "service-requirements-description": "Every service comes with its standard set of requirements and here are the basics of what you’d need to connect.",
     "service-with-delimiters-not-allowed": "Service name with delimiters are not allowed",
     "service-with-space-not-allowed": "Service name with spaces are not allowed",
     "session-expired": "Your session has timed out! Please sign in again to access OpenMetadata.",

openmetadata-ui/src/main/resources/ui/src/locale/languages/ja-jp.json

@@ -228,6 +228,7 @@
     "display-name": "表示名",
     "distinct": "Distinct",
     "doc-plural": "ドキュメント",
+    "documentation": "Documentation",
     "documentation-lowercase": "ドキュメント",
     "domain": "ドメイン",
     "downstream-depth": "Downstream Depth",
@@ -492,6 +493,7 @@
     "notification-plural": "通知",
     "november": "11月",
     "null": "Null",
+    "number-of-object": "Number of objects",
     "number-of-rows": "行数",
     "object-store": "オブジェクトストア",
     "object-store-plural": "オブジェクトストア",
@@ -599,6 +601,7 @@
     "region-name": "リージョン名",
     "registry": "レジストリ",
     "related-term-plural": "関連する用語",
+    "relevance": "Relevance",
     "remove": "除外",
     "remove-entity": "{{entity}}を除外",
     "removed": "除外",
@@ -609,6 +612,7 @@
     "reply-lowercase": "返信",
     "reply-lowercase-plural": "返信",
     "request-tag-plural": "タグをリクエスト",
+    "requirement-plural": "Requirements",
     "reset": "リセット",
     "reset-your-password": "パスワードをリセット",
     "resource-permission-lowercase": "リソースの権限",
@@ -843,6 +847,7 @@
     "webhook-display-text": "ウェブフック {{displayText}}",
     "wednesday": "水曜日",
     "week": "週",
+    "weekly-usage": "Weekly Usage",
     "whats-new": "最新情報",
     "yes": "はい",
     "your-entity": "あなたの{{entity}}"
@@ -1117,6 +1122,7 @@
     "select-token-expiration": "Select Token Expiration",
     "service-created-entity-description": "The <Service Name> has been created successfully. Visit the newly created service to take a look at the details. {{entity}}",
     "service-name-length": "サービス名は1以上128以下の文字列でなければいけません",
+    "service-requirements-description": "Every service comes with its standard set of requirements and here are the basics of what you’d need to connect.",
     "service-with-delimiters-not-allowed": "サービス名に区切り文字は使えません",
     "service-with-space-not-allowed": "サービス名に空白は使えません",
     "session-expired": "セッションがタイムアウトしました。OpenMetadataにアクセスするには再度サインインしてください。",

openmetadata-ui/src/main/resources/ui/src/locale/languages/zh-cn.json

@@ -228,6 +228,7 @@
     "display-name": "显示名",
     "distinct": "Distinct",
     "doc-plural": "文档",
+    "documentation": "Documentation",
     "documentation-lowercase": "documentation",
     "domain": "域",
     "downstream-depth": "Downstream Depth",
@@ -611,6 +612,7 @@
     "reply-lowercase": "reply",
     "reply-lowercase-plural": "replies",
     "request-tag-plural": "Request tags",
+    "requirement-plural": "Requirements",
     "reset": "Reset",
     "reset-your-password": "Reset your Password",
     "resource-permission-lowercase": "resource permission",
@@ -1120,6 +1122,7 @@
     "select-token-expiration": "Select Token Expiration",
     "service-created-entity-description": "The <Service Name> has been created successfully. Visit the newly created service to take a look at the details. {{entity}}",
     "service-name-length": "Service name length must be between 1 and 128 characters",
+    "service-requirements-description": "Every service comes with its standard set of requirements and here are the basics of what you’d need to connect.",
     "service-with-delimiters-not-allowed": "Service name with delimiters are not allowed",
     "service-with-space-not-allowed": "Service name with spaces are not allowed",
     "session-expired": "Your session has timed out! Please sign in again to access OpenMetadata.",

openmetadata-ui/src/main/resources/ui/src/rest/miscAPI.ts

@@ -302,3 +302,24 @@ export const getAllEntityCount = async () => {
 
   return response.data;
 };
+
+export const fetchMarkdownFile = async (filePath: string) => {
+  let baseURL = '/';
+
+  try {
+    const url = new URL(filePath);
+    baseURL = `${url.origin}/`;
+  } catch (error) {
+    baseURL = '/';
+  }
+
+  const response = await APIClient.get<string>(filePath, {
+    baseURL,
+    headers: {
+      'Content-Type': 'text/markdown',
+      Accept: 'text/markdown',
+    },
+  });
+
+  return response.data;
+};

openmetadata-ui/src/main/resources/ui/webpack.config.dev.js

@@ -218,6 +218,10 @@ module.exports = {
           from: path.join(__dirname, 'public/robots.txt'),
           to: outputPath,
         },
+        {
+          from: path.join(__dirname, 'public/locales'),
+          to: outputPath,
+        },
       ],
     }),
     // Build progress bar

openmetadata-ui/src/main/resources/ui/webpack.config.prod.js

@@ -214,6 +214,10 @@ module.exports = {
           from: path.join(__dirname, 'public/robots.txt'),
           to: outputPath,
         },
+        {
+          from: path.join(__dirname, 'public/locales'),
+          to: outputPath,
+        },
       ],
     }),
     // Build progress bar