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

Path collisions docs/src/{SUMMARY,summary}.md #1580

Open
grekko opened this issue Jun 13, 2023 · 1 comment · May be fixed by #1617
Open

Path collisions docs/src/{SUMMARY,summary}.md #1580

grekko opened this issue Jun 13, 2023 · 1 comment · May be fixed by #1617
Labels

Comments

@grekko
Copy link

grekko commented Jun 13, 2023

Description

When cloning the current repository on a case-insensitive file system git warns about path collisions:

git clone https://github.com/thoughtbot/factory_bot.git tmp
…

warning: the following paths have collided (e.g. case-sensitive paths
on a case-insensitive filesystem) and only one from the same
colliding group is in the working tree:

  'docs/src/SUMMARY.md'
  'docs/src/summary.md'

Reproduction Steps

Create a case sensitive file system and clone the repository:

git clone https://github.com/thoughtbot/factory_bot.git tmp

Expected behavior

No issues for users with case-insensitive file systems.

Proposed changes

The 2 conflicting file paths are:

  • docs/src/summary.md: An intro describing the contents
  • docs/src/SUMMARY.md: An index file listing the relevant individual docs

How about renaming docs/src/summary.md to docs/src/readme.md and renaming docs/src/SUMMARY.md to docs/src/summary.md.

docs/src/readme.md should be read first when looking at the docs.
docs/src/summary.md seems to be the default pattern for similar files in sub-directories.

See PR proposal here #1581

@grekko grekko added the bug label Jun 13, 2023
@grekko grekko changed the title Case insensitive files docs/src/{SUMMARY,summary}.md Path collisions docs/src/{SUMMARY,summary}.md Jun 13, 2023
grekko added a commit to grekko/factory_bot that referenced this issue Jun 13, 2023
@grekko
Copy link
Author

grekko commented Jun 13, 2023

I hope this does not break any links/references to the documents. I searched for references to SUMMARY.md in this repository but there could be external links or other dependencies on the file names 🤔

Maybe those who recently worked on the big docs refactoring have better knowledge and can check if my proposed changes are breaking anything.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant