Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
85 changes: 85 additions & 0 deletions docs/CLEANUP-TODO.md
Original file line number Diff line number Diff line change
@@ -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
```
13 changes: 13 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,19 @@ plugins:
'7-cicd/setup-ci.md': '2-getting-started/setup-ci.md'
'7-cicd/ci-cd-getting-started.md': '2-getting-started/environment-setup.md'
'7-cicd/best-practices-prep-env.md': '2-getting-started/environment-best-practices.md'
'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'
'7-cicd/preset-checks.md': '6-collaboration/preset-checks.md'
'8-technical-concepts/configuration.md': '7-reference/configuration.md'
'8-technical-concepts/state-file.md': '7-reference/state-file.md'
'1-whats-recce/community-support.md': '8-community/support.md'
- glightbox:
skip_classes:
- skip-glightbox
Expand Down