diff --git a/docs/analytics/overview.md b/docs/analytics/overview.md new file mode 100644 index 0000000..63b8fc0 --- /dev/null +++ b/docs/analytics/overview.md @@ -0,0 +1,11 @@ +# Analytics Overview + +Overview of analytics and insights. + +## Overview + +OpenMetadata provides analytics for usage patterns, data quality trends, and governance metrics. + +## Related Documentation + +- [Usage Analytics](usage.md) diff --git a/docs/analytics/usage.md b/docs/analytics/usage.md new file mode 100644 index 0000000..3ebab6e --- /dev/null +++ b/docs/analytics/usage.md @@ -0,0 +1,11 @@ +# Usage Analytics + +Usage analytics and tracking. + +## Overview + +Learn how to track and analyze metadata usage patterns. + +## Related Documentation + +- [Analytics Overview](overview.md) diff --git a/docs/api-operations/data-contracts.md b/docs/api-operations/data-contracts.md new file mode 100644 index 0000000..0e4a723 --- /dev/null +++ b/docs/api-operations/data-contracts.md @@ -0,0 +1,12 @@ +# Data Contracts API Operations + +API operations for data contracts. + +## Overview + +REST API operations for creating and managing data contracts. + +## Related Documentation + +- [API Operations Overview](overview.md) +- [Data Contracts](../governance/data-contracts.md) diff --git a/docs/api-operations/lineage.md b/docs/api-operations/lineage.md new file mode 100644 index 0000000..1ebfe76 --- /dev/null +++ b/docs/api-operations/lineage.md @@ -0,0 +1,12 @@ +# Lineage API Operations + +API operations for lineage tracking. + +## Overview + +REST API operations for creating and querying data lineage. + +## Related Documentation + +- [API Operations Overview](overview.md) +- [Lineage Overview](../lineage/overview.md) diff --git a/docs/api-operations/overview.md b/docs/api-operations/overview.md new file mode 100644 index 0000000..2f22748 --- /dev/null +++ b/docs/api-operations/overview.md @@ -0,0 +1,12 @@ +# API Operations Overview + +Overview of all API operations for OpenMetadata entities. + +## Overview + +Comprehensive REST API operations for creating, reading, updating, and deleting metadata entities. + +## Related Documentation + +- [APIs Overview](../apis/overview.md) +- [OpenAPI Specification](../specifications/openapi.md) diff --git a/docs/apis/overview.md b/docs/apis/overview.md new file mode 100644 index 0000000..a4d2e2f --- /dev/null +++ b/docs/apis/overview.md @@ -0,0 +1,12 @@ +# APIs Overview + +Overview of OpenMetadata APIs. + +## Overview + +Comprehensive REST APIs for all metadata operations. + +## Related Documentation + +- [API Operations](../api-operations/overview.md) +- [OpenAPI Specification](../specifications/openapi.md) diff --git a/docs/configuration/services.md b/docs/configuration/services.md new file mode 100644 index 0000000..dd844de --- /dev/null +++ b/docs/configuration/services.md @@ -0,0 +1,12 @@ +# Service Configuration + +Configuration guide for OpenMetadata services. + +## Overview + +Learn how to configure connections and credentials for various services. + +## Related Documentation + +- [Services Overview](../services/overview.md) +- [Security](../security/overview.md) diff --git a/docs/connectors/overview.md b/docs/connectors/overview.md new file mode 100644 index 0000000..5e481e8 --- /dev/null +++ b/docs/connectors/overview.md @@ -0,0 +1,12 @@ +# Connectors Overview + +Overview of OpenMetadata connectors. + +## Overview + +OpenMetadata supports connectors for databases, data warehouses, pipelines, dashboards, and more. + +## Related Documentation + +- [Integrations](../integrations/overview.md) +- [Services](../services/overview.md) diff --git a/docs/connectors/pipeline-services.md b/docs/connectors/pipeline-services.md new file mode 100644 index 0000000..0e6e1bd --- /dev/null +++ b/docs/connectors/pipeline-services.md @@ -0,0 +1,12 @@ +# Pipeline Service Connectors + +Connectors for pipeline and orchestration services. + +## Overview + +Learn about connectors for Airflow, Dagster, Prefect, and other pipeline services. + +## Related Documentation + +- [Connectors Overview](overview.md) +- [Pipeline Services](../data-assets/pipelines/pipeline-service.md) diff --git a/docs/core-concepts/organization.md b/docs/core-concepts/organization.md new file mode 100644 index 0000000..1ef1ec7 --- /dev/null +++ b/docs/core-concepts/organization.md @@ -0,0 +1,12 @@ +# Organization + +Organizational structure and hierarchy. + +## Overview + +Define organizational structure for metadata governance. + +## Related Documentation + +- [Teams](../teams-users/team.md) +- [Users](../teams-users/user.md) diff --git a/docs/data-assets/applications/overview.md b/docs/data-assets/applications/overview.md new file mode 100644 index 0000000..bb80f68 --- /dev/null +++ b/docs/data-assets/applications/overview.md @@ -0,0 +1,11 @@ +# Applications Overview + +Overview of application metadata. + +## Overview + +Learn about tracking metadata for applications and services. + +## Related Documentation + +- [Data Assets Overview](../overview.md) diff --git a/docs/data-assets/dashboards/dashboard-data-model.md b/docs/data-assets/dashboards/dashboard-data-model.md new file mode 100644 index 0000000..abd17a4 --- /dev/null +++ b/docs/data-assets/dashboards/dashboard-data-model.md @@ -0,0 +1,12 @@ +# Dashboard Data Model + +Data model for dashboard entities. + +## Overview + +Learn about the data model underlying dashboard metadata. + +## Related Documentation + +- [Dashboard](dashboard.md) +- [Dashboards Overview](overview.md) diff --git a/docs/data-assets/databases/schema.md b/docs/data-assets/databases/schema.md new file mode 100644 index 0000000..5826975 --- /dev/null +++ b/docs/data-assets/databases/schema.md @@ -0,0 +1,12 @@ +# Database Schema + +Database schema metadata. + +## Overview + +Metadata for database schemas. + +## Related Documentation + +- [Database](database.md) +- [Table](table.md) diff --git a/docs/data-assets/messaging/messaging-service.md b/docs/data-assets/messaging/messaging-service.md index 11b5c48..bdbe0da 100644 --- a/docs/data-assets/messaging/messaging-service.md +++ b/docs/data-assets/messaging/messaging-service.md @@ -990,6 +990,6 @@ Content-Type: application/json - **[Topic](topic.md)** - Topic entity specification - **[Messaging Overview](overview.md)** - Messaging assets overview -- **[Schema Registry Integration](../../integration/schema-registry.md)** - Schema management +- **[Schema Registry Integration](../../integrations/schema-registry.md)** - Schema management - **[Event Lineage](../../lineage/event-lineage.md)** - Event-driven lineage - **[Data Pipelines](../../orchestration/overview.md)** - Pipeline integration diff --git a/docs/data-assets/messaging/topic.md b/docs/data-assets/messaging/topic.md index 6294643..ab26db7 100644 --- a/docs/data-assets/messaging/topic.md +++ b/docs/data-assets/messaging/topic.md @@ -1451,7 +1451,7 @@ Response: BulkOperationResult - **[MessagingService](messaging-service.md)** - Service configuration - **[Messaging Overview](overview.md)** - Messaging assets overview -- **[Schema Registry](../../integration/schema-registry.md)** - Schema management +- **[Schema Registry](../../integrations/schema-registry.md)** - Schema management - **[Event Lineage](../../lineage/event-lineage.md)** - Event-driven lineage - **[Data Quality](../../data-quality/overview.md)** - Event validation - **[Data Contracts](../../governance/data-contracts.md)** - Schema contracts diff --git a/docs/data-assets/notebooks/notebook-service.md b/docs/data-assets/notebooks/notebook-service.md new file mode 100644 index 0000000..1950a05 --- /dev/null +++ b/docs/data-assets/notebooks/notebook-service.md @@ -0,0 +1,12 @@ +# Notebook Service + +Notebook service configuration. + +## Overview + +Learn how to configure connections to notebook services like Jupyter, Databricks, and Zeppelin. + +## Related Documentation + +- [Notebook](notebook.md) +- [Notebooks Overview](overview.md) diff --git a/docs/data-assets/services/database-service.md b/docs/data-assets/services/database-service.md new file mode 100644 index 0000000..c6ed08d --- /dev/null +++ b/docs/data-assets/services/database-service.md @@ -0,0 +1,12 @@ +# Database Service + +Database service configuration and metadata. + +## Overview + +Learn how to configure connections to database services. + +## Related Documentation + +- [Services Overview](../../services/overview.md) +- [Database](../databases/database.md) diff --git a/docs/data-quality/profiling.md b/docs/data-quality/profiling.md new file mode 100644 index 0000000..a73cd77 --- /dev/null +++ b/docs/data-quality/profiling.md @@ -0,0 +1,12 @@ +# Data Profiling + +Data profiling and statistics. + +## Overview + +Learn how to profile data and generate statistics for tables and columns. + +## Related Documentation + +- [Data Quality Overview](overview.md) +- [Test Definitions](test-definition.md) diff --git a/docs/developer/contract-patterns.md b/docs/developer/contract-patterns.md new file mode 100644 index 0000000..70bb954 --- /dev/null +++ b/docs/developer/contract-patterns.md @@ -0,0 +1,12 @@ +# Contract Patterns + +Common patterns for data contracts. + +## Overview + +Learn about common patterns and best practices for data contracts. + +## Related Documentation + +- [Developer Guide](overview.md) +- [Data Contracts](../governance/data-contracts.md) diff --git a/docs/developer/overview.md b/docs/developer/overview.md new file mode 100644 index 0000000..bbf6789 --- /dev/null +++ b/docs/developer/overview.md @@ -0,0 +1,12 @@ +# Developer Guide + +Developer guide for OpenMetadata Standards. + +## Overview + +Learn how to work with OpenMetadata Standards as a developer. + +## Related Documentation + +- [API Operations](../api-operations/overview.md) +- [Specifications](../specifications/overview.md) diff --git a/docs/examples/data-contracts.md b/docs/examples/data-contracts.md new file mode 100644 index 0000000..281e515 --- /dev/null +++ b/docs/examples/data-contracts.md @@ -0,0 +1,12 @@ +# Data Contracts Examples + +Practical examples for data contracts. + +## Overview + +Real-world examples of defining and enforcing data contracts. + +## Related Documentation + +- [Examples Overview](index.md) +- [Data Contracts Reference](../reference/contracts.md) diff --git a/docs/examples/data-contracts/index.md b/docs/examples/data-contracts/index.md new file mode 100644 index 0000000..4e1d48a --- /dev/null +++ b/docs/examples/data-contracts/index.md @@ -0,0 +1,12 @@ +# Data Contracts Examples + +Practical examples for data contracts. + +## Overview + +Real-world examples of defining and enforcing data contracts. + +## Related Documentation + +- [Examples Overview](../index.md) +- [Data Contracts](../../governance/data-contracts.md) diff --git a/docs/examples/data-quality.md b/docs/examples/data-quality.md new file mode 100644 index 0000000..45a050c --- /dev/null +++ b/docs/examples/data-quality.md @@ -0,0 +1,12 @@ +# Data Quality Examples + +Practical examples for data quality management. + +## Overview + +Real-world examples of data quality tests, suites, and monitoring. + +## Related Documentation + +- [Examples Overview](index.md) +- [Data Quality Overview](../data-quality/overview.md) diff --git a/docs/examples/data-quality/index.md b/docs/examples/data-quality/index.md new file mode 100644 index 0000000..4a0c24d --- /dev/null +++ b/docs/examples/data-quality/index.md @@ -0,0 +1,12 @@ +# Data Quality Examples + +Practical examples for data quality. + +## Overview + +Real-world examples of data quality tests, profiling, and monitoring. + +## Related Documentation + +- [Examples Overview](../index.md) +- [Data Quality Overview](../../data-quality/overview.md) diff --git a/docs/examples/governance.md b/docs/examples/governance.md new file mode 100644 index 0000000..4825336 --- /dev/null +++ b/docs/examples/governance.md @@ -0,0 +1,12 @@ +# Governance Examples + +Practical examples for metadata governance. + +## Overview + +Real-world examples of governance policies, ownership, and access control. + +## Related Documentation + +- [Examples Overview](index.md) +- [Governance Overview](../governance/overview.md) diff --git a/docs/examples/governance/index.md b/docs/examples/governance/index.md new file mode 100644 index 0000000..9b3881a --- /dev/null +++ b/docs/examples/governance/index.md @@ -0,0 +1,12 @@ +# Governance Examples + +Practical examples for governance. + +## Overview + +Real-world examples of governance policies, ownership, and classification. + +## Related Documentation + +- [Examples Overview](../index.md) +- [Governance Overview](../../governance/overview.md) diff --git a/docs/examples/lineage.md b/docs/examples/lineage.md new file mode 100644 index 0000000..39b5e04 --- /dev/null +++ b/docs/examples/lineage.md @@ -0,0 +1,12 @@ +# Lineage Examples + +Practical examples for data lineage tracking. + +## Overview + +Real-world examples of lineage tracking across databases, pipelines, and dashboards. + +## Related Documentation + +- [Examples Overview](index.md) +- [Advanced Examples](advanced.md) diff --git a/docs/examples/lineage/index.md b/docs/examples/lineage/index.md new file mode 100644 index 0000000..d458956 --- /dev/null +++ b/docs/examples/lineage/index.md @@ -0,0 +1,12 @@ +# Lineage Examples + +Practical examples for data lineage. + +## Overview + +Real-world examples of tracking lineage across databases, pipelines, and dashboards. + +## Related Documentation + +- [Examples Overview](../index.md) +- [Lineage Overview](../../lineage/overview.md) diff --git a/docs/examples/teams-users.md b/docs/examples/teams-users.md new file mode 100644 index 0000000..e652995 --- /dev/null +++ b/docs/examples/teams-users.md @@ -0,0 +1,12 @@ +# Teams and Users Examples + +Practical examples for team and user management. + +## Overview + +Real-world examples of organizing teams, assigning roles, and managing permissions. + +## Related Documentation + +- [Examples Overview](index.md) +- [Teams](../teams-users/team.md) diff --git a/docs/examples/teams-users/index.md b/docs/examples/teams-users/index.md new file mode 100644 index 0000000..1583b37 --- /dev/null +++ b/docs/examples/teams-users/index.md @@ -0,0 +1,12 @@ +# Teams and Users Examples + +Practical examples for teams and users. + +## Overview + +Real-world examples of organizing teams and managing users. + +## Related Documentation + +- [Examples Overview](../index.md) +- [Teams and Users Overview](../../teams-users/overview.md) diff --git a/docs/getting-started/authentication.md b/docs/getting-started/authentication.md new file mode 100644 index 0000000..8900517 --- /dev/null +++ b/docs/getting-started/authentication.md @@ -0,0 +1,12 @@ +# Authentication + +Getting started with authentication in OpenMetadata Standards. + +## Overview + +Learn how to authenticate and secure access to metadata. + +## Related Documentation + +- [Security Overview](../security/overview.md) +- [RBAC](../security/rbac.md) diff --git a/docs/getting-started/data-contracts.md b/docs/getting-started/data-contracts.md new file mode 100644 index 0000000..f520c7d --- /dev/null +++ b/docs/getting-started/data-contracts.md @@ -0,0 +1,12 @@ +# Data Contracts + +Getting started with data contracts. + +## Overview + +Learn how to define and enforce data contracts for quality and governance. + +## Related Documentation + +- [Data Contract Schema](../schemas/entity/dataContract.md) +- [API Operations](../api-operations/data-contracts.md) diff --git a/docs/getting-started/data-quality.md b/docs/getting-started/data-quality.md new file mode 100644 index 0000000..b40d51f --- /dev/null +++ b/docs/getting-started/data-quality.md @@ -0,0 +1,12 @@ +# Data Quality + +Getting started with data quality management. + +## Overview + +Learn how to define and monitor data quality rules and metrics. + +## Related Documentation + +- [Data Quality Overview](../data-quality/overview.md) +- [Test Suites](../data-quality/test-suite.md) diff --git a/docs/getting-started/governance.md b/docs/getting-started/governance.md new file mode 100644 index 0000000..758e5f3 --- /dev/null +++ b/docs/getting-started/governance.md @@ -0,0 +1,12 @@ +# Governance + +Getting started with metadata governance. + +## Overview + +Learn how to implement governance policies and controls. + +## Related Documentation + +- [Governance Overview](../governance/overview.md) +- [Policies](../security/policies.md) diff --git a/docs/getting-started/lineage.md b/docs/getting-started/lineage.md new file mode 100644 index 0000000..5d25c29 --- /dev/null +++ b/docs/getting-started/lineage.md @@ -0,0 +1,12 @@ +# Lineage + +Getting started with data lineage tracking. + +## Overview + +Learn how to track and visualize data lineage across your ecosystem. + +## Related Documentation + +- [Lineage Schema](../schemas/type/entityLineage.md) +- [API Operations](../api-operations/lineage.md) diff --git a/docs/getting-started/teams-users.md b/docs/getting-started/teams-users.md new file mode 100644 index 0000000..f9a4f41 --- /dev/null +++ b/docs/getting-started/teams-users.md @@ -0,0 +1,12 @@ +# Teams and Users + +Getting started with teams and user management. + +## Overview + +Learn how to organize users into teams and manage permissions. + +## Related Documentation + +- [Teams](../teams-users/team.md) +- [Users](../teams-users/user.md) diff --git a/docs/governance/api-versioning.md b/docs/governance/api-versioning.md new file mode 100644 index 0000000..fed49b7 --- /dev/null +++ b/docs/governance/api-versioning.md @@ -0,0 +1,12 @@ +# API Versioning + +API versioning and compatibility policies. + +## Overview + +Learn about API versioning strategies and backward compatibility. + +## Related Documentation + +- [Governance Overview](overview.md) +- [Specifications - API Versioning](../specifications/api-versioning.md) diff --git a/docs/governance/audit-log.md b/docs/governance/audit-log.md new file mode 100644 index 0000000..ca63615 --- /dev/null +++ b/docs/governance/audit-log.md @@ -0,0 +1,12 @@ +# Audit Log + +Audit logging and tracking. + +## Overview + +Track all changes and access to metadata. + +## Related Documentation + +- [Events](../events/overview.md) +- [Change Events](../events/change-event.md) diff --git a/docs/governance/data-contracts.md b/docs/governance/data-contracts.md new file mode 100644 index 0000000..c025d81 --- /dev/null +++ b/docs/governance/data-contracts.md @@ -0,0 +1,12 @@ +# Data Contracts + +Data contracts for governance and quality. + +## Overview + +Learn how to define and enforce data contracts. + +## Related Documentation + +- [Governance Overview](overview.md) +- [Getting Started - Data Contracts](../getting-started/data-contracts.md) diff --git a/docs/governance/domain.md b/docs/governance/domain.md new file mode 100644 index 0000000..c401744 --- /dev/null +++ b/docs/governance/domain.md @@ -0,0 +1,12 @@ +# Domain + +Domain-driven organization of data assets and metadata. + +## Overview + +Domains provide a way to organize data assets by business domains, enabling better ownership and governance. + +## Related Documentation + +- [Governance Overview](overview.md) +- [Data Products](../data-products/overview.md) diff --git a/docs/governance/glossary.md b/docs/governance/glossary.md index f2fd46a..a29bb2d 100644 --- a/docs/governance/glossary.md +++ b/docs/governance/glossary.md @@ -1087,4 +1087,4 @@ Response: ChangeEvent - **[GlossaryTerm](glossary-term.md)** - Individual business terms - **[Classification](classification.md)** - Tag hierarchies - **[Domain](../domains/domain.md)** - Business domains -- **[Governance](../../governance/overview.md)** - Governance framework +- **[Governance](overview.md)** - Governance framework diff --git a/docs/governance/ownership.md b/docs/governance/ownership.md new file mode 100644 index 0000000..f299256 --- /dev/null +++ b/docs/governance/ownership.md @@ -0,0 +1,12 @@ +# Ownership + +Data ownership and stewardship. + +## Overview + +Define and track ownership of data assets. + +## Related Documentation + +- [Governance Overview](overview.md) +- [Teams](../teams-users/team.md) diff --git a/docs/governance/tag.md b/docs/governance/tag.md index fb91535..8449193 100644 --- a/docs/governance/tag.md +++ b/docs/governance/tag.md @@ -1065,4 +1065,4 @@ When a tag is applied to a data asset, it creates a **TagLabel** with additional - **[Table](../data-assets/databases/table.md)** - Applying tags to tables - **[Column](../data-assets/databases/column.md)** - Applying tags to columns - **[SKOS Standard](https://www.w3.org/TR/skos-reference/)** - W3C Simple Knowledge Organization System -- **[Data Governance](../../governance/overview.md)** - Governance framework +- **[Data Governance](overview.md)** - Governance framework diff --git a/docs/guides/data-lake-patterns.md b/docs/guides/data-lake-patterns.md new file mode 100644 index 0000000..5dbc63f --- /dev/null +++ b/docs/guides/data-lake-patterns.md @@ -0,0 +1,12 @@ +# Data Lake Patterns + +Common patterns for data lake organization. + +## Overview + +Explore common patterns like medallion architecture, data mesh, and more. + +## Related Documentation + +- [Data Lake Guide](data-lake.md) +- [Partitioning](partitioning.md) diff --git a/docs/guides/data-lake.md b/docs/guides/data-lake.md new file mode 100644 index 0000000..1d8f695 --- /dev/null +++ b/docs/guides/data-lake.md @@ -0,0 +1,12 @@ +# Data Lake Guide + +Guide for managing data lake metadata. + +## Overview + +Best practices for organizing and managing data lake metadata. + +## Related Documentation + +- [Storage Containers](../data-assets/storage/container.md) +- [File Formats](file-formats.md) diff --git a/docs/guides/file-formats.md b/docs/guides/file-formats.md new file mode 100644 index 0000000..e4faeb6 --- /dev/null +++ b/docs/guides/file-formats.md @@ -0,0 +1,12 @@ +# File Formats Guide + +Guide for working with different file formats. + +## Overview + +Learn about supported file formats including Parquet, Avro, ORC, JSON, CSV, and more. + +## Related Documentation + +- [Data Lake Guide](data-lake.md) +- [Storage Containers](../data-assets/storage/container.md) diff --git a/docs/guides/partitioning.md b/docs/guides/partitioning.md new file mode 100644 index 0000000..fc3c2e9 --- /dev/null +++ b/docs/guides/partitioning.md @@ -0,0 +1,12 @@ +# Partitioning Guide + +Guide for managing partitioned data. + +## Overview + +Learn about partition strategies and metadata management for partitioned data. + +## Related Documentation + +- [Data Lake Guide](data-lake.md) +- [File Formats](file-formats.md) diff --git a/docs/ingestion/overview.md b/docs/ingestion/overview.md new file mode 100644 index 0000000..a65c10c --- /dev/null +++ b/docs/ingestion/overview.md @@ -0,0 +1,12 @@ +# Ingestion Overview + +Overview of metadata ingestion. + +## Overview + +Learn how to ingest metadata from various data sources into OpenMetadata. + +## Related Documentation + +- [Integrations](../integrations/overview.md) +- [Services](../services/overview.md) diff --git a/docs/integrations/orchestration.md b/docs/integrations/orchestration.md new file mode 100644 index 0000000..3715001 --- /dev/null +++ b/docs/integrations/orchestration.md @@ -0,0 +1,12 @@ +# Orchestration Integration + +Integration with orchestration platforms. + +## Overview + +Learn how to integrate with orchestration platforms like Airflow, Dagster, and Prefect. + +## Related Documentation + +- [Integrations Overview](overview.md) +- [Pipeline Services](../data-assets/pipelines/pipeline.md) diff --git a/docs/integrations/overview.md b/docs/integrations/overview.md new file mode 100644 index 0000000..df6584e --- /dev/null +++ b/docs/integrations/overview.md @@ -0,0 +1,22 @@ +# Integrations Overview + +Overview of OpenMetadata integrations and connectors. + +## Overview + +OpenMetadata supports a wide range of integrations for databases, data warehouses, pipelines, dashboards, messaging systems, and storage services. + +## Integration Categories + +- **Databases** - PostgreSQL, MySQL, Oracle, SQL Server, and more +- **Data Warehouses** - Snowflake, BigQuery, Redshift, and more +- **Pipelines** - Airflow, Dagster, Prefect, and more +- **Dashboards** - Tableau, Looker, PowerBI, and more +- **Messaging** - Kafka, Pulsar, RabbitMQ, and more +- **Storage** - S3, GCS, ADLS, and more + +## Related Documentation + +- [Schema Registry](schema-registry.md) +- [Orchestration](orchestration.md) +- [Services](../services/overview.md) diff --git a/docs/integrations/schema-registry.md b/docs/integrations/schema-registry.md new file mode 100644 index 0000000..4ab29c0 --- /dev/null +++ b/docs/integrations/schema-registry.md @@ -0,0 +1,12 @@ +# Schema Registry Integration + +Integration with schema registries. + +## Overview + +Learn how to integrate with schema registries like Confluent Schema Registry. + +## Related Documentation + +- [Integrations Overview](overview.md) +- [Services](../services/overview.md) diff --git a/docs/lineage/event-lineage.md b/docs/lineage/event-lineage.md new file mode 100644 index 0000000..f4196a6 --- /dev/null +++ b/docs/lineage/event-lineage.md @@ -0,0 +1,12 @@ +# Event Lineage + +Event-based lineage tracking. + +## Overview + +Learn how to track lineage for event streams and messaging systems. + +## Related Documentation + +- [Lineage Overview](overview.md) +- [Messaging Topics](../data-assets/messaging/topic.md) diff --git a/docs/operations/applications/application.md b/docs/operations/applications/application.md index cc7984a..97c1ef5 100644 --- a/docs/operations/applications/application.md +++ b/docs/operations/applications/application.md @@ -1476,12 +1476,12 @@ for details on defining and using custom properties. ## Related Documentation -- **[Table](../databases/table.md)** - Database tables accessed -- **[API Endpoint](../apis/api-endpoint.md)** - APIs called and exposed -- **[Topic](../messaging/topic.md)** - Message topics -- **[Dashboard](../dashboards/dashboard.md)** - Embedded dashboards -- **[ML Model](../ml/mlmodel.md)** - ML models used -- **[Container](../storage/container.md)** - Storage containers +- **[Table](../../data-assets/databases/table.md)** - Database tables accessed +- **[API Endpoint](../../data-assets/apis/api-endpoint.md)** - APIs called and exposed +- **[Topic](../../data-assets/messaging/topic.md)** - Message topics +- **[Dashboard](../../data-assets/dashboards/dashboard.md)** - Embedded dashboards +- **[ML Model](../../data-assets/ml/mlmodel.md)** - ML models used +- **[Container](../../data-assets/storage/container.md)** - Storage containers - **[Domain](../../governance/domain.md)** - Business domains - **[Lineage](../../lineage/overview.md)** - Application lineage - **[Data Contracts](../../governance/data-contracts.md)** - Data contracts diff --git a/docs/operations/applications/overview.md b/docs/operations/applications/overview.md index ed0a79e..5a3bb58 100644 --- a/docs/operations/applications/overview.md +++ b/docs/operations/applications/overview.md @@ -317,11 +317,11 @@ graph LR ## Related Entities - **[Application](./application.md)**: Detailed application entity specification -- **[Table](../databases/table.md)**: Database tables accessed by applications -- **[API Endpoint](../apis/api-endpoint.md)**: APIs called by applications -- **[Topic](../messaging/topic.md)**: Message streams consumed/produced -- **[ML Model](../ml/mlmodel.md)**: Models used by applications -- **[Pipeline](../pipelines/pipeline.md)**: Data pipelines for application data +- **[Table](../../data-assets/databases/table.md)**: Database tables accessed by applications +- **[API Endpoint](../../data-assets/apis/api-endpoint.md)**: APIs called by applications +- **[Topic](../../data-assets/messaging/topic.md)**: Message streams consumed/produced +- **[ML Model](../../data-assets/ml/mlmodel.md)**: Models used by applications +- **[Pipeline](../../data-assets/pipelines/pipeline.md)**: Data pipelines for application data - **[Data Contract](../../data-contracts/data-contract.md)**: Contracts between applications and data - **[Team](../../teams-users/team.md)**: Teams owning and operating applications diff --git a/docs/orchestration/overview.md b/docs/orchestration/overview.md new file mode 100644 index 0000000..6f16a3b --- /dev/null +++ b/docs/orchestration/overview.md @@ -0,0 +1,12 @@ +# Orchestration Overview + +Overview of orchestration and workflow management. + +## Overview + +Learn about orchestrating metadata workflows and pipeline integrations. + +## Related Documentation + +- [Integrations - Orchestration](../integrations/orchestration.md) +- [Pipelines](../data-assets/pipelines/overview.md) diff --git a/docs/reference/api/contracts.md b/docs/reference/api/contracts.md new file mode 100644 index 0000000..6b32090 --- /dev/null +++ b/docs/reference/api/contracts.md @@ -0,0 +1,12 @@ +# Contracts API Reference + +API reference for data contracts. + +## Overview + +Complete API reference for data contract operations. + +## Related Documentation + +- [Data Contracts Reference](../contracts.md) +- [API Operations](../../api-operations/data-contracts.md) diff --git a/docs/reference/api/lineage.md b/docs/reference/api/lineage.md new file mode 100644 index 0000000..ee437db --- /dev/null +++ b/docs/reference/api/lineage.md @@ -0,0 +1,12 @@ +# Lineage API Reference + +API reference for lineage operations. + +## Overview + +Complete API reference for lineage tracking and querying. + +## Related Documentation + +- [Lineage Reference](../lineage.md) +- [API Operations - Lineage](../../api-operations/lineage.md) diff --git a/docs/reference/contracts.md b/docs/reference/contracts.md new file mode 100644 index 0000000..7f90bcd --- /dev/null +++ b/docs/reference/contracts.md @@ -0,0 +1,12 @@ +# Data Contracts Reference + +Comprehensive data contracts reference documentation. + +## Overview + +Detailed reference for data contract schemas, APIs, and enforcement. + +## Related Documentation + +- [Getting Started with Data Contracts](../getting-started/data-contracts.md) +- [Data Contract Schema](../schemas/entity/dataContract.md) diff --git a/docs/reference/lineage.md b/docs/reference/lineage.md new file mode 100644 index 0000000..df1a136 --- /dev/null +++ b/docs/reference/lineage.md @@ -0,0 +1,12 @@ +# Lineage Reference + +Comprehensive lineage reference documentation. + +## Overview + +Detailed reference for lineage schemas, APIs, and visualization. + +## Related Documentation + +- [Getting Started with Lineage](../getting-started/lineage.md) +- [Lineage Schema](../schemas/type/entityLineage.md) diff --git a/docs/schemas/entity/dataContract.md b/docs/schemas/entity/dataContract.md new file mode 100644 index 0000000..f1f8471 --- /dev/null +++ b/docs/schemas/entity/dataContract.md @@ -0,0 +1,12 @@ +# Data Contract Schema + +JSON Schema for data contracts. + +## Overview + +Schema definition for data contract entities. + +## Related Documentation + +- [Data Contracts](../../governance/data-contracts.md) +- [Schemas Overview](../overview.md) diff --git a/docs/schemas/type/entityLineage.md b/docs/schemas/type/entityLineage.md new file mode 100644 index 0000000..21f1579 --- /dev/null +++ b/docs/schemas/type/entityLineage.md @@ -0,0 +1,12 @@ +# Entity Lineage Schema + +JSON Schema for entity lineage. + +## Overview + +Schema definition for lineage tracking between entities. + +## Related Documentation + +- [Lineage Overview](../../lineage/overview.md) +- [Schemas Overview](../overview.md) diff --git a/docs/search/analyzers.md b/docs/search/analyzers.md new file mode 100644 index 0000000..38ee6d6 --- /dev/null +++ b/docs/search/analyzers.md @@ -0,0 +1,12 @@ +# Search Analyzers + +Search analyzers and text processing. + +## Overview + +Learn about search analyzers for text processing and indexing. + +## Related Documentation + +- [Search Overview](overview.md) +- [Search Index](../data-assets/search/search-index.md) diff --git a/docs/search/overview.md b/docs/search/overview.md new file mode 100644 index 0000000..f169b9c --- /dev/null +++ b/docs/search/overview.md @@ -0,0 +1,12 @@ +# Search Overview + +Overview of search and discovery. + +## Overview + +Learn about search capabilities and metadata discovery. + +## Related Documentation + +- [Search Analyzers](analyzers.md) +- [Search Index](../data-assets/search/search-index.md) diff --git a/docs/security/access-control.md b/docs/security/access-control.md new file mode 100644 index 0000000..6c563fb --- /dev/null +++ b/docs/security/access-control.md @@ -0,0 +1,13 @@ +# Access Control + +Access control and permissions management. + +## Overview + +Learn how to configure fine-grained access control for metadata assets. + +## Related Documentation + +- [Security Overview](overview.md) +- [RBAC](rbac.md) +- [Permissions](permissions.md) diff --git a/docs/security/authentication.md b/docs/security/authentication.md new file mode 100644 index 0000000..c56c591 --- /dev/null +++ b/docs/security/authentication.md @@ -0,0 +1,12 @@ +# Authentication + +Authentication mechanisms and configuration. + +## Overview + +Learn about authentication methods including SSO, LDAP, OIDC, and API tokens. + +## Related Documentation + +- [Security Overview](overview.md) +- [Authorization](authorization.md) diff --git a/docs/security/authorization.md b/docs/security/authorization.md new file mode 100644 index 0000000..cb379da --- /dev/null +++ b/docs/security/authorization.md @@ -0,0 +1,13 @@ +# Authorization + +Authorization and access control in OpenMetadata Standards. + +## Overview + +This page contains information about authorization mechanisms and access control policies. + +## Related Documentation + +- [Security Overview](overview.md) +- [Authentication](authentication.md) +- [RBAC](rbac.md) diff --git a/docs/security/overview.md b/docs/security/overview.md new file mode 100644 index 0000000..8f987f1 --- /dev/null +++ b/docs/security/overview.md @@ -0,0 +1,19 @@ +# Security Overview + +Overview of security features and best practices. + +## Overview + +Comprehensive guide to securing your OpenMetadata deployment. + +## Key Topics + +- [Authentication](authentication.md) +- [Authorization](authorization.md) +- [RBAC](rbac.md) +- [Access Control](access-control.md) +- [Policies](policies.md) + +## Related Documentation + +- [Getting Started - Authentication](../getting-started/authentication.md) diff --git a/docs/security/permissions.md b/docs/security/permissions.md new file mode 100644 index 0000000..111d416 --- /dev/null +++ b/docs/security/permissions.md @@ -0,0 +1,12 @@ +# Permissions + +Permission management and access control. + +## Overview + +Fine-grained permissions for metadata assets. + +## Related Documentation + +- [Security Overview](overview.md) +- [RBAC](rbac.md) diff --git a/docs/security/policies.md b/docs/security/policies.md new file mode 100644 index 0000000..510f7e3 --- /dev/null +++ b/docs/security/policies.md @@ -0,0 +1,12 @@ +# Security Policies + +Security policies and governance. + +## Overview + +Define and enforce security policies across your metadata. + +## Related Documentation + +- [Security Overview](overview.md) +- [Governance](../governance/overview.md) diff --git a/docs/security/rbac.md b/docs/security/rbac.md new file mode 100644 index 0000000..2988111 --- /dev/null +++ b/docs/security/rbac.md @@ -0,0 +1,12 @@ +# Role-Based Access Control (RBAC) + +Role-based access control for metadata governance. + +## Overview + +RBAC enables fine-grained access control based on user roles. + +## Related Documentation + +- [Security Overview](overview.md) +- [Roles](../teams-users/role.md) diff --git a/docs/services/overview.md b/docs/services/overview.md new file mode 100644 index 0000000..5b27eb9 --- /dev/null +++ b/docs/services/overview.md @@ -0,0 +1,12 @@ +# Services Overview + +Overview of OpenMetadata services and connectors. + +## Overview + +Learn about different service types including databases, pipelines, dashboards, messaging, and storage. + +## Related Documentation + +- [Integrations](../integrations/overview.md) +- [Configuration](../configuration/services.md) diff --git a/docs/specifications/api-versioning.md b/docs/specifications/api-versioning.md new file mode 100644 index 0000000..d239b51 --- /dev/null +++ b/docs/specifications/api-versioning.md @@ -0,0 +1,12 @@ +# API Versioning + +API versioning strategy and guidelines. + +## Overview + +Learn about API versioning, compatibility, and deprecation policies. + +## Related Documentation + +- [OpenAPI Specification](openapi.md) +- [Changelog](../reference/changelog.md) diff --git a/docs/specifications/openapi.md b/docs/specifications/openapi.md new file mode 100644 index 0000000..3ccf2bc --- /dev/null +++ b/docs/specifications/openapi.md @@ -0,0 +1,12 @@ +# OpenAPI Specification + +OpenAPI specifications for OpenMetadata Standards. + +## Overview + +Complete OpenAPI 3.0 specifications for all REST APIs. + +## Related Documentation + +- [API Operations](../api-operations/overview.md) +- [API Versioning](api-versioning.md) diff --git a/docs/specifications/overview.md b/docs/specifications/overview.md new file mode 100644 index 0000000..080bbf7 --- /dev/null +++ b/docs/specifications/overview.md @@ -0,0 +1,12 @@ +# Specifications Overview + +Overview of OpenMetadata specifications. + +## Overview + +OpenMetadata Standards includes JSON Schemas, RDF ontologies, OpenAPI specifications, and more. + +## Related Documentation + +- [OpenAPI Specification](openapi.md) +- [API Versioning](api-versioning.md) diff --git a/docs/standards/prov-o.md b/docs/standards/prov-o.md new file mode 100644 index 0000000..119bef5 --- /dev/null +++ b/docs/standards/prov-o.md @@ -0,0 +1,12 @@ +# PROV-O Standard + +PROV-O ontology for provenance tracking. + +## Overview + +Learn about PROV-O and how it's used for lineage tracking in OpenMetadata. + +## Related Documentation + +- [Standards Overview](overview.md) +- [Lineage Overview](../lineage/overview.md) diff --git a/docs/teams-users/persona.md b/docs/teams-users/persona.md index d381269..3ff373b 100644 --- a/docs/teams-users/persona.md +++ b/docs/teams-users/persona.md @@ -1269,7 +1269,7 @@ Content-Type: application/json ## Related Documentation - **[User](user.md)** - User entity -- **[Domain](../../governance/domain.md)** - Data domain -- **[UI Customization](../../ui/customization.md)** - Interface customization -- **[Workflows](../../workflows/overview.md)** - User workflows -- **[User Experience](../../ui/user-experience.md)** - UX design +- **[Domain](../governance/domain.md)** - Data domain +- **[UI Customization](../ui/customization.md)** - Interface customization +- **[Workflows](../workflows/overview.md)** - User workflows +- **[User Experience](../ui/user-experience.md)** - UX design diff --git a/docs/teams-users/role.md b/docs/teams-users/role.md index 9a28ea6..1b33856 100644 --- a/docs/teams-users/role.md +++ b/docs/teams-users/role.md @@ -1126,7 +1126,7 @@ Content-Type: application/json - **[User](user.md)** - User entity - **[Team](team.md)** - Team entity -- **[Policy](../../security/policies.md)** - Access policies -- **[Authorization](../../security/authorization.md)** - Access control -- **[Permissions](../../security/permissions.md)** - Permission system -- **[RBAC](../../security/rbac.md)** - Role-based access control +- **[Policy](../security/policies.md)** - Access policies +- **[Authorization](../security/authorization.md)** - Access control +- **[Permissions](../security/permissions.md)** - Permission system +- **[RBAC](../security/rbac.md)** - Role-based access control diff --git a/docs/teams-users/team.md b/docs/teams-users/team.md index 26e7e69..4d74970 100644 --- a/docs/teams-users/team.md +++ b/docs/teams-users/team.md @@ -1215,7 +1215,7 @@ Content-Type: application/json - **[User](user.md)** - User entity - **[Role](role.md)** - Role entity -- **[Domain](../../governance/domain.md)** - Data domain -- **[Policy](../../security/policies.md)** - Access policies -- **[Organization](../../core-concepts/organization.md)** - Organization structure -- **[Ownership](../../governance/ownership.md)** - Asset ownership +- **[Domain](../governance/domain.md)** - Data domain +- **[Policy](../security/policies.md)** - Access policies +- **[Organization](../core-concepts/organization.md)** - Organization structure +- **[Ownership](../governance/ownership.md)** - Asset ownership diff --git a/docs/teams-users/user.md b/docs/teams-users/user.md index f56e983..7676e4c 100644 --- a/docs/teams-users/user.md +++ b/docs/teams-users/user.md @@ -1269,6 +1269,6 @@ Content-Type: application/json - **[Team](team.md)** - Team entity - **[Role](role.md)** - Role entity - **[Persona](persona.md)** - Persona entity -- **[Authentication](../../security/authentication.md)** - Authentication mechanisms -- **[Authorization](../../security/authorization.md)** - Access control -- **[Policies](../../security/policies.md)** - Permission policies +- **[Authentication](../security/authentication.md)** - Authentication mechanisms +- **[Authorization](../security/authorization.md)** - Access control +- **[Policies](../security/policies.md)** - Permission policies diff --git a/docs/ui/customization.md b/docs/ui/customization.md new file mode 100644 index 0000000..b6e3678 --- /dev/null +++ b/docs/ui/customization.md @@ -0,0 +1,11 @@ +# UI Customization + +Customizing the OpenMetadata UI. + +## Overview + +Learn how to customize branding, themes, and UI components. + +## Related Documentation + +- [UI Overview](overview.md) diff --git a/docs/ui/overview.md b/docs/ui/overview.md new file mode 100644 index 0000000..0858cc6 --- /dev/null +++ b/docs/ui/overview.md @@ -0,0 +1,11 @@ +# UI Overview + +Overview of OpenMetadata UI components and patterns. + +## Overview + +Learn about UI components, layouts, and design patterns. + +## Related Documentation + +- [Core Concepts](../core-concepts/overview.md) diff --git a/docs/ui/user-experience.md b/docs/ui/user-experience.md new file mode 100644 index 0000000..e24220f --- /dev/null +++ b/docs/ui/user-experience.md @@ -0,0 +1,12 @@ +# User Experience + +User experience guidelines and patterns. + +## Overview + +Learn about UX patterns and best practices for OpenMetadata. + +## Related Documentation + +- [UI Overview](overview.md) +- [UI Customization](customization.md) diff --git a/docs/workflows/overview.md b/docs/workflows/overview.md new file mode 100644 index 0000000..8a54ee0 --- /dev/null +++ b/docs/workflows/overview.md @@ -0,0 +1,12 @@ +# Workflows Overview + +Overview of metadata workflows and automation. + +## Overview + +Learn about automating metadata workflows including ingestion, profiling, and quality testing. + +## Related Documentation + +- [Integrations](../integrations/overview.md) +- [Services](../services/overview.md)