yujunjun/datahub
2
0
Fork 0
mirror of https://github.com/datahub-project/datahub.git synced 2025-06-27 05:03:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: add slack utm component in docs (#10214)

Browse Source
This commit is contained in:
Hyejin Yoon 2024-04-30 12:54:54 +09:00 committed by GitHub
parent e3f27c8b91
commit 704ca650ad
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
47 changed files with 53 additions and 66 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -28,7 +28,7 @@ HOSTED_DOCS_ONLY-->
[![PyPI version](https://badge.fury.io/py/acryl-datahub.svg)](https://badge.fury.io/py/acryl-datahub)
[![build & test](https://github.com/datahub-project/datahub/workflows/build%20&%20test/badge.svg?branch=master&event=push)](https://github.com/datahub-project/datahub/actions?query=workflow%3A%22build+%26+test%22+branch%3Amaster+event%3Apush)
[![Docker Pulls](https://img.shields.io/docker/pulls/acryldata/datahub-gms.svg)](https://hub.docker.com/r/acryldata/datahub-gms)
[![Slack](https://img.shields.io/badge/slack-join_chat-white.svg?logo=slack&style=social)](https://slack.datahubproject.io)
[![Slack](https://img.shields.io/badge/slack-join_chat-white.svg?logo=slack&style=social)](https://datahubproject.io/slack?utm_source=docs&utm_medium=docs&utm_campaign=docs_page_link)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/datahub-project/datahub/blob/master/docs/CONTRIBUTING.md)
[![GitHub commit activity](https://img.shields.io/github/commit-activity/m/datahub-project/datahub)](https://github.com/datahub-project/datahub/pulls?q=is%3Apr)
[![License](https://img.shields.io/github/license/datahub-project/datahub)](https://github.com/datahub-project/datahub/blob/master/LICENSE)
@ -106,7 +106,7 @@ We welcome contributions from the community. Please refer to our [Contributing G
## Community
Join our [Slack workspace](https://slack.datahubproject.io) for discussions and important announcements. You can also find out more about our upcoming [town hall meetings](docs/townhalls.md) and view past recordings.
Join our [Slack workspace](https://datahubproject.io/slack?utm_source=docs&utm_medium=docs&utm_campaign=docs_page_link) for discussions and important announcements. You can also find out more about our upcoming [town hall meetings](docs/townhalls.md) and view past recordings.
## Adoption

17
docs-website/src/components/SlackUtm/index.js Normal file
View File

@ -0,0 +1,17 @@
import React, { useState, useMemo } from "react";
import styles from "./styles.module.scss";
import { LikeOutlined, DislikeOutlined, CheckCircleOutlined } from "@ant-design/icons";
import { v4 as uuidv4 } from "uuid";
const SlackUtm = ({ pageId }) => {
return (
<div className={styles.slackUtm}>
<div className={styles.slackUtm}>
<hr />
Need more help? Join the conversation in <a href={`https://datahubproject.io/slack?utm_source=docs&utm_medium=footer&utm_campaign=docs_footer&utm_content=${pageId}`}>Slack!</a>
</div>
</div>
);
};
export default SlackUtm;

3
docs-website/src/components/SlackUtm/styles.module.scss Normal file
View File

@ -0,0 +1,3 @@
.slackUtm {
padding: 0.5rem 0rem;
}

2
docs-website/src/theme/DocItem/Footer/index.js
View File

@ -7,6 +7,7 @@ import EditThisPage from "@theme/EditThisPage";
import TagsListInline from "@theme/TagsListInline";
import styles from "./styles.module.css";
import Feedback from "../../../components/Feedback";
import SlackUtm from "../../../components/SlackUtm";
function TagsRow(props) {
return (
@ -42,6 +43,7 @@ export default function DocItemFooter() {
return (
<>
<footer className={clsx(ThemeClassNames.docs.docFooter, "docusaurus-mt-lg")}>
<SlackUtm pageId={unversionedId}/>
{canDisplayTagsRow && <TagsRow tags={tags} />}
{canDisplayEditMetaRow && (
<EditMetaRow

2
docs/_feature-guide-template.md
View File

@ -76,7 +76,7 @@ Response in plain text
-->
*Need more help? Join the conversation in [Slack](http://slack.datahubproject.io)!*
### Related Features

2
docs/act-on-metadata/impact-analysis.md
View File

@ -88,7 +88,7 @@ This means you have not yet ingested Lineage metadata for that entity. Please se
We currently limit the list of dependencies to 10,000 records; we suggest applying filters to narrow the result set if you hit that limit.
*Need more help? Join the conversation in [Slack](http://slack.datahubproject.io)!*
### Related Features

2
docs/actions/sources/kafka-event-source.md
View File

@ -90,4 +90,4 @@ messages that are received while the Action is running.
2. Is there a way to asynchronously commit offsets back to Kafka?
Currently, all consumer offset commits are made synchronously for each message received. For now we've optimized for correctness over performance. If this commit policy does not accommodate your organization's needs, certainly reach out on [Slack](https://slack.datahubproject.io/).
Currently, all consumer offset commits are made synchronously for each message received. For now we've optimized for correctness over performance.

2
docs/api/graphql/getting-started.md
View File

@ -153,5 +153,3 @@ With the following error codes officially supported:
| 404 | NOT_FOUND | The resource is not found. |
| 500 | SERVER_ERROR | An internal error has occurred. Check your server logs or contact your DataHub administrator. |
> Visit our [Slack channel](https://slack.datahubproject.io) to ask questions, tell us what we can do better, & make requests for what you'd like to see in the future. Or just
> stop by to say 'Hi'.

3
docs/api/graphql/overview.md
View File

@ -38,6 +38,3 @@ that may be performed using the API.
- Available Operations: [Queries](/graphql/queries.md) (Reads) & [Mutations](/graphql/mutations.md) (Writes)
- Schema Types: [Objects](/graphql/objects.md), [Input Objects](/graphql/inputObjects.md), [Interfaces](/graphql/interfaces.md), [Unions](/graphql/unions.md), [Enums](/graphql/enums.md), [Scalars](/graphql/scalars.md)
> Visit our [Slack channel](https://slack.datahubproject.io) to ask questions, tell us what we can do better, & make requests for what you'd like to see in the future. Or just
> stop by to say 'Hi'.

3
docs/api/graphql/token-management.md
View File

@ -131,6 +131,3 @@ curl --location --request POST 'http://localhost:8080/api/graphql' \
```
This endpoint will return a boolean detailing whether the operation was successful. In case of failure, an error message will appear explaining what went wrong.
> Visit our [Slack channel](https://slack.datahubproject.io) to ask questions, tell us what we can do better, & make requests for what you'd like to see in the future. Or just
> stop by to say 'Hi'.

2
docs/authentication/personal-access-tokens.md
View File

@ -108,5 +108,5 @@ A PAT represents a user in DataHub, if that user does not have permissions for a
Yes, although not through the UI correctly, you will have to use the [token management graphQL API](../api/graphql/token-management.md) and the user making the request must have `Manage All Access Tokens` permissions.
*Need more help? Join the conversation in [Slack](http://slack.datahubproject.io)!*

4
docs/authorization/access-policies-guide.md
View File

@ -250,8 +250,6 @@ The common Metadata Privileges, which span across entity types, include:
| Term Group | Manage All Glossary Children | Allow actor to change any direct or indirect child Term Groups or Terms of the group. |
> **Still have questions about Privileges?** Let us know in [Slack](https://slack.datahubproject.io)!
#### Step 3: Choose Policy Actors
@ -355,7 +353,7 @@ Policies are the lowest level primitive for granting Privileges to users on Data
Roles are built for convenience on top of Policies. Roles grant Privileges to actors indirectly, driven by Policies
behind the scenes. Both can be used in conjunction to grant Privileges to end users.
*Need more help? Join the conversation in [Slack](http://slack.datahubproject.io)!*
### Related Features

2
docs/dataproducts.md
View File

@ -145,4 +145,4 @@ The following features are next on the roadmap for Data Products
* [Tags](./tags.md)
*Need more help? Join the conversation in [Slack](http://slack.datahubproject.io)!*

2
docs/domains.md
View File

@ -252,7 +252,7 @@ DataHub supports Tags, Glossary Terms, & Domains as distinct types of Metadata t
- **Tags**: Informal, loosely controlled labels that serve as a tool for search & discovery. Assets may have multiple tags. No formal, central management.
- **Glossary Terms**: A controlled vocabulary, with optional hierarchy. Terms are typically used to standardize types of leaf-level attributes (i.e. schema fields) for governance. E.g. (EMAIL_PLAINTEXT)
- **Domains**: A set of top-level categories. Usually aligned to business units / disciplines to which the assets are most relevant. Central or distributed management. Single Domain assignment per data asset.
*Need more help? Join the conversation in [Slack](http://slack.datahubproject.io)!*
### Related Features

2
docs/features/dataset-usage-and-query-history.md
View File

@ -74,4 +74,4 @@ With the collected usage data, you can even see column-level usage statistics (R
Queries/Stats tab is greyed out if there is no usage statistics for that dataset or there were no ingestion with usage extraction run before.
*Need more help? Join the conversation in [Slack](http://slack.datahubproject.io)!*

2
docs/how/search.md
View File

@ -482,7 +482,7 @@ Response in plain text
-->
*Need more help? Join the conversation in [Slack](http://slack.datahubproject.io)!*
### Related Features

2
docs/ownership/ownership-types.md
View File

@ -178,4 +178,4 @@ To remove ownership from an asset, click the 'x' icon on the Owner label.
> by a [Policy](./../authorization/policies.md).
*Need more help? Join the conversation in [Slack](http://slack.datahubproject.io)!*

4
docs/posts.md
View File

@ -117,7 +117,3 @@ mutation deletePosting {
)
}
```
## FAQ and Troubleshooting
*Need more help with Posts? Join the conversation in [Slack](http://slack.datahubproject.io)! Please post in the **#ui** channel!*

2
docs/quick-ingestion-guides/bigquery/configuration.md
View File

@ -147,4 +147,4 @@ You will now find your new ingestion source running
**Congratulations!** You've successfully set up BigQuery as an ingestion source for DataHub!
*Need more help? Join the conversation in [Slack](http://slack.datahubproject.io)!*

2
docs/quick-ingestion-guides/bigquery/overview.md
View File

@ -34,4 +34,4 @@ If you're looking to do something more in-depth, want to use CLI instead of the
* Learn about CLI Ingestion in the [Introduction to Metadata Ingestion](../../../metadata-ingestion/README.md)
* [BigQuery Ingestion Reference Guide](https://datahubproject.io/docs/generated/ingestion/sources/bigquery/#module-bigquery)
*Need more help? Join the conversation in [Slack](http://slack.datahubproject.io)!*

2
docs/quick-ingestion-guides/bigquery/setup.md
View File

@ -61,4 +61,4 @@ The key file looks like this:
Once you've confirmed all of the above in BigQuery, it's time to [move on](configuration.md) to configure the actual ingestion source within the DataHub UI.
*Need more help? Join the conversation in [Slack](http://slack.datahubproject.io)!*

2
docs/quick-ingestion-guides/looker/configuration.md
View File

@ -209,4 +209,4 @@ Pick an entity from the list to manually validate if it contains the detail you
**Congratulations!** You've successfully set up Looker & LookML as an ingestion source for DataHub!
*Need more help? Join the conversation in [Slack](http://slack.datahubproject.io)!*

2
docs/quick-ingestion-guides/looker/overview.md
View File

@ -49,4 +49,4 @@ If you want to ingest metadata from Looker using the DataHub CLI, check out the
* Learn about CLI Ingestion in the [Introduction to Metadata Ingestion](../../../metadata-ingestion/README.md)
* [Looker Ingestion Source](https://datahubproject.io/docs/generated/ingestion/sources/Looker)
*Need more help? Join the conversation in [Slack](http://slack.datahubproject.io)!*

1
docs/quick-ingestion-guides/looker/setup.md
View File

@ -154,4 +154,3 @@ Make a note of the private key file. You must paste the file's contents into the
Once you've done all the above steps, it's time to move on to [configuring the actual ingestion source](configuration.md) within DataHub.
_Need more help? Join the conversation in [Slack](http://slack.datahubproject.io)!_

1
docs/quick-ingestion-guides/powerbi/configuration.md
View File

@ -159,4 +159,3 @@ You will now find your new ingestion source running
**Congratulations!** You've successfully set up PowerBI as an ingestion source for DataHub!
*Need more help? Join the conversation in [Slack](http://slack.datahubproject.io)!*

1
docs/quick-ingestion-guides/powerbi/overview.md
View File

@ -30,4 +30,3 @@ If you want to ingest metadata from PowerBI using the DataHub CLI, check out the
* Learn about CLI Ingestion in the [Introduction to Metadata Ingestion](../../../metadata-ingestion/README.md)
* [PowerBI Ingestion Source](https://datahubproject.io/docs/generated/ingestion/sources/powerbi)
*Need more help? Join the conversation in [Slack](http://slack.datahubproject.io)!*

2
docs/quick-ingestion-guides/powerbi/setup.md
View File

@ -80,4 +80,4 @@ In order to configure ingestion from PowerBI, you'll first have to ensure you ha
Once you've done all of the above steps, it's time to [move on](configuration.md) to configuring the actual ingestion source within DataHub.
_Need more help? Join the conversation in [Slack](http://slack.datahubproject.io)!_

2
docs/quick-ingestion-guides/redshift/configuration.md
View File

@ -133,4 +133,4 @@ You will now find your new ingestion source running
**Congratulations!** You've successfully set up Redshift as an ingestion source for DataHub!
*Need more help? Join the conversation in [Slack](http://slack.datahubproject.io)!*

2
docs/quick-ingestion-guides/redshift/overview.md
View File

@ -35,4 +35,4 @@ If you're looking to do something more in-depth, want to use CLI instead of the
* Learn about CLI Ingestion in the [Introduction to Metadata Ingestion](../../../metadata-ingestion/README.md)
* [Redshift Ingestion Reference Guide](https://datahubproject.io/docs/generated/ingestion/sources/redshift/#module-redshift)
*Need more help? Join the conversation in [Slack](http://slack.datahubproject.io)!*

2
docs/quick-ingestion-guides/redshift/setup.md
View File

@ -32,4 +32,4 @@ GRANT SELECT ON pg_catalog.svl_user_info to datahub;
Once you've confirmed all of the above in Redshift, it's time to [move on](configuration.md) to configure the actual ingestion source within the DataHub UI.
*Need more help? Join the conversation in [Slack](http://slack.datahubproject.io)!*

1
docs/quick-ingestion-guides/snowflake/configuration.md
View File

@ -142,4 +142,3 @@ You will now find your new ingestion source running
**Congratulations!** You've successfully set up Snowflake as an ingestion source for DataHub!
*Need more help? Join the conversation in [Slack](http://slack.datahubproject.io)!*

1
docs/quick-ingestion-guides/snowflake/overview.md
View File

@ -45,4 +45,3 @@ If you want to ingest metadata from Snowflake using the DataHub CLI, check out t
* Learn about CLI Ingestion in the [Introduction to Metadata Ingestion](../../../metadata-ingestion/README.md)
* [Snowflake Ingestion Source](https://datahubproject.io/docs/generated/ingestion/sources/snowflake/#module-snowflake)
*Need more help? Join the conversation in [Slack](http://slack.datahubproject.io)!*

2
docs/quick-ingestion-guides/snowflake/setup.md
View File

@ -67,4 +67,4 @@ In order to configure ingestion from Snowflake, you'll first have to ensure you
Once you've done all of the above in Snowflake, it's time to [move on](configuration.md) to configuring the actual ingestion source within DataHub.
*Need more help? Join the conversation in [Slack](http://slack.datahubproject.io)!*

1
docs/quick-ingestion-guides/tableau/configuration.md
View File

@ -149,4 +149,3 @@ You will now find your new ingestion source running
**Congratulations!** You've successfully set up Tableau as an ingestion source for DataHub!
*Need more help? Join the conversation in [Slack](http://slack.datahubproject.io)!*

1
docs/quick-ingestion-guides/tableau/overview.md
View File

@ -35,4 +35,3 @@ If you want to ingest metadata from Tableau using the DataHub CLI, check out the
* Learn about CLI Ingestion in the [Introduction to Metadata Ingestion](../../../metadata-ingestion/README.md)
* [Tableau Ingestion Source](https://datahubproject.io/docs/generated/ingestion/sources/tableau)
*Need more help? Join the conversation in [Slack](http://slack.datahubproject.io)!*

1
docs/quick-ingestion-guides/tableau/setup.md
View File

@ -56,4 +56,3 @@ In order to configure ingestion from Tableau, you'll first have to enable Tablea
Once you've done all of the above in Tableau, it's time to [move on](configuration.md) to configuring the actual ingestion source within DataHub.
*Need more help? Join the conversation in [Slack](http://slack.datahubproject.io)!*

2
docs/slack.md
View File

@ -2,7 +2,7 @@
The DataHub Slack is a thriving and rapidly growing community - we can't wait for you to join us!
_[Sign up here](https://slack.datahubproject.io) to join us on Slack and to subscribe to the DataHub Community newsletter. Already a member? [Log in here](https://slack.datahubproject.io)._
_[Sign up here](https://datahubproject.io/slack?utm_source=docs&utm_medium=docs&utm_campaign=docs_page_link) to join us on Slack and to subscribe to the DataHub Community newsletter. Already a member? [Log in here](https://datahubproject.io/slack?utm_source=docs&utm_medium=docs&utm_campaign=docs_page_link)._
## Slack Guidelines

2
docs/sync-status.md
View File

@ -43,4 +43,4 @@ You can hover over the sync status message in the UI to view the exact timestamp
<img width="70%" src="https://raw.githubusercontent.com/datahub-project/static-assets/master/imgs/sync-status-hover-card.png"/>
</p>
_Need more help? Join the conversation in [Slack](http://slack.datahubproject.io)!_

2
docs/tags.md
View File

@ -103,7 +103,7 @@ Usage and applications:
Domains are a set of top-level categories usually aligned to business units/disciplines to which the assets are most relevant. They rely on central or distributed management. A single domain is assigned per data asset.
*Need more help? Join the conversation in [Slack](http://slack.datahubproject.io)!*
### Related Features

2
docs/tests/metadata-tests.md
View File

@ -265,4 +265,4 @@ a Metadata Test may verify that ALL tables in Snowflake have at least 1 assigned
Metadata Tests allow you to manage broad policies across your entire data ecosystem driven by metadata, for example to
augment a larger scale Data Governance initiative.
_Need more help? Join the conversation in [Slack](http://slack.datahubproject.io)!_

9
docs/troubleshooting/quickstart.md
View File

@ -67,15 +67,6 @@ docker system prune
</details>
<details>
<summary>
Still stuck?
</summary>
Hop over to our [Slack community](https://slack.datahubproject.io) and ask for help in the [#troubleshoot](https://datahubspace.slack.com/archives/C029A3M079U) channel!
</details>
## How can I confirm if all Docker containers are running as expected after a quickstart?
If you set up the `datahub` CLI tool (see [here](../../metadata-ingestion/README.md)), you can use the built-in check utility:

2
metadata-ingestion/docs/dev_guides/profiling_ingestions.md
View File

@ -91,4 +91,4 @@ This will generate an interactive HTML file for analysis:
## Questions
If you've got any questions on configuring profiling, feel free to ping us on [our Slack](https://slack.datahubproject.io/)!
If you've got any questions on configuring profiling, feel free to ping us on [our Slack](https://datahubproject.io/slack?utm_source=docs&utm_medium=docs&utm_campaign=docs_page_link)!

2
metadata-ingestion/docs/dev_guides/sql_profiles.md
View File

@ -30,4 +30,4 @@ SQL profiling is supported for all SQL sources. Check the individual source page
## Questions
If you've got any questions on configuring profiling, feel free to ping us on [our Slack](https://slack.datahubproject.io/)!
If you've got any questions on configuring profiling, feel free to ping us on [our Slack](https://datahubproject.io/slack?utm_source=docs&utm_medium=docs&utm_campaign=docs_page_link)!

2
metadata-ingestion/docs/sources/hana/hana.md
View File

@ -7,4 +7,4 @@ Under the hood, [SQLAlchemy Dialect for SAP HANA](https://github.com/SAP/sqlalch
## Questions
If you've got any questions on configuring this source, feel free to ping us on [our Slack](https://slack.datahubproject.io/)!
If you've got any questions on configuring this source, feel free to ping us on [our Slack](https://datahubproject.io/slack?utm_source=docs&utm_medium=docs&utm_campaign=docs_page_link)!

2
metadata-ingestion/sink_docs/console.md
View File

@ -30,4 +30,4 @@ None!
## Questions
If you've got any questions on configuring this sink, feel free to ping us on [our Slack](https://slack.datahubproject.io/)!
If you've got any questions on configuring this sink, feel free to ping us on [our Slack](https://datahubproject.io/slack?utm_source=docs&utm_medium=docs&utm_campaign=docs_page_link)!

4
metadata-ingestion/sink_docs/datahub.md
View File

@ -179,7 +179,3 @@ Note that a `.` is used to denote nested fields in the YAML recipe.
| `file` | | `"~/.datahub/lite/datahub.duckdb"` | File to use for DuckDB storage |
| `options` | | `{}` | Options dictionary to pass through to DuckDB library. See [the official spec](https://duckdb.org/docs/sql/configuration.html) for the options supported by DuckDB. |
## Questions
If you've got any questions on configuring this sink, feel free to ping us on [our Slack](https://slack.datahubproject.io/)!

2
metadata-ingestion/sink_docs/file.md
View File

@ -38,4 +38,4 @@ Note that a `.` is used to denote nested fields in the YAML recipe.
## Questions
If you've got any questions on configuring this sink, feel free to ping us on [our Slack](https://slack.datahubproject.io/)!
If you've got any questions on configuring this sink, feel free to ping us on [our Slack](https://datahubproject.io/slack?utm_source=docs&utm_medium=docs&utm_campaign=docs_page_link)!