From e548ae44ff58c584008af0a56edc0d81348643a0 Mon Sep 17 00:00:00 2001 From: Karen Hsieh Date: Tue, 3 Mar 2026 20:15:30 +0800 Subject: [PATCH] Add redirects plugin and document cleanup tasks MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Add mkdocs-redirects plugin with redirect mappings for all restructured pages - PR 6: Lineage and data diffing → 5-what-you-can-explore/ - PR 7: preset-checks.md → 6-collaboration/ - PR 8: Technical concepts → 7-reference/ - PR 9: Community support → 8-community/ - Create CLEANUP-TODO.md documenting files to delete after all PRs merge Co-Authored-By: Claude Opus 4.5 --- docs/CLEANUP-TODO.md | 85 ++++++++++++++++++++++++++++++++++++++++++++ mkdocs.yml | 19 ++++++++++ 2 files changed, 104 insertions(+) create mode 100644 docs/CLEANUP-TODO.md diff --git a/docs/CLEANUP-TODO.md b/docs/CLEANUP-TODO.md new file mode 100644 index 0000000..65f5909 --- /dev/null +++ b/docs/CLEANUP-TODO.md @@ -0,0 +1,85 @@ +# Post-Merge Cleanup Tasks + +This document tracks files to delete after all documentation restructuring PRs (6-9) are merged into `docs-v3`. + +## Important + +- Do NOT delete these files until all PRs are merged +- The redirects plugin in `mkdocs.yml` handles URL redirections automatically +- Delete this file after cleanup is complete + +## Files to Delete + +### From PR 6 - Lineage and Data Diffing Consolidation + +**Old Visualized Change section:** + +- `docs/3-visualized-change/lineage.md` → Moved to `5-what-you-can-explore/lineage-diff.md` + +**Old Downstream Impacts section:** + +- `docs/4-downstream-impacts/impact-radius.md` → Moved to `5-what-you-can-explore/impact-radius.md` +- `docs/4-downstream-impacts/breaking-change-analysis.md` → Moved to `5-what-you-can-explore/breaking-change-analysis.md` +- `docs/4-downstream-impacts/metadata-first.md` → Deprecated (if exists) +- `docs/4-downstream-impacts/transformation-types.md` → Deprecated (if exists) + +**Old Data Diffing section:** + +- `docs/5-data-diffing/row-count-diff.md` → Consolidated into `5-what-you-can-explore/data-diffing.md` +- `docs/5-data-diffing/profile-diff.md` → Consolidated into `5-what-you-can-explore/data-diffing.md` +- `docs/5-data-diffing/value-diff.md` → Consolidated into `5-what-you-can-explore/data-diffing.md` +- `docs/5-data-diffing/topK-diff.md` → Consolidated into `5-what-you-can-explore/data-diffing.md` +- `docs/5-data-diffing/histogram-diff.md` → Consolidated into `5-what-you-can-explore/data-diffing.md` +- `docs/5-data-diffing/query.md` → Consolidated into `5-what-you-can-explore/data-diffing.md` + +### From PR 7 - CI/CD Reorganization + +- `docs/7-cicd/preset-checks.md` → Moved to `6-collaboration/preset-checks.md` + +### From PR 8 - Reference Section + +- `docs/8-technical-concepts/configuration.md` → Moved to `7-reference/configuration.md` +- `docs/8-technical-concepts/state-file.md` → Moved to `7-reference/state-file.md` + +### From PR 9 - Community Section + +- `docs/1-whats-recce/community-support.md` → Moved to `8-community/support.md` + +## Empty Directories to Remove + +After deleting files, remove these directories if empty: + +- `docs/4-downstream-impacts/` +- `docs/5-data-diffing/` +- `docs/8-technical-concepts/` + +## Cleanup Command + +After all PRs are merged, run this to delete old files: + +```bash +# Delete old files (run from repository root) +rm -f docs/3-visualized-change/lineage.md +rm -f docs/4-downstream-impacts/impact-radius.md +rm -f docs/4-downstream-impacts/breaking-change-analysis.md +rm -f docs/4-downstream-impacts/metadata-first.md +rm -f docs/4-downstream-impacts/transformation-types.md +rm -f docs/5-data-diffing/row-count-diff.md +rm -f docs/5-data-diffing/profile-diff.md +rm -f docs/5-data-diffing/value-diff.md +rm -f docs/5-data-diffing/topK-diff.md +rm -f docs/5-data-diffing/histogram-diff.md +rm -f docs/5-data-diffing/query.md +rm -f docs/7-cicd/preset-checks.md +rm -f docs/8-technical-concepts/configuration.md +rm -f docs/8-technical-concepts/state-file.md +rm -f docs/1-whats-recce/community-support.md + +# Remove empty directories +rmdir docs/4-downstream-impacts/ 2>/dev/null || true +rmdir docs/5-data-diffing/ 2>/dev/null || true +rmdir docs/8-technical-concepts/ 2>/dev/null || true + +# Remove this file +rm -f docs/CLEANUP-TODO.md +``` diff --git a/mkdocs.yml b/mkdocs.yml index bee8774..e238392 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -155,6 +155,25 @@ theme: plugins: - search + - redirects: + redirect_maps: + # PR 6 redirects - Lineage and Data Diffing consolidation + '3-visualized-change/lineage.md': '5-what-you-can-explore/lineage-diff.md' + '4-downstream-impacts/impact-radius.md': '5-what-you-can-explore/impact-radius.md' + '4-downstream-impacts/breaking-change-analysis.md': '5-what-you-can-explore/breaking-change-analysis.md' + '5-data-diffing/row-count-diff.md': '5-what-you-can-explore/data-diffing.md' + '5-data-diffing/profile-diff.md': '5-what-you-can-explore/data-diffing.md' + '5-data-diffing/value-diff.md': '5-what-you-can-explore/data-diffing.md' + '5-data-diffing/topK-diff.md': '5-what-you-can-explore/data-diffing.md' + '5-data-diffing/histogram-diff.md': '5-what-you-can-explore/data-diffing.md' + '5-data-diffing/query.md': '5-what-you-can-explore/data-diffing.md' + # PR 7 redirects - CI/CD reorganization + '7-cicd/preset-checks.md': '6-collaboration/preset-checks.md' + # PR 8 redirects - Reference section + '8-technical-concepts/configuration.md': '7-reference/configuration.md' + '8-technical-concepts/state-file.md': '7-reference/state-file.md' + # PR 9 redirects - Community section + '1-whats-recce/community-support.md': '8-community/support.md' - glightbox: skip_classes: - skip-glightbox