Skip to content

Commit

Permalink
docs: standardize terminology to DataHub Cloud (#11003)
Browse files Browse the repository at this point in the history
  • Loading branch information
yoonhyejin authored Jul 30, 2024
1 parent 1c4c858 commit a6eb1f4
Show file tree
Hide file tree
Showing 56 changed files with 129 additions and 129 deletions.
2 changes: 1 addition & 1 deletion datahub-graphql-core/src/main/resources/app.graphql
Original file line number Diff line number Diff line change
Expand Up @@ -469,7 +469,7 @@ type FeatureFlagsConfig {
platformBrowseV2: Boolean!

"""
Whether we should show CTAs in the UI related to moving to Managed DataHub by Acryl.
Whether we should show CTAs in the UI related to moving to DataHub Cloud by Acryl.
"""
showAcrylInfo: Boolean!
"""
Expand Down
2 changes: 1 addition & 1 deletion datahub-graphql-core/src/main/resources/entity.graphql
Original file line number Diff line number Diff line change
Expand Up @@ -890,7 +890,7 @@ type Mutation {
"""
Creates a filter for a form to apply it to certain entities. Entities that match this filter will have
a given form applied to them.
This feature is ONLY supported in Acryl DataHub.
This feature is ONLY supported in DataHub Cloud.
"""
createDynamicFormAssignment(input: CreateDynamicFormAssignmentInput!): Boolean

Expand Down
4 changes: 2 additions & 2 deletions datahub-web-react/src/app/home/AcrylDemoBanner.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ export default function AcrylDemoBanner() {
<BannerWrapper>
<Logo src={AcrylLogo} />
<TextWrapper>
<Title>Schedule a Demo of Managed DataHub</Title>
<Title>Schedule a Demo of DataHub Cloud</Title>
<TextContent>
DataHub is already the industry&apos;s #1 Open Source Data Catalog.{' '}
<StyledLink
Expand All @@ -52,7 +52,7 @@ export default function AcrylDemoBanner() {
>
Schedule a demo
</StyledLink>{' '}
of Acryl DataHub to see the advanced features that take it to the next level or purchase Acryl Cloud
of DataHub Cloud to see the advanced features that take it to the next level or purchase DataHub Cloud
on{' '}
<StyledLink
href="https://aws.amazon.com/marketplace/pp/prodview-ratzv4k453pck?sr=0-1&ref_=beagle&applicationId=AWSMPContessa"
Expand Down
6 changes: 3 additions & 3 deletions docs-website/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,12 @@ Please use the following steps when adding/managing content for the docs site.
- [Feature Guide Template](../docs/_feature-guide-template.md)
- [Metadata Ingestion Source Template](../metadata-ingestion/source-docs-template.md)

### Self-Hosted vs. Managed DataHub
### Self-Hosted vs. DataHub Cloud

The docs site includes resources for both self-hosted (aka open-source) DataHub and Managed DataHub alike.
The docs site includes resources for both self-hosted (aka open-source) DataHub and DataHub Cloud alike.

- All Feature Guides should include the `FeatureAvailability` component within the markdown file itself
- Features only available via Managed DataHub should have the `saasOnly` class if they are included in `sidebar.js` to display the small "cloud" icon:
- Features only available via DataHub Cloud should have the `saasOnly` class if they are included in `sidebar.js` to display the small "cloud" icon:

```
{
Expand Down
2 changes: 1 addition & 1 deletion docs-website/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ module.exports = {
announcementBar: {
id: "announcement",
content:
'<div><img src="/img/acryl-logo-white-mark.svg" /><p><strong>Acryl DataHub</strong><span> &nbsp;Acryl Data delivers an easy to consume DataHub platform for the enterprise</span></p></div> <a href="https://www.acryldata.io/datahub-sign-up?utm_source=datahub&utm_medium=referral&utm_campaign=acryl_signup" target="_blank" class="button button--primary">Sign Up for Acryl DataHub&nbsp;→</a>',
'<div><img src="/img/acryl-logo-white-mark.svg" /><p><strong>DataHub Cloud</strong><span> &nbsp;Acryl Data delivers an easy to consume DataHub platform for the enterprise</span></p></div> <a href="https://www.acryldata.io/datahub-sign-up?utm_source=datahub&utm_medium=referral&utm_campaign=acryl_signup" target="_blank" class="button button--primary">Sign Up for DataHub Cloud&nbsp;→</a>',
backgroundColor: "#070707",
textColor: "#ffffff",
isCloseable: false,
Expand Down
2 changes: 1 addition & 1 deletion docs-website/filterTagIndexes.json
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@
"Path": "docs/generated/ingestion/sources/datahub",
"imgPath": "img/acryl-logo-light-mark.png",
"Title": "DataHub",
"Description": "Integrate your open source DataHub instance with Acryl Cloud or other on-prem DataHub instances",
"Description": "Integrate your open source DataHub instance with DataHub Cloud or other on-prem DataHub instances",
"tags": {
"Platform Type": "Metadata",
"Connection Type": "Pull",
Expand Down
2 changes: 1 addition & 1 deletion docs-website/generateDocsDir.ts
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ const hardcoded_titles = {
"docs/actions/README.md": "Introduction",
"docs/actions/concepts.md": "Concepts",
"docs/actions/quickstart.md": "Quickstart",
"docs/saas.md": "Managed DataHub",
"docs/saas.md": "DataHub Cloud",
};
// titles that have been hardcoded in sidebars.js
// (for cases where doc is reference multiple times with different titles)
Expand Down
4 changes: 2 additions & 2 deletions docs-website/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ module.exports = {
],
},
{
label: "Managed DataHub",
label: "DataHub Cloud",
type: "category",
collapsed: true,
link: {
Expand Down Expand Up @@ -280,7 +280,7 @@ module.exports = {
className: "saasOnly",
},
{
"Managed DataHub Release History": [
"DataHub Cloud Release History": [
"docs/managed-datahub/release-notes/v_0_3_4",
"docs/managed-datahub/release-notes/v_0_3_3",
"docs/managed-datahub/release-notes/v_0_3_2",
Expand Down
2 changes: 1 addition & 1 deletion docs-website/src/components/FeatureAvailability/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ const FeatureAvailability = ({ saasOnly, ossOnly }) => (
<div>
<CloudOutlined className={styles.managedIcon} />
<span className={clsx(styles.platform, !ossOnly && styles.platformAvailable)}>
Managed DataHub {ossOnly ? <CloseCircleFilled /> : <CheckCircleFilled />}
DataHub Cloud {ossOnly ? <CloseCircleFilled /> : <CheckCircleFilled />}
</span>
</div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs-website/src/learn/business-glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ Some companies use manual methods to track data terminology and manage access re

### Our Solution

Acryl DataHub offers comprehensive features designed to support the authoring of a unified business glossary for your organization:
DataHub Cloud offers comprehensive features designed to support the authoring of a unified business glossary for your organization:

<p align="center">
<img width="80%" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/blogs/glossary-terms/business-glossary-center.png"/>
Expand Down
2 changes: 1 addition & 1 deletion docs-website/src/learn/business-metric.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Some companies try to align metric definitions through emails and meetings. Whil

### Our Solution

Acryl DataHub offers comprehensive features designed to tackle the challenges of defining and standardizing business metrics:
DataHub Cloud offers comprehensive features designed to tackle the challenges of defining and standardizing business metrics:

<p align="center">
<img width="80%" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/blogs/glossary-terms/business-glossary-center.png"/>
Expand Down
2 changes: 1 addition & 1 deletion docs-website/src/learn/data-freshness.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ DataHub offers comprehensive features designed to tackle data freshness challeng
</p>


**Freshness Monitoring & Alerting:** Automatically detect and alert when data freshness issues occur, to ensure timely updates by proactively monitoring key datasets for updates. Check out [Assertions](https://datahubproject.io/docs/managed-datahub/observe/assertions) and [Freshness Assertions](https://datahubproject.io/docs/managed-datahub/observe/freshness-assertions), Available in **Acryl Managed DataHub Only.**
**Freshness Monitoring & Alerting:** Automatically detect and alert when data freshness issues occur, to ensure timely updates by proactively monitoring key datasets for updates. Check out [Assertions](https://datahubproject.io/docs/managed-datahub/observe/assertions) and [Freshness Assertions](https://datahubproject.io/docs/managed-datahub/observe/freshness-assertions), Available in **DataHub Cloud Only.**

<p align="center">
<img width="80%" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/blogs/data-freshness/freshness-assertions.png"/>
Expand Down
6 changes: 3 additions & 3 deletions docs-website/src/learn/data-mesh.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ While a centralized data lake or warehouse can simplify data governance by virtu

### Our Solution

Acryl DataHub offers a comprehensive set of features designed to support the implementation of a Data Mesh at your organization:
DataHub Cloud offers a comprehensive set of features designed to support the implementation of a Data Mesh at your organization:

- **[Data Domains](https://datahubproject.io/docs/domains)**: Clearly define and manage data products within each business unit.
- **[Data Products](https://datahubproject.io/docs/dataproducts):** Ensure each domain owns and manages its data products, promoting autonomy and agility.
Expand All @@ -100,7 +100,7 @@ Acryl DataHub offers a comprehensive set of features designed to support the imp
<p align="center">
<img width="80%" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/blogs/data-mesh/data-contract.png"/>
<br />
<i style={{color:"grey"}}>Data Contracts in Acryl DataHub UI</i>
<i style={{color:"grey"}}>Data Contracts in DataHub Cloud UI</i>
</p>


Expand Down Expand Up @@ -128,4 +128,4 @@ By implementing these solutions, you can effectively manage decentralized data,

## Conclusion

Implementing a Data Mesh can significantly improve your organization's ability to manage and leverage decentralized data. By understanding the benefits of data mesh and following best practices for implementation, you can overcome the limitations of centralized data systems and enhance your agility, scalability, and ability to generate insights. Acryl DataHub was built from the ground up to help you achieve this, providing the tools and features necessary to implement a large-scale Data Mesh successfully.
Implementing a Data Mesh can significantly improve your organization's ability to manage and leverage decentralized data. By understanding the benefits of data mesh and following best practices for implementation, you can overcome the limitations of centralized data systems and enhance your agility, scalability, and ability to generate insights. DataHub Cloud was built from the ground up to help you achieve this, providing the tools and features necessary to implement a large-scale Data Mesh successfully.
2 changes: 1 addition & 1 deletion docs-website/src/learn/data-pipeline.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ Some companies resort to manual debugging or use communication tools like Slack

### Our Solution

Acryl DataHub offers comprehensive features designed to optimize data pipelines:
DataHub Cloud offers comprehensive features designed to optimize data pipelines:

<p align="center">
<img width="80%" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/blogs/data-pipeline/lineage-tracking.png"/>
Expand Down
4 changes: 2 additions & 2 deletions docs-website/src/pages/_components/Section/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ const PromoSection = () => (
<section className={clsx(styles.section, styles.promoSection)}>
<div className="container">
<img src={useBaseUrl("/img/acryl-logo-white-mark.svg")} />
<h2>Managed DataHub</h2>
<p>Acryl Data provides a live demo of Managed DataHub every Tuesday and Thursday</p>
<h2>DataHub Cloud</h2>
<p>Acryl Data provides a live demo of DataHub Cloud every Tuesday and Thursday</p>
<a href="https://www.acryldata.io/weekly-demo-landing-page?utm_source=datahub&utm_medium=referral&utm_campaign=acryl_signup" target="_blank" className="button button--primary button--lg">
Sign up for a live demo →
</a>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ const quickstartContent = [
fontColor: '#091013',
},
{
title: "Learn about Managed DataHub",
title: "Learn about DataHub Cloud",
icon: "acryl-logo-transparent-mark",
to: "managed-datahub/managed-datahub-overview",
color: '#091013',
Expand Down
4 changes: 2 additions & 2 deletions docs/_feature-guide-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ import FeatureAvailability from '@site/src/components/FeatureAvailability';
<!-- All Feature Guides should begin with `About DataHub ` to improve SEO -->

<!--
Update feature availability; by default, feature availabilty is Self-Hosted and Managed DataHub
Update feature availability; by default, feature availabilty is Self-Hosted and DataHub Cloud
Add in `saasOnly` for Managed DataHub-only features
Add in `saasOnly` for DataHub Cloud-only features
-->

<FeatureAvailability/>
Expand Down
4 changes: 2 additions & 2 deletions docs/actions/actions/slack.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,9 +136,9 @@ In the next steps, we'll show you how to configure the Slack Action based on the

### Installation Instructions (Deployment specific)

#### Managed DataHub
#### DataHub Cloud

Head over to the [Configuring Notifications](../../managed-datahub/slack/saas-slack-setup.md#configuring-notifications) section in the Managed DataHub guide to configure Slack notifications for your Managed DataHub instance.
Head over to the [Configuring Notifications](../../managed-datahub/slack/saas-slack-setup.md#configuring-notifications) section in the DataHub Cloud guide to configure Slack notifications for your DataHub Cloud instance.


#### Quickstart
Expand Down
4 changes: 2 additions & 2 deletions docs/api/tutorials/assertions.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import TabItem from '@theme/TabItem';

<FeatureAvailability saasOnly />

This guide specifically covers how to use the Assertion APIs for **Acryl Cloud** native assertions, including:
This guide specifically covers how to use the Assertion APIs for **DataHub Cloud** native assertions, including:

- [Freshness Assertions](/docs/managed-datahub/observe/freshness-assertions.md)
- [Volume Assertions](/docs/managed-datahub/observe/volume-assertions.md)
Expand All @@ -15,7 +15,7 @@ This guide specifically covers how to use the Assertion APIs for **Acryl Cloud**

## Why Would You Use Assertions APIs?

The Assertions APIs allow you to create, schedule, run, and delete Assertions with Acryl Cloud.
The Assertions APIs allow you to create, schedule, run, and delete Assertions with DataHub Cloud.

### Goal Of This Guide

Expand Down
2 changes: 1 addition & 1 deletion docs/api/tutorials/data-contracts.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import TabItem from '@theme/TabItem';

<FeatureAvailability saasOnly />

This guide specifically covers how to use the Data Contract APIs with **Acryl Cloud**.
This guide specifically covers how to use the Data Contract APIs with **DataHub Cloud**.

## Why Would You Use Data Contract APIs?

Expand Down
2 changes: 1 addition & 1 deletion docs/api/tutorials/forms.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ For detailed information, please refer to [Datahub Quickstart Guide](/docs/quick
<Tabs>
<TabItem value="CLI" label="CLI">

Install the relevant CLI version. Forms are available as of CLI version `0.13.1`. The corresponding SaaS release version is `v0.2.16.5`
Install the relevant CLI version. Forms are available as of CLI version `0.13.1`. The corresponding DataHub Cloud release version is `v0.2.16.5`
Connect to your instance via [init](https://datahubproject.io/docs/cli/#init):

1. Run `datahub init` to update the instance you want to load into
Expand Down
2 changes: 1 addition & 1 deletion docs/api/tutorials/operations.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import TabItem from '@theme/TabItem';

The Operations APIs allow you to report operational changes that were made to a given Dataset or Table using the 'Operation' concept.
These operations may be viewed on the Dataset Profile (e.g. as last modified time), accessed via the DataHub GraphQL API, or
used to as inputs to Acryl Cloud [Freshness Assertions](/docs/managed-datahub/observe/freshness-assertions.md).
used as inputs to DataHub Cloud [Freshness Assertions](/docs/managed-datahub/observe/freshness-assertions.md).

### Goal Of This Guide

Expand Down
2 changes: 1 addition & 1 deletion docs/api/tutorials/structured-properties.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Additionally, you need to have the following tools installed according to the me
<Tabs>
<TabItem value="CLI" label="CLI" default>

Install the relevant CLI version. Forms are available as of CLI version `0.13.1`. The corresponding SaaS release version is `v0.2.16.5`
Install the relevant CLI version. Forms are available as of CLI version `0.13.1`. The corresponding DataHub Cloud release version is `v0.2.16.5`
Connect to your instance via [init](https://datahubproject.io/docs/cli/#init):

- Run `datahub init` to update the instance you want to load into.
Expand Down
2 changes: 1 addition & 1 deletion docs/assertions/open-assertions-spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

DataHub is developing an open-source Data Quality Assertions Specification & Compiler that will allow you to declare data quality checks / expectations / assertions using a simple, universal
YAML-based format, and then compile this into artifacts that can be registered or directly executed by 3rd party Data Quality tools like [Snowflake DMFs](https://docs.snowflake.com/en/user-guide/data-quality-intro),
dbt tests, Great Expectations or Acryl Cloud natively.
dbt tests, Great Expectations or DataHub Cloud natively.

Ultimately, our goal is to provide an framework-agnostic, highly-portable format for defining Data Quality checks, making it seamless to swap out the underlying
assertion engine without service disruption for end consumers of the results of these data quality checks in catalogging tools like DataHub.
Expand Down
2 changes: 1 addition & 1 deletion docs/authentication/guides/add-users.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ and many more.

This option is strongly recommended for production deployments of DataHub.

### Managed DataHub
### DataHub Cloud

Single Sign-On can be configured and enabled by navigating to **Settings** > **SSO** > **OIDC**. Note
that a user must have the **Manage Platform Settings** [Platform Privilege](../../authorization/access-policies-guide.md)
Expand Down
6 changes: 3 additions & 3 deletions docs/authorization/policies.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ These privileges are for DataHub operators to access & manage the administrative
| Manage Monitors[^2] | Allow actor to create, update, and delete any data asset monitors, including Custom SQL monitors. Grant with care. |

[^1]: Only active if REST_API_AUTHORIZATION_ENABLED is true
[^2]: Managed DataHub only
[^2]: DataHub Cloud only

##### Common metadata privileges
These privileges are to view & modify any entity within DataHub.
Expand Down Expand Up @@ -143,10 +143,10 @@ These privileges are to view & modify any entity within DataHub.
| Manage Tag Proposals[^2] | Allow actor to manage a proposal to add a tag to an asset. |
| Manage Glossary Term Proposals[^2] | Allow actor to manage a proposal to add a glossary term to an asset. |
| Manage Documentation Proposals[^2] | Allow actor to manage a proposal update an asset's documentation |
| Share Entity[^2] | Allow actor to share an entity with another Acryl instance. |
| Share Entity[^2] | Allow actor to share an entity with another DataHub Cloud instance. |

[^1]: Only active if REST_API_AUTHORIZATION_ENABLED is true
[^2]: Managed DataHub only
[^2]: DataHub Cloud only

##### Specific entity-level privileges
These privileges are not generalizable.
Expand Down
Loading

0 comments on commit a6eb1f4

Please sign in to comment.