[sc-23356] modify readme for optional output field (#768)

metaphor/alation/README.md

@@ -15,15 +15,14 @@ Create a YAML config file based on the following template.
 ```yaml
 url: <url to the Alation instance>
 token: <API token>
-output:
-  file:
-    directory: <output_directory>
 ```
 
-See [Output Config](../common/docs/output.md) for more information on `output`.
-
 ### Optional Configurations
 
+#### Output Destination
+
+See [Output Config](../common/docs/output.md) for more information.
+
 #### Snowflake, MSSQL and Synapse Account
 
 If there are data sources from Snowflake, MSSQL or Synapse, please provide their accounts as follows,
@@ -48,7 +47,7 @@ If not provided, each dataset's first owner will be considered as the author. If
 
 Follow the [Installation](../../README.md) instructions to install `metaphor-connectors` in your environment (or virtualenv). Make sure to include either `all` or `datahub` extra.
 
-To test the connector locally, change the config file to output to a local path and run the following command
+Run the following command to test the connector locally:
 
 ```shell
 metaphor alation <config_file>

metaphor/azure_data_factory/readme.md

@@ -25,17 +25,19 @@ client_secret: <client_secret>  # The client secret value (not secret ID)
 
 subscription_id: <subscription_id>  # Azure subscription id
 
-output:
-  file:
-    directory: <output_directory>
 ```
 
+### Optional Configurations
+
+#### Output Destination
+
+See [Output Config](../common/docs/output.md) for more information.
 
 ## Testing
 
 Follow the [Installation](../../README.md) instructions to install `metaphor-connectors` in your environment (or virtualenv). Make sure to include either `all` or `datafactory` extra.
 
-To test the connector locally, change the config file to output to a local path and run the following command
+Run the following command to test the connector locally:
 
 ```shell
 metaphor azure_data_factory <config_file>

metaphor/bigquery/README.md

@@ -75,13 +75,8 @@ Create a YAML config file based on the following template.
 ```yaml
 project_ids:
   - <bigquery_project_id>
-output:
-  file:
-    directory: <output_directory>
 ```
 
-See [Output Config](../common/docs/output.md) for more information on `output`.
-
 To connect to BigQuery, either the keyfile path or credentials from the JSON keyfile must be set in the config as following:
 
 ```yaml
@@ -112,6 +107,10 @@ credentials:
 
 ### Optional Configurations
 
+#### Output Destination
+
+See [Output Config](../common/docs/output.md) for more information.
+
 #### Filtering
 
 See [Filter Config](../common/docs/filter.md) for more information on the optional `filter` config.
@@ -182,9 +181,9 @@ filter:
 
 Follow the [Installation](../../README.md) instructions to install `metaphor-connectors` in your environment (or virtualenv). Make sure to include either `all` or `bigquery` extra.
 
-To test the connector locally, change the config file to output to a local path and run the following command
+Run the following command to test the connector locally:
 
-```
+```shell
 metaphor bigquery <config_file>
 ```
 

metaphor/bigquery/lineage/README.md

@@ -33,7 +33,7 @@ batch_size: <batch_size>
 
 Follow the [Installation](../../../README.md) instructions to install `metaphor-connectors` in your environment (or virtualenv). Make sure to include either `all` or `bigquery` extra.
 
-To test the connector locally, change the config file to output to a local path and run the following command
+Run the following command to test the connector locally:
 
 ```bash
 metaphor bigquery.lineage <config_file>

metaphor/bigquery/profile/README.md

@@ -24,7 +24,7 @@ See [Sampling Config](../../common/docs/sampling.md) for details.
 
 Follow the [Installation](../../README.md) instructions to install `metaphor-connectors` in your environment (or virtualenv). Make sure to include either `all` or `bigquery` extra.
 
-To test the connector locally, change the config file to output to a local path and run the following command
+Run the following command to test the connector locally:
 
 ```bash
 metaphor bigquery.profile <config_file>

metaphor/custom/data_quality/README.md

@@ -34,14 +34,15 @@ datasets:
               ...
         ...
   ...
-output:
-  file:
-    directory: <output_directory>
 ```
 
 > Note: You only need to specify `account` if the platform is `SNOWFLAKE`.
 
-See [Output Config](../../common/docs/output.md) for more information on `output`.
+### Optional Configurations
+
+#### Output Destination
+
+See [Output Config](../common/docs/output.md) for more information.
 
 ### Examples
 
@@ -64,16 +65,13 @@ datasets:
           last_run: 2022-10-16T07:00:40
           targets:
             - column: col2
-output:
-  file:
-    directory: /output
 ```
 
 ## Testing
 
 Follow the [Installation](../../README.md) instructions to install `metaphor-connectors` in your environment (or virtualenv).
 
-To test the connector locally, change the config file to output to a local path and run the following command
+Run the following command to test the connector locally:
 
 ```shell
 metaphor custom.data_quality <config_file>

metaphor/custom/governance/README.md

@@ -45,14 +45,15 @@ datasets:
           ...
       ...
   ...
-output:
-  file:
-    directory: <output_directory>
 ```
 
 > Note: You only need to specify `account` if the platform is `SNOWFLAKE`.
 
-See [Output Config](../../common/docs/output.md) for more information on `output`.
+### Optional Configurations
+
+#### Output Destination
+
+See [Output Config](../common/docs/output.md) for more information.
 
 ### Examples
 
@@ -68,9 +69,6 @@ datasets:
         email: [email protected]
       - type: 
         email: [email protected]
-output:
-  file:
-    directory: /output
 ```
 
 Here's another example showing how to tag a Snowflake table as `golden`, and the `email` column as `pii`.
@@ -87,9 +85,6 @@ datasets:
       - column: email
         tags:
           - pii
-output:
-  file:
-    directory: /output
 ```
 
 The following example shows how to add a description to a Redshift table.
@@ -102,16 +97,13 @@ datasets:
     descriptions:
       - description: A fancy description for the table
         email: [email protected]
-output:
-  file:
-    directory: /output
 ```
 
 ## Testing
 
 Follow the [Installation](../../README.md) instructions to install `metaphor-connectors` in your environment (or virtualenv).
 
-To test the connector locally, change the config file to output to a local path and run the following command
+Run the following command to test the connector locally:
 
 ```shell
 metaphor custom.governance <config_file>

metaphor/custom/lineage/README.md

@@ -23,14 +23,15 @@ lineages:
         account: <snowflake_account> # only for Snowflake
       ...
   ...
-output:
-  file:
-    directory: <output_directory>
 ```
 
 > Note: You only need to specify `account` if the platform is `SNOWFLAKE`.
 
-See [Output Config](../../common/docs/output.md) for more information on `output`.
+### Optional Configurations
+
+#### Output Destination
+
+See [Output Config](../common/docs/output.md) for more information.
 
 ### Examples
 
@@ -47,16 +48,13 @@ lineages:
       - platform: SNOWFLAKE
         name: db.schema.table3
         account: snowflake_account
-output:
-  file:
-    directory: /output
 ```
 
 ## Testing
 
 Follow the [Installation](../../README.md) instructions to install `metaphor-connectors` in your environment (or virtualenv).
 
-To test the connector locally, change the config file to output to a local path and run the following command
+Run the following command to test the connector locally:
 
 ```shell
 metaphor custom.lineage <config_file>

metaphor/custom/metadata/README.md

@@ -22,14 +22,15 @@ datasets:
       <key>: <value>
       ...
   ...
-output:
-  file:
-    directory: <output_directory>
 ```
 
 > Note: You only need to specify `account` if the platform is `SNOWFLAKE`.
 
-See [Output Config](../../common/docs/output.md) for more information on `output`.
+### Optional Configurations
+
+#### Output Destination
+
+See [Output Config](../common/docs/output.md) for more information.
 
 ### Examples
 
@@ -49,16 +50,13 @@ datasets:
       key4:
         f1: value1,
         f2: value2
-output:
-  file:
-    directory: /output
 ```
 
 ## Testing
 
 Follow the [Installation](../../README.md) instructions to install `metaphor-connectors` in your environment (or virtualenv).
 
-To test the connector locally, change the config file to output to a local path and run the following command
+Run the following command to test the connector locally:
 
 ```shell
 metaphor manual.metadata <config_file>

metaphor/custom/query_attributions/README.md

@@ -19,12 +19,13 @@ attributions:
       <query_id>: <user_email>
       ...
   ...
-output:
-  file:
-    directory: <output_directory>
 ```
 
-See [Output Config](../../common/docs/output.md) for more information on `output`.
+### Optional Configurations
+
+#### Output Destination
+
+See [Output Config](../common/docs/output.md) for more information.
 
 ### Examples
 
@@ -36,16 +37,13 @@ attributions:
     queries:
       query_id_1: [email protected]
       query_id_2: [email protected]
-output:
-  file:
-    directory: /output
 ```
 
 ## Testing
 
 Follow the [Installation](../../README.md) instructions to install `metaphor-connectors` in your environment (or virtualenv).
 
-To test the connector locally, change the config file to output to a local path and run the following command
+Run the following command to test the connector locally:
 
 ```shell
 metaphor custom.query_attributions <config_file>

metaphor/datahub/README.md

@@ -26,15 +26,14 @@ Create a YAML config file based on the following template.
 host: <host>
 port: <port>
 token: <token> # This is the personal access token.
-output:
-  file:
-    directory: <output_directory>
 ```
 
-See [Output Config](../common/docs/output.md) for more information on `output`.
-
 ### Optional Configurations
 
+#### Output Destination
+
+See [Output Config](../common/docs/output.md) for more information.
+
 #### Snowflake, MSSQL and Synapse Account
 
 If there are data sources from Snowflake, MSSQL or Synapse, please provide their accounts as follows,
@@ -59,7 +58,7 @@ If not provided, each dataset's first owner will be considered as the author. If
 
 Follow the [Installation](../../README.md) instructions to install `metaphor-connectors` in your environment (or virtualenv). Make sure to include either `all` or `datahub` extra.
 
-To test the connector locally, change the config file to output to a local path and run the following command
+Run the following command to test the connector locally:
 
 ```shell
 metaphor datahub <config_file>

metaphor/dbt/README.md

@@ -17,15 +17,14 @@ Create a YAML config file based the following template.
 ```yaml
 manifest: <path_to_manifest_json>
 run_results: <path_to_run_results_json>
-output:
-  file:
-    directory: <output_directory>
 ```
 
-See [Output Config](../common/docs/output.md) for more information on `output`.
-
 ### Optional Configurations
 
+#### Output Destination
+
+See [Output Config](../common/docs/output.md) for more information.
+
 #### Snowflake Account
 
 If the dbt project is using Snowflake, please provide the Snowflake account as follows,
@@ -135,9 +134,9 @@ models:
 
 Follow the [Installation](../../README.md) instructions to install `metaphor-connectors` in your environment (or virtualenv). Make sure to include either `all` or `dbt` extra.
 
-To test the connector locally, change the config file to output to a local path and run the following command
+Run the following command to test the connector locally:
 
-```
+```shell
 metaphor dbt <config_file>
 ```