Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Check content dir for for file and folder name validity #2427

Merged
merged 10 commits into from
Dec 16, 2024

Conversation

marians
Copy link
Member

@marians marians commented Dec 13, 2024

The goal is to have more consistent and readable URLs, without underscore in them.

Currently the check finds the following names which will be covered in extra branches:

The following file/folder names use invalid characters. Only lowercase letters, digits, hyphens and period are allowed.
- FILE src/content/vintage/platform-overview/security/Starboard-Scanning-Monitoring.svg
- FILE src/content/vintage/platform-overview/architecture/CAPI_resources.png
- FILE src/content/vintage/platform-overview/architecture/CAPI_architecture.png
- FILE src/content/vintage/advanced/gitops/apps/add_app_template.md
- FILE src/content/vintage/advanced/gitops/apps/app_sets.md
- FILE src/content/vintage/advanced/gitops/apps/automatic_updates_appcr.md
- FILE src/content/vintage/advanced/gitops/apps/update_appcr.md
- FILE src/content/vintage/advanced/gitops/apps/add_appcr.md
- FILE src/content/tutorials/continuous-deployment/apps/add_app_template.md
- FILE src/content/tutorials/continuous-deployment/apps/app_sets.md
- FILE src/content/tutorials/continuous-deployment/apps/automatic_updates_appcr.md
- FILE src/content/tutorials/continuous-deployment/apps/update_appcr.md
- FILE src/content/tutorials/continuous-deployment/apps/add_appcr.md

See https://github.com/giantswarm/docs/actions/runs/12318801597/job/34384349891

@marians marians self-assigned this Dec 13, 2024
@marians marians changed the title Add check for file name validity Add check for file and folder name validity in content dir Dec 13, 2024
@marians marians changed the title Add check for file and folder name validity in content dir Check content dir for for file and folder name validity Dec 13, 2024
@marians
Copy link
Member Author

marians commented Dec 16, 2024

@marians marians mentioned this pull request Dec 16, 2024
@marians marians marked this pull request as ready for review December 16, 2024 09:35
@marians marians requested a review from a team as a code owner December 16, 2024 09:35
Copy link
Contributor

@pipo02mix pipo02mix left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@marians marians merged commit c5bfcb7 into main Dec 16, 2024
8 checks passed
@marians marians deleted the validate-hugo-file-names branch December 16, 2024 10:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants