docs(ingest): update dbt and aws docs (#7870)

datahub-project · Apr 21, 2023 · 66f4494 · 66f4494
1 parent 9199c89
commit 66f4494
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 16 deletions.
diff --git a/metadata-ingestion/docs/sources/dbt/README.md b/metadata-ingestion/docs/sources/dbt/README.md
@@ -2,18 +2,15 @@ Ingesting metadata from dbt requires either using the **dbt** module or the **db
 
 ### Concept Mapping
 
-| Source Concept           | DataHub Concept                                               | Notes                 |
-| ------------------------ | ------------------------------------------------------------- | --------------------- |
-| `"dbt"`                  | [Data Platform](../../metamodel/entities/dataPlatform.md)     |                       |
-| dbt Source               | [Dataset](../../metamodel/entities/dataset.md)                | Subtype `source`      |
-| dbt Seed                 | [Dataset](../../metamodel/entities/dataset.md)                | Subtype `seed`        |
-| dbt Model - materialized | [Dataset](../../metamodel/entities/dataset.md)                | Subtype `table`       |
-| dbt Model - view         | [Dataset](../../metamodel/entities/dataset.md)                | Subtype `view`        |
-| dbt Model - incremental  | [Dataset](../../metamodel/entities/dataset.md)                | Subtype `incremental` |
-| dbt Model - ephemeral    | [Dataset](../../metamodel/entities/dataset.md)                | Subtype `ephemeral`   |
-| dbt Snapshot             | [Dataset](../../metamodel/entities/dataset.md)                | Subtype `snapshot`    |
-| dbt Test                 | [Assertion](../../metamodel/entities/assertion.md)            |                       |
-| dbt Test Result          | [Assertion Run Result](../../metamodel/entities/assertion.md) |                       |
+| Source Concept  | DataHub Concept                                               | Notes              |
+| --------------- | ------------------------------------------------------------- | ------------------ |
+| `"dbt"`         | [Data Platform](../../metamodel/entities/dataPlatform.md)     |                    |
+| dbt Source      | [Dataset](../../metamodel/entities/dataset.md)                | Subtype `source`   |
+| dbt Seed        | [Dataset](../../metamodel/entities/dataset.md)                | Subtype `seed`     |
+| dbt Model       | [Dataset](../../metamodel/entities/dataset.md)                | Subtype `model`    |
+| dbt Snapshot    | [Dataset](../../metamodel/entities/dataset.md)                | Subtype `snapshot` |
+| dbt Test        | [Assertion](../../metamodel/entities/assertion.md)            |                    |
+| dbt Test Result | [Assertion Run Result](../../metamodel/entities/assertion.md) |                    |
 
 Note:
 

diff --git a/metadata-ingestion/src/datahub/ingestion/source/aws/aws_common.py b/metadata-ingestion/src/datahub/ingestion/source/aws/aws_common.py
@@ -59,7 +59,7 @@ def assume_role(
     return dict(assumed_role_object["Credentials"])
 
 
-AUTODETECT_CREDENTIALS_DOC_LINK = "Can be auto-detected, see https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for details."
+AUTODETECT_CREDENTIALS_DOC_LINK = "Can be auto-detected, see [the AWS boto3 docs](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html) for details."
 
 
 class AwsConnectionConfig(ConfigModel):
@@ -97,11 +97,11 @@ class AwsConnectionConfig(ConfigModel):
 
     aws_endpoint_url: Optional[str] = Field(
         default=None,
-        description="Autodetected. See https://boto3.amazonaws.com/v1/documentation/api/latest/reference/core/session.html",
+        description="The AWS service endpoint. This is normally [constructed automatically](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/core/session.html), but can be overridden here.",
     )
     aws_proxy: Optional[Dict[str, str]] = Field(
         default=None,
-        description="Autodetected. See https://boto3.amazonaws.com/v1/documentation/api/latest/reference/core/session.html",
+        description="A set of proxy configs to use with AWS. See the [botocore.config](https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html) docs for details.",
     )
 
     def _normalized_aws_roles(self) -> List[AwsAssumeRoleConfig]:

diff --git a/metadata-ingestion/src/datahub/ingestion/source/s3/config.py b/metadata-ingestion/src/datahub/ingestion/source/s3/config.py
@@ -39,7 +39,7 @@ class DataLakeSourceConfig(PlatformInstanceConfigMixin, EnvConfigMixin):
     # Whether or not to create in datahub from the s3 object
     use_s3_object_tags: Optional[bool] = Field(
         None,
-        description="# Whether or not to create tags in datahub from the s3 object",
+        description="Whether or not to create tags in datahub from the s3 object",
     )
 
     # Whether to update the table schema when schema in files within the partitions are updated