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

Normalize file naming conventions of directories and markdown files #66

Open
JeremyMcCormick opened this issue May 23, 2024 · 4 comments
Labels
content and organization Site content additions/updates/improvements/fixes

Comments

@JeremyMcCormick
Copy link
Collaborator

Decide whether to use underscores or dashes in file names.

I suggest to use dashes rather than underscores as this is the more common convention.

It would also be appropriate to simply remove spaces entirely, and use instead file names like gettingstarted, instead of getting_started, etc.

@JeremyMcCormick JeremyMcCormick added the content and organization Site content additions/updates/improvements/fixes label May 23, 2024
@molinaro-m
Copy link
Member

I haven't a strong opinion on what solution to choose.
My only comment stays: this will break links here and there (e.g. wiki).
I consider that a minor thing that will solve itself over time.

@JeremyMcCormick
Copy link
Collaborator Author

I haven't a strong opinion on what solution to choose.

My only comment stays: this will break links here and there (e.g. wiki).

I consider that a minor thing that will solve itself over time.

With a site redesign, it would be expected that many links to subpages will be broken, but I don't think that is a reason not to proceed and make the paths and file names more consistent.

@gmantele
Copy link
Member

A common practice in Hugo to build automatically anchors is to replace spaces (and non alpha numerical characters) with a dash. This would make getting-started.

Then, to be consistent with the choice of Hugo, I would prefer the solution to not get rid of spaces but replace them with dashes. Besides, I find it more readable by human eyes (you still see a separation between words ; so, you see more clearly words which makes it more readable).

@JeremyMcCormick
Copy link
Collaborator Author

A common practice in Hugo to build automatically anchors is to replace spaces (and non alpha numerical characters) with a dash. This would make getting-started.

Then, to be consistent with the choice of Hugo, I would prefer the solution to not get rid of spaces but replace them with dashes. Besides, I find it more readable by human eyes (you still see a separation between words ; so, you see more clearly words which makes it more readable).

I am fine with using dashes for readibility instead of getting rid of spaces between words entirely.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content and organization Site content additions/updates/improvements/fixes
Projects
None yet
Development

No branches or pull requests

3 participants