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

Leading ~ character (and maybe others?) cause a 404 error with GH pages #30779

Closed
1 task done
ghfields opened this issue Dec 20, 2023 · 5 comments
Closed
1 task done
Labels
content This issue or pull request belongs to the Docs Content team pages Content related to GitHub Pages waiting for review Issue/PR is waiting for a writer's review

Comments

@ghfields
Copy link

Code of Conduct

What article on docs.github.com is affected?

content/pages/getting-started-with-github-pages/troubleshooting-404-errors-for-github-pages-sites.md

What part(s) of the article would you like to see updated?

An additional cause of a 404 is a directory or filename starting with the ~ character (I tested that ~ in the middle and end of filenames are acceptable). I am unsure what other characters would cause this to occur, but would be helpful if a complete acceptable naming guideline section was added to this document.

Additional information

No response

@ghfields ghfields added the content This issue or pull request belongs to the Docs Content team label Dec 20, 2023
Copy link

welcome bot commented Dec 20, 2023

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team. label Dec 20, 2023
@nguyenalex836
Copy link
Contributor

@ghfields Thanks for opening this issue! I’ll get this triaged for review ✨

@nguyenalex836 nguyenalex836 added pages Content related to GitHub Pages waiting for review Issue/PR is waiting for a writer's review and removed triage Do not begin working on this issue until triaged by the team. labels Dec 20, 2023
@ghfields
Copy link
Author

Thanks. Honestly, I'd be happy if those were valid, since I have a use case for that, but if not, documenting the limitation is the next best thing.

@sophietheking
Copy link
Contributor

@ghfields 👋 Thanks for opening this issue! I checked internally whether it should be possible to use the ~ character at the start of a directory or field name with GitHub Pages, and it should work. Based on my colleague's testing, they suspect Jekyll is the issue. Anytime there is something odd with a file name Jekyll is the usual suspect (you cannot have a file name starting with _ with Jekyll for example).

If you continue having difficulty, please reach out to GitHub Support. We really appreciate you contributing to the community. 🎇

@sophietheking sophietheking closed this as not planned Won't fix, can't repro, duplicate, stale Jan 5, 2024
@ghfields
Copy link
Author

ghfields commented Jan 5, 2024

I appreciate the feedback. I am assuming your colleague confirmed the issue. I believe you are also saying since it is a bug, it won't be documented in the github docs hopes Jekyll is is fixed and will leave the concern undocumented in the meantime. As I don't see any references in this issue, I assume there has not been a Jekyll issue opened. I will do so now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team pages Content related to GitHub Pages waiting for review Issue/PR is waiting for a writer's review
Projects
None yet
Development

No branches or pull requests

3 participants