refactor(aggregation): remove docs/projects/ mirror layer and dead config#100
Merged
Conversation
✅ Deploy Preview for gardenlinux-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
…nfig
The aggregation pipeline previously mirrored fetched docs into
docs/projects/<repo>/ via target_path, transform_directory_structure,
and /projects/-scoped link rewrites. These were never the canonical
output path for VitePress; removing them simplifies the pipeline to a
single copy step.
Removed:
- target_path field from RepoConfig, repos-config.json, and
repos-config.local.json
- transform_directory_structure() (mirror step) and
fix_broken_project_links()
- base_path="/projects" parameter and all /projects/-prefixed link
rewrites from rewrite_links()
- docs/projects from .gitignore, Makefile clean, sidebar
excludePattern, and ignoreDeadLinks
- Project Mirrors section from contributing docs
Dead config eliminated alongside:
- special_files (was always {} in every repo entry)
- dict-style structure (was an identity map for gardenlinux; replaced
by the existing "flat" default)
- unused media_dirs parameter from transform_directory_structure()
- ./same-dir, bare-filename, inside-docs ../, and numbered-prefix link
rewrites (VitePress resolves these natively)
Hardened and simplified:
- RepoConfig.from_dict() now raises ValueError for non-string structure
values
- from_dict() gains sensible defaults: docs_path="docs",
media_directories=[".media", "assets"]
- save_config() omits fields at their default values
Signed-off-by: Eike Waldt <waldt@b1-systems.de>
On-behalf-of: SAP <eike.waldt@sap.com>
Assisted-by: Kilo:claude-opus-4-7
Assisted-by: Kilo:claude-sonnet-4-6
ea06337 to
e7c6a83
Compare
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.
What this PR does / why we need it:
The aggregation pipeline previously mirrored fetched docs into
docs/projects// via target_path, transform_directory_structure,
and /projects/-scoped link rewrites. These were never the canonical
output path for VitePress; removing them simplifies the pipeline to a
single copy step.
Removed:
repos-config.local.json
fix_broken_project_links()
rewrites from rewrite_links()
excludePattern, and ignoreDeadLinks
Dead config eliminated alongside:
by the existing "flat" default)
rewrites (VitePress resolves these natively)
Hardened and simplified:
values
media_directories=[".media", "assets"]