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

Hyphens #2276

Merged
merged 11 commits into from
Jan 4, 2024
Merged

Hyphens #2276

merged 11 commits into from
Jan 4, 2024

Conversation

rosiel
Copy link
Member

@rosiel rosiel commented Dec 20, 2023

Purpose / why

Addresses #2275

What changes were made?

  • Moved pages that contained underscores in their filenames to use hyphens in the filenames.
  • Left the old pages there as a stub with a redirect, in case anyone bookmarks or uses browser history to get there
  • Updated all the internal links so they point at the new pages

Verification

  • do all .md files have hyphens, not underscores, in their filenames?
  • do all internal links work?

Random

This was my first AI-assisted PR. I had Chat GPT come up with shell scripts to do the renaming.

Interested Parties

  • @Islandora/documentation
  • @Islandora/committers

Checklist

Pull-request Reviewer

Pull-request reviewer should ensure the following:

Person Merging

The person merging should ensure the following:

  • Does mkdocs still build successfully? (This is indicated by TravisCI passing. To test locally, and see warnings, see How To Build Documentation.)
  • If pages are renamed or removed, have all internal links to those pages been fixed?
  • If pages are added, have they been linked to or placed in the menu?
  • Did the PR receive at least one approval from a committer, and all issues raised have been addressed?

Copy link

github-actions bot commented Dec 20, 2023

PR Preview Action v1.4.6
Preview removed because the pull request was closed.
2024-01-04 18:10 UTC

docs/contributing/create_issues.md Outdated Show resolved Hide resolved
docs/contributing/create_issues.md Outdated Show resolved Hide resolved
Copy link
Member

@seth-shaw-asu seth-shaw-asu left a comment

Choose a reason for hiding this comment

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

It appears some of the pages were not copied into their hyphen equivalent pages.

docs/contributing/create_issues.md Outdated Show resolved Hide resolved
docs/contributing/docs_style_guide.md Outdated Show resolved Hide resolved
@rosiel
Copy link
Member Author

rosiel commented Jan 4, 2024

Let's see if this works - I added a redirects plugin (added it in requirements.txt and the How to build documentation page). On my box, the redirects work great. There's a list of them in the mkdocs.yml file.

Copy link
Member

@seth-shaw-asu seth-shaw-asu left a comment

Choose a reason for hiding this comment

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

🎆

@seth-shaw-asu seth-shaw-asu merged commit d537272 into main Jan 4, 2024
1 check passed
@rosiel rosiel deleted the hyphens branch January 4, 2024 18:10
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