Skip to content

chore(docs): update Data Catalog documentation #2047

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 71 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
71 commits
Select commit Hold shift + click to select a range
5cf090f
chore(docs): update Data Catalog documentation
bot-targa Mar 18, 2025
64f2d32
chore(docs): update Data Catalog documentation
bot-targa Mar 19, 2025
4413fdd
chore(docs): update Data Catalog documentation
bot-targa Mar 19, 2025
01a6689
chore(docs): update Data Catalog documentation
bot-targa Mar 20, 2025
28ed12d
chore(docs): update Data Catalog documentation
bot-targa Mar 20, 2025
3d223f0
chore(docs): update Data Catalog documentation
bot-targa Mar 21, 2025
844cf9d
chore(docs): update Data Catalog documentation
bot-targa Mar 21, 2025
f63278b
chore(docs): update Data Catalog documentation
bot-targa Mar 24, 2025
956db5a
chore(docs): update Data Catalog documentation
bot-targa Mar 24, 2025
c76a4c1
chore(docs): update Data Catalog documentation
bot-targa Mar 25, 2025
9048dcd
chore(docs): update Data Catalog documentation
bot-targa Mar 25, 2025
c3417b7
chore(docs): update Data Catalog documentation
bot-targa Mar 26, 2025
15ad2da
chore(docs): update Data Catalog documentation
bot-targa Mar 26, 2025
3320f4b
chore(docs): update Data Catalog documentation
bot-targa Mar 27, 2025
b48eca8
chore(docs): update Data Catalog documentation
bot-targa Mar 27, 2025
fff98b2
chore(docs): update Data Catalog documentation
bot-targa Mar 28, 2025
c3e45e2
chore(docs): update Data Catalog documentation
bot-targa Mar 28, 2025
c1a360a
chore(docs): update Data Catalog documentation
bot-targa Mar 28, 2025
c6a1885
chore(docs): update Data Catalog documentation
bot-targa Mar 28, 2025
9167906
chore(docs): update Data Catalog documentation
bot-targa Mar 28, 2025
f548a29
chore(docs): update Data Catalog documentation
bot-targa Mar 28, 2025
a019150
chore(docs): update Data Catalog documentation
bot-targa Mar 31, 2025
a243700
chore(docs): update Data Catalog documentation
bot-targa Mar 31, 2025
6e2b318
chore(docs): update Data Catalog documentation
bot-targa Apr 1, 2025
0802062
chore(docs): update Data Catalog documentation
bot-targa Apr 1, 2025
7e88bb6
chore(docs): update Data Catalog documentation
bot-targa Apr 2, 2025
10c9562
chore(docs): update Data Catalog documentation
bot-targa Apr 2, 2025
7826c62
chore(docs): update Data Catalog documentation
bot-targa Apr 3, 2025
d547959
chore(docs): update Data Catalog documentation
bot-targa Apr 3, 2025
e21e055
chore(docs): update Data Catalog documentation
bot-targa Apr 4, 2025
c9913bf
chore(docs): update Data Catalog documentation
bot-targa Apr 4, 2025
509c2e1
chore(docs): update Data Catalog documentation
bot-targa Apr 4, 2025
73457ce
chore(docs): update Data Catalog documentation
bot-targa Apr 4, 2025
e3e268f
chore(docs): update Data Catalog documentation
bot-targa Apr 7, 2025
c77d902
chore(docs): update Data Catalog documentation
bot-targa Apr 7, 2025
181be2b
chore(docs): update Data Catalog documentation
bot-targa Apr 8, 2025
6b9c5cd
chore(docs): update Data Catalog documentation
bot-targa Apr 8, 2025
52cc722
chore(docs): update Data Catalog documentation
bot-targa Apr 9, 2025
045a2b8
chore(docs): update Data Catalog documentation
bot-targa Apr 9, 2025
33fe27f
chore(docs): update Data Catalog documentation
bot-targa Apr 10, 2025
9f0d627
chore(docs): update Data Catalog documentation
bot-targa Apr 11, 2025
2604e20
chore(docs): update Data Catalog documentation
bot-targa Apr 11, 2025
1a5239c
chore(docs): update Data Catalog documentation
bot-targa Apr 14, 2025
3b1eb28
chore(docs): update Data Catalog documentation
bot-targa Apr 14, 2025
69e7204
chore(docs): update Data Catalog documentation
bot-targa Apr 15, 2025
8221ca9
chore(docs): update Data Catalog documentation
bot-targa Apr 15, 2025
6d75b89
chore(docs): update Data Catalog documentation
bot-targa Apr 16, 2025
ced0be3
chore(docs): update Data Catalog documentation
bot-targa Apr 16, 2025
76395dd
chore(docs): update Data Catalog documentation
bot-targa Apr 17, 2025
0d0f116
chore(docs): update Data Catalog documentation
bot-targa Apr 17, 2025
7614dbc
chore(docs): update Data Catalog documentation
bot-targa Apr 18, 2025
f203f16
chore(docs): update Data Catalog documentation
bot-targa Apr 21, 2025
2010aa1
chore(docs): update Data Catalog documentation
bot-targa Apr 22, 2025
c711a8d
chore(docs): update Data Catalog documentation
bot-targa Apr 22, 2025
9e77162
chore(docs): update Data Catalog documentation
bot-targa Apr 23, 2025
d4861e4
chore(docs): update Data Catalog documentation
bot-targa Apr 24, 2025
2f6b7e3
chore(docs): update Data Catalog documentation
bot-targa Apr 25, 2025
6d71480
chore(docs): update Data Catalog documentation
bot-targa Apr 28, 2025
9949c4c
chore(docs): update Data Catalog documentation
bot-targa Apr 29, 2025
08302aa
chore(docs): update Data Catalog documentation
bot-targa Apr 30, 2025
19972fd
chore(docs): update Data Catalog documentation
bot-targa May 1, 2025
746580f
chore(docs): update Data Catalog documentation
bot-targa May 2, 2025
4942f83
chore(docs): update Data Catalog documentation
bot-targa May 5, 2025
2c2d6d2
chore(docs): update Data Catalog documentation
bot-targa May 6, 2025
dddaf0d
chore(docs): update Data Catalog documentation
bot-targa May 7, 2025
aefd216
chore(docs): update Data Catalog documentation
bot-targa May 8, 2025
89d38e0
chore(docs): update Data Catalog documentation
bot-targa May 9, 2025
323f5a3
chore(docs): update Data Catalog documentation
bot-targa May 12, 2025
c6ea59e
chore(docs): update Data Catalog documentation
bot-targa May 13, 2025
ff5d0f7
chore(docs): update Data Catalog documentation
bot-targa May 14, 2025
d27491b
chore(docs): update Data Catalog documentation
bot-targa May 15, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/runtime_suite_applications/data-catalog/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,13 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [1.3.1] - 2025-03-27

- Bump service `[email protected]`
- Bump service `[email protected]`
- Bump service `[email protected]`
- Bump service `[email protected]`

## [1.3.0] - 2025-01-31

### Changed
Expand Down
34 changes: 34 additions & 0 deletions docs/runtime_suite_templates/data-catalog/10_overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
id: overview
title: Overview
sidebar_label: Overview
---

<!--
WARNING: this file was automatically generated by Mia-Platform Doc Aggregator.
DO NOT MODIFY IT BY HAND.
Instead, modify the source file and run the aggregator to regenerate this file.
-->

:::caution
This template has been __deprecated__.

Data Catalog UI now provides a section for [Connection Management](/data_catalog/frontend/data_catalog_connections.mdx),
which interacts with the [Job Runner](/data_catalog/data_catalog_job_runner.mdx) services to automatically scan data sources.
:::



_Data Catalog Agent_ is command line interface binary that queries datasources for the data schemas of the resources they own and sends them to a target. In the context of databases, it provides facilities to:

1. query tables schemas
2. aggregate them in a unique asset (JSON format)
3. send it to an HTTP server or store it locally on file

_Data Catalog Agent_ serves as a driver for collecting and browsing, in a unified view, tables/collections persisted in different sources (System of Record, a.k.a SoR).

![architecture](img/architecture.png)

_Mia Console_ allows to intercept the _Data Catalog Agent_ output assets and visualize them in a dedicated web view. _Mia Console_ is one of the configurable targets of _Data Catalog Agent_.

_Data Catalog Agent_ is well suited for running locally or configured in _Mia Console_ as a [CronJob](/development_suite/api-console/api-design/jobs-cronjob.md).
Loading