Rename content files to their desired name #941
Draft
MuhammadAashirAslam wants to merge 1 commit into
Draft
Conversation
Strip redundant path-echoing prefixes from native content/ filenames now that the folder hierarchy provides the context (e.g. configuration-action.md -> configuration/advanced/action.md). Section overview pages become overview.md within their folder. Permalinks are intentionally left untouched, so every published URL is unchanged and the Jekyll build stays green. Also fixes a few internal links that referenced old source filenames to use the page permalinks. The two porting guides (couple-your-code-porting-v1-2.md and couple-your-code-porting-v2-3.md) are intentionally kept at their original names. They legitimately contain old preCICE API names, and the check-old-precice pre-commit hook skips them by matching "porting" in the filename. Renaming them would drop that match and fail the hook, so they are left as-is rather than weakening the hook. Scope: native content/ only. Imported content (imported/**) is handled separately via precice#590 mounts.
MuhammadAashirAslam
changed the title
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
1 participant
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.
Rename content files to their desired name
Removes the redundant path-echoing prefixes from native
content/filenames nowthat the folder hierarchy (from #580) provides the context, e.g.:
content/docs/configuration/advanced/configuration-action.md→.../action.mdcontent/docs/installation/building-from-source/installation-source-configuration.md→.../configuration.mdSection overview/landing pages become
overview.mdwithin their folder(e.g.
tutorials.md→tutorials/overview.md, as suggested in the issue).URLs are unchanged
Every page keeps its existing
permalink:front matter untouched, so Jekyllpublishes the exact same
*.htmlURLs as before.bundle exec jekyll buildpasses and the generated
_site/URL set is identical. A few internal linksthat referenced old source filenames were updated to point at the page permalinks.
Exception: two porting guides keep their original names
content/docs/couple-your-code/porting/couple-your-code-porting-v1-2.mdandcouple-your-code-porting-v2-3.mdare intentionally not renamed. Thesemigration guides legitimately contain old preCICE API names, and the
check-old-precicepre-commit hook skips them by matching"porting"in thefilename. Renaming them (e.g. to
v1-2.md) would drop that match and makethe hook fail. Rather than weakening the hook, the two files are left as-is.
(If preferred, the hook's
fileFiltercould match the path/directory instead ofjust the filename in a follow-up.)
Scope
Native
content/only. Imported adapter/tutorial content (imported/**) ishandled separately via module mounts in #590.
Closes #589 (and #538).