-
Notifications
You must be signed in to change notification settings - Fork 1
Docs: Applications Updation #120
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
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR consolidates and reorganizes documentation for Collate Applications by creating comprehensive guides for five key applications (Slack, Reverse Metadata, Query Runner, Autopilot, and Data Retention), updating navigation structure, and removing redundant reverse metadata sections from individual database connector files.
- Creates new centralized application documentation under
/how-to-guides/admin-guide/applications/ - Updates navigation structure in docs.json to include Applications subsection
- Removes duplicate reverse metadata documentation from database connector files (Snowflake, Redshift, PostgreSQL, MySQL)
Reviewed changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 24 comments.
Show a summary per file
| File | Description |
|---|---|
| how-to-guides/admin-guide/applications/slack.mdx | New comprehensive Slack integration guide with setup, OAuth configuration, event subscriptions, and slash commands |
| how-to-guides/admin-guide/applications/reverse-metadata.mdx | New guide for reverse metadata application including supported connectors, SQL templates, and channel configuration |
| how-to-guides/admin-guide/applications/query-runner.mdx | New documentation for Query Runner application installation and SQL Studio enablement |
| how-to-guides/admin-guide/applications/index.mdx | New overview page listing all available applications with descriptions and links |
| how-to-guides/admin-guide/applications/data-retention.mdx | New guide for data retention application configuration and cleanup targets |
| how-to-guides/admin-guide/applications/autopilot.mdx | New documentation for Autopilot application for automated service onboarding |
| products/index.mdx | Updated Reverse Metadata card link to new application documentation path |
| docs.json | Added Applications subsection to admin guide navigation structure |
| connectors/database/snowflake.mdx | Removed reverse metadata section (now centralized in applications docs) |
| connectors/database/redshift.mdx | Removed reverse metadata section (now centralized in applications docs) |
| connectors/database/postgres.mdx | Removed reverse metadata section (now centralized in applications docs) |
| connectors/database/mysql.mdx | Removed reverse metadata section (now centralized in applications docs) |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ALTER TABLE `{database}`.`{schema}`.`{table}` OWNER TO `{owner}@gmail.com`; | ||
| ``` | ||
|
|
||
| **example:-** |
Copilot
AI
Jan 6, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The heading uses "example:-" which should be capitalized as "Example:" for consistency with standard documentation practices.
| ALTER SCHEMA `abc.customers` SET OPTIONS (labels = [('PII', 'Sensitive')]); | ||
| ``` | ||
|
|
||
| This sets or updates schema-level labels, such as sensitive classifications. Useful for tagging metadata like PII & sensitive, to automatically trigger reverse metadata for Tags fields. |
Copilot
AI
Jan 6, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The description "Useful for tagging metadata like PII & sensitive" uses an ampersand which is inconsistent with the rest of the documentation. It should use "and" instead of "&" for a more formal and consistent documentation style (e.g., "like PII and sensitive").
| This sets or updates schema-level labels, such as sensitive classifications. Useful for tagging metadata like PII & sensitive, to automatically trigger reverse metadata for Tags fields. | |
| This sets or updates schema-level labels, such as sensitive classifications. Useful for tagging metadata like PII and sensitive, to automatically trigger reverse metadata for Tags fields. |
| allowFullScreen> | ||
| </iframe> | ||
|
|
||
| The **Reverse Metadata Application** ensures real-time synchronization of metadata changes. Once installed and configured, any updates made to selected assets in Collate—such as descriptions, tags, or owners—are automatically in real-time propagated back to the source systems. There’s no need to trigger the application manually. This live sync ensures Collate remains the single source of truth while all connected systems stay up to date and compliant with governance policies. |
Copilot
AI
Jan 6, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The phrase "There's no need to trigger the application manually" should be "There is no need" for a more formal documentation style. Contractions should be avoided in technical documentation for clarity and professionalism.
| The **Reverse Metadata Application** ensures real-time synchronization of metadata changes. Once installed and configured, any updates made to selected assets in Collate—such as descriptions, tags, or owners—are automatically in real-time propagated back to the source systems. There’s no need to trigger the application manually. This live sync ensures Collate remains the single source of truth while all connected systems stay up to date and compliant with governance policies. | |
| The **Reverse Metadata Application** ensures real-time synchronization of metadata changes. Once installed and configured, any updates made to selected assets in Collate—such as descriptions, tags, or owners—are automatically in real-time propagated back to the source systems. There is no need to trigger the application manually. This live sync ensures Collate remains the single source of truth while all connected systems stay up to date and compliant with governance policies. |
|
|
||
| Users can monitor the running state of workflows, and in case of a failure, use the options below to clean them up: | ||
|
|
||
| - **Run Now:**- This lets you manually initiate a cleanup operation for failed workflows. This option will only be used to clean workflows. They will not trigger reverse metadata. It is an automatic synchronization. |
Copilot
AI
Jan 6, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The sentence "They will not trigger reverse metadata" is grammatically incorrect. The subject "They" refers to the "Run Now" option (singular), so it should be "It will not trigger reverse metadata" for proper subject-verb agreement.
| - **Run Now:**- This lets you manually initiate a cleanup operation for failed workflows. This option will only be used to clean workflows. They will not trigger reverse metadata. It is an automatic synchronization. | |
| - **Run Now:**- This lets you manually initiate a cleanup operation for failed workflows. This option will only be used to clean workflows. It will not trigger reverse metadata. It is an automatic synchronization. |
| - **Run Now:**- This lets you manually initiate a cleanup operation for failed workflows. This option will only be used to clean workflows. They will not trigger reverse metadata. It is an automatic synchronization. | ||
| - **Scheduled Run:**- This automatically re-runs cleanup operations based on a defined schedule (e.g., daily or weekly). |
Copilot
AI
Jan 6, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The bullet point "Scheduled Run:-" has inconsistent punctuation. The colon-dash combination ":-" is non-standard. It should be either a colon ":" or no punctuation at all for consistency.
| - **Run Now:**- This lets you manually initiate a cleanup operation for failed workflows. This option will only be used to clean workflows. They will not trigger reverse metadata. It is an automatic synchronization. | |
| - **Scheduled Run:**- This automatically re-runs cleanup operations based on a defined schedule (e.g., daily or weekly). | |
| - **Run Now:** This lets you manually initiate a cleanup operation for failed workflows. This option will only be used to clean workflows. They will not trigger reverse metadata. It is an automatic synchronization. | |
| - **Scheduled Run:** This automatically re-runs cleanup operations based on a defined schedule (e.g., daily or weekly). |
|
|
||
| ### Update Table Owner in Databricks | ||
|
|
||
| **SQL Variable:-** |
Copilot
AI
Jan 6, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The heading uses "SQL Variable:-" with colon-dash punctuation which is non-standard. It should be "SQL Variable:" or "SQL Variables" for consistency with standard documentation formatting.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
Copilot reviewed 12 out of 12 changed files in this pull request and generated 7 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| | **Update Descriptions** | Enable to sync updated entity descriptions from Collate to the source. | | ||
| | **Update Owners** | Enable to sync owner assignments from Collate. | | ||
| | **Update Tags** | Enable to sync tag assignments (e.g., PII) to the source system. | | ||
| | **Sink Service** | Optional. Specify a target service where metadata changes should be synced. Currently supports security services only. The service name must match exactly with the service name configured in OpenMetadata. | |
Copilot
AI
Jan 7, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The phrase "your used do not have direct access" contains a grammatical error. It should be "your user does not have direct access".
| | Snowflake | ✅ (Support all) | ✅ (Schema, Table, Column) | ❌ | ✅ | [Link](/connectors/database/snowflake#reverse-metadata) | | ||
| | Unity Catalog | ✅ (Support all) | ✅ (Support all) | ✅ (Database, Schema, Table) | ✅ | [Link](/connectors/database/unity-catalog#reverse-metadata) | | ||
| | Trino | ✅ (Table, Column) | ❌ | ❌ | ✅ | [Link](/connectors/database/trino#reverse-metadata) | | ||
| | Tableau | ✅ (Dashboard, Chart) | ✅ (Dashboard, Chart) | ✅ (Dashboard) | ❌ | [Link](/connectors/dashboard/tableau#reverse-metadata) | |
Copilot
AI
Jan 7, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The pipe character after "Tableau" is missing a space before the checkmark. The formatting should be consistent with other rows: | Tableau | ✅ (Dashboard, Chart) | ✅ (Dashboard, Chart) | ✅ (Dashboard) | ❌ | [Link](/connectors/dashboard/tableau#reverse-metadata) |
| - Client Secret – Used for authenticating requests made from your app. | ||
| - Signing Secret – Used to verify that incoming requests (e.g., from Slack) are genuinely from Slack. | ||
|
|
||
| Click Show next to each secret if you need to view the values. You can also regenerate them if needed using the **Regenerate** button, and after that you can share it with Collate Team. |
Copilot
AI
Jan 7, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The phrase "privileged as per above queries" is grammatically awkward. Consider rewording to "privileges as shown in the queries above" or "privileges according to the queries above".
| | Redshift | ✅ (Support all) | ❌ | ✅ (Database, Schema, Table) | ✅ | [Link](/connectors/database/redshift#reverse-metadata) | | ||
| | Snowflake | ✅ (Support all) | ✅ (Schema, Table, Column) | ❌ | ✅ | [Link](/connectors/database/snowflake#reverse-metadata) | | ||
| | Unity Catalog | ✅ (Support all) | ✅ (Support all) | ✅ (Database, Schema, Table) | ✅ | [Link](/connectors/database/unity-catalog#reverse-metadata) | | ||
| | Trino | ✅ (Table, Column) | ❌ | ❌ | ✅ | [Link](/connectors/database/trino#reverse-metadata) | |
Copilot
AI
Jan 7, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The pipe character after "Trino" is missing a space before the checkmark. The formatting should be consistent with other rows: | Trino | ✅ (Table, Column) | ❌ | ❌ | ✅ | [Link](/connectors/database/trino#reverse-metadata) |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
I worked on Applications Updation.