Docs: 2 MB issue Fix for on-prem, OpenMetadata, and Lineage Ingestion#201
Open
RounakDhillon wants to merge 1 commit intomainfrom
Open
Docs: 2 MB issue Fix for on-prem, OpenMetadata, and Lineage Ingestion#201RounakDhillon wants to merge 1 commit intomainfrom
RounakDhillon wants to merge 1 commit intomainfrom
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR addresses documentation size limits (the “2 MB issue”) by splitting large pages into smaller “advanced”/sub-pages and updating sidebar navigation across supported doc versions (v1.11.x, v1.12.x, v1.13.x-SNAPSHOT).
Changes:
- Extracted “advanced” lineage ingestion content into a dedicated
advanced.mdxpage and linked it from the main lineage ingestion deep dive. - Split on-prem Kubernetes deployment instructions by moving Airflow/NFS storage setup into a dedicated
on-prem/airflow.mdxpage and linking from the overview. - Split OpenMetadata ingestion “validation + troubleshooting” content into a dedicated troubleshooting page and updated navigation (
docs.json) accordingly.
Reviewed changes
Copilot reviewed 17 out of 17 changed files in this pull request and generated 12 comments.
Show a summary per file
| File | Description |
|---|---|
| v1.13.x-SNAPSHOT/developers/contribute/codebase-deep-dives/lineage-ingestion/advanced.mdx | New “advanced topics” page to offload detailed lineage ingestion sections. |
| v1.13.x-SNAPSHOT/developers/contribute/codebase-deep-dives/lineage-ingestion.mdx | Removes advanced sections and links to the new advanced page. |
| v1.13.x-SNAPSHOT/deployment/kubernetes/on-prem/airflow.mdx | New on-prem Airflow storage setup page (PVCs, permission pod, values overrides). |
| v1.13.x-SNAPSHOT/deployment/kubernetes/on-prem.mdx | Simplifies on-prem overview and links to the new Airflow storage setup page. |
| v1.13.x-SNAPSHOT/deployment/ingestion/openmetadata/troubleshooting.mdx | New troubleshooting/advanced page for Airflow-based ingestion pipelines. |
| v1.13.x-SNAPSHOT/deployment/ingestion/openmetadata.mdx | Removes troubleshooting content and links to the new troubleshooting page. |
| v1.12.x/developers/contribute/codebase-deep-dives/lineage-ingestion/advanced.mdx | Backports the lineage ingestion advanced page to v1.12.x docs. |
| v1.12.x/developers/contribute/codebase-deep-dives/lineage-ingestion.mdx | Links v1.12.x lineage ingestion overview to its advanced page. |
| v1.12.x/deployment/kubernetes/on-prem/airflow.mdx | Backports on-prem Airflow storage setup page to v1.12.x docs. |
| v1.12.x/deployment/kubernetes/on-prem.mdx | Links v1.12.x on-prem overview to the new Airflow storage setup page. |
| v1.12.x/deployment/ingestion/openmetadata/troubleshooting.mdx | Backports the OpenMetadata ingestion troubleshooting page to v1.12.x docs. |
| v1.12.x/deployment/ingestion/openmetadata.mdx | Links v1.12.x OpenMetadata ingestion overview to the troubleshooting page. |
| v1.11.x/deployment/kubernetes/on-prem/airflow.mdx | Backports on-prem Airflow storage setup page to v1.11.x docs. |
| v1.11.x/deployment/kubernetes/on-prem.mdx | Links v1.11.x on-prem overview to the new Airflow storage setup page. |
| v1.11.x/deployment/ingestion/openmetadata/troubleshooting.mdx | Backports the OpenMetadata ingestion troubleshooting page to v1.11.x docs. |
| v1.11.x/deployment/ingestion/openmetadata.mdx | Links v1.11.x OpenMetadata ingestion overview to the troubleshooting page. |
| docs.json | Updates sidebar structure to group new sub-pages (on-prem deployment, ingestion troubleshooting, lineage advanced). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| ## Troubleshooting | ||
|
|
||
| ## Ingestion Pipeline deployment issues |
| When deploying openmetadata dependencies helm chart, use the below command - | ||
|
|
||
| ```commandline | ||
| helm install openmetadata-dependencies open-metadata/openmetadata-dependencies --values values-dependencies.yaml |
|
|
||
| ## Troubleshooting | ||
|
|
||
| ## Ingestion Pipeline deployment issues |
| When deploying openmetadata dependencies helm chart, use the below command - | ||
|
|
||
| ```commandline | ||
| helm install openmetadata-dependencies open-metadata/openmetadata-dependencies --values values-dependencies.yaml |
Comment on lines
+92
to
+95
| command: | ||
| - "chown -R 50000 /airflow-dags /airflow-logs" | ||
| # if needed | ||
| - "chmod -R a+rwx /airflow-dags" |
Comment on lines
+93
to
+95
| - "chown -R 50000 /airflow-dags /airflow-logs" | ||
| # if needed | ||
| - "chmod -R a+rwx /airflow-dags" |
| persistentVolumeClaim: | ||
| claimName: openmetadata-dependencies-dags | ||
| dnsPolicy: ClusterFirst | ||
| restartPolicy: Always |
| When deploying openmetadata dependencies helm chart, use the below command - | ||
|
|
||
| ```commandline | ||
| helm install openmetadata-dependencies open-metadata/openmetadata-dependencies --values values-dependencies.yaml |
Comment on lines
+93
to
+95
| - "chown -R 50000 /airflow-dags /airflow-logs" | ||
| # if needed | ||
| - "chmod -R a+rwx /airflow-dags" |
| persistentVolumeClaim: | ||
| claimName: openmetadata-dependencies-dags | ||
| dnsPolicy: ClusterFirst | ||
| restartPolicy: Always |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
I worked on 2 MB issue Fix for pages of on-prem, OpenMetadata, and Lineage Ingestion.