Docs: Updated getting started Docs (#17891)
* Docs: Updating Getting Started Collate Docs * Docs: Updating Getting Started Collate Docs * Docs: Updating Getting Started Collate Docs --------- Co-authored-by: Prajwal Pandit <prajwalpandit@Prajwals-MacBook-Air.local>
@ -13,7 +13,6 @@ You can easily set up a database service for metadata extraction from Collate Sa
|
||||
{% image
|
||||
src="/images/v1.5/getting-started/add-service.png"
|
||||
alt="Adding Database Service"
|
||||
height="500px"
|
||||
caption="Adding Database Service" /%}
|
||||
|
||||
2. **Select the database type** you want to use. Enter details such as the name and description to identify the database. In this Case we are selecting `Snowflake`.
|
||||
@ -21,7 +20,6 @@ You can easily set up a database service for metadata extraction from Collate Sa
|
||||
{% image
|
||||
src="/images/v1.5/getting-started/select-service.png"
|
||||
alt="Selecting Database Service"
|
||||
height="850px"
|
||||
caption="Selecting Database Service" /%}
|
||||
|
||||
4. **Enter the Connection Details** You can view the available documentation in the side panel for guidance. Also, refer to the connector [documentation](/connectors).
|
||||
@ -29,7 +27,6 @@ You can easily set up a database service for metadata extraction from Collate Sa
|
||||
{% image
|
||||
src="/images/v1.5/getting-started/configure-connector.png"
|
||||
alt="Updating Connection Details"
|
||||
height="950px"
|
||||
caption="Updating Connection Details" /%}
|
||||
|
||||
5. **Allow the Collate SaaS IP**. In the Connection Details, you will see the IP Address unique to your cluster, You need to Allow the `IP` to Access the datasource.
|
||||
@ -42,7 +39,6 @@ This step is required only for Collate SaaS. If you are using Hybrid SaaS, you w
|
||||
{% image
|
||||
src="/images/v1.5/getting-started/collate-saas-ip.png"
|
||||
alt="Collate SaaS IP"
|
||||
height="200px"
|
||||
caption="Collate SaaS IP" /%}
|
||||
|
||||
6. **Test the connection** to verify the status. The test connection will check if the Service is reachable from Collate.
|
||||
@ -50,5 +46,12 @@ This step is required only for Collate SaaS. If you are using Hybrid SaaS, you w
|
||||
{% image
|
||||
src="/images/v1.5/getting-started/test-connection.png"
|
||||
alt="Verifying the Test Connection"
|
||||
height="350px"
|
||||
caption="Verifying the Test Connection" /%}
|
||||
caption="Verifying the Test Connection" /%}
|
||||
|
||||
{%inlineCallout
|
||||
color="violet-70"
|
||||
bold="Explore Hybrid SaaS"
|
||||
icon="MdArrowForward"
|
||||
href="/getting-started/day-1/hybrid-saas"%}
|
||||
You can read more about Hybrid SaaS.
|
||||
{%/inlineCallout%}
|
@ -48,12 +48,35 @@ There's two options on how to set up a data connector:
|
||||
Once the connector has been added, set up a [metadata ingestion pipeline](/how-to-guides/admin-guide/how-to-ingest-metadata)
|
||||
to bring in the metadata into Collate at a regular schedule.
|
||||
|
||||
- Go to **Settings > Services > Databases** and click on the service you have added.
|
||||
- Navigate to the Ingestion tab to **Add Metadata Ingestion**.
|
||||
- Go to **Settings > Services > Databases** and click on the service you have added. Navigate to the Ingestion tab to **Add Metadata Ingestion**.
|
||||
|
||||
{% image
|
||||
src="/images/v1.5/getting-started/add-ingestion.png"
|
||||
alt="Adding Ingestion"
|
||||
caption="Adding Ingestion" /%}
|
||||
|
||||
- Make any necessary configuration changes or filters for the ingestion, with documentation available in the side panel.
|
||||
|
||||
{% image
|
||||
src="/images/v1.5/getting-started/ingestion-config.png"
|
||||
alt="Configure Ingestion"
|
||||
caption="Configure Ingestion" /%}
|
||||
|
||||
- Schedule the pipeline to ingest metadata regularly.
|
||||
|
||||
{% image
|
||||
src="/images/v1.5/getting-started/schedule-ingesgtion.png"
|
||||
alt="Schedule Ingestion"
|
||||
caption="Schedule Ingestion" /%}
|
||||
|
||||
- Once scheduled, you can also set up additional ingestion pipelines to bring in lineage, profiler, or dbt information.
|
||||
- Once the metadata ingestion has been completed, you can see the available data assets under **Explore** in the main menu.
|
||||
|
||||
{% image
|
||||
src="/images/v1.5/getting-started/explore-tab.png"
|
||||
alt="Ingested Data"
|
||||
caption="Ingested Data under Explore Tab" /%}
|
||||
|
||||
- You can repeat these steps to ingest metadata from other data sources.
|
||||
|
||||
## Step 3: Invite Users
|
||||
@ -66,7 +89,6 @@ to collaborate on the data and assign different roles.
|
||||
{% image
|
||||
src="/images/v1.5/getting-started/users.png"
|
||||
alt="Users Navigation"
|
||||
height="300px"
|
||||
caption="Users Navigation" /%}
|
||||
|
||||
- Click on **Add User**, and enter their email and other details to provide access to the platform.
|
||||
@ -80,6 +102,12 @@ to collaborate on the data and assign different roles.
|
||||
- You can organize users into different Teams, as well as assign them to different Roles.
|
||||
- Users will inherit the access defined for their assigned Teams and Roles.
|
||||
- Admin access can also be granted. Admins will have access to all settings and can invite other users.
|
||||
|
||||
{% image
|
||||
src="/images/v1.5/getting-started/update-user.png"
|
||||
alt="Users Profile"
|
||||
caption="Users Profile" /%}
|
||||
|
||||
- New users will receive an email invitation to set up their account.
|
||||
|
||||
## Step 4: Explore Features of OpenMetadata
|
||||
|
BIN
openmetadata-docs/images/v1.5/getting-started/add-ingestion.png
Normal file
After Width: | Height: | Size: 98 KiB |
Before Width: | Height: | Size: 163 KiB After Width: | Height: | Size: 40 KiB |
Before Width: | Height: | Size: 95 KiB After Width: | Height: | Size: 22 KiB |
Before Width: | Height: | Size: 45 KiB After Width: | Height: | Size: 12 KiB |
Before Width: | Height: | Size: 380 KiB After Width: | Height: | Size: 112 KiB |
BIN
openmetadata-docs/images/v1.5/getting-started/explore-tab.png
Normal file
After Width: | Height: | Size: 165 KiB |
After Width: | Height: | Size: 148 KiB |
After Width: | Height: | Size: 75 KiB |
Before Width: | Height: | Size: 189 KiB After Width: | Height: | Size: 47 KiB |
Before Width: | Height: | Size: 79 KiB After Width: | Height: | Size: 21 KiB |
BIN
openmetadata-docs/images/v1.5/getting-started/update-user.png
Normal file
After Width: | Height: | Size: 32 KiB |