search

SAA-SDT / EAS-Best-Practices

The Encoded Archival Standards: Best Practice Guide is a resource that describes and provides explanations and examples of complex encodings and concepts in EAC-CPF and EAD. Created and maintained by SAA TS-EAS, the guide is intended to be a living resource that will be built on and developed over time.
https://saa-sdt.github.io/EAS-Best-Practices/
4 stars 4 forks source link

Casing question for repo titles #1

Closed fordmadox closed 2 years ago

fordmadox commented 2 years ago

Just a note that casing seems to matter for GH pages by default. There might be workarounds for this, but since URLs are case sensitive, perhaps we should go with a lower-case names for any repos that will include web pages?

Examples:

I'm not sure if we should have a rule or not that acronyms are always capitalized, but this is a good reason to not adopt that rule perhaps :)

Note, however, that it does look like GH will provide re-directs for file URLs and its own pages, e.g. in the "EAD3" repo:

karinbredenberg commented 2 years ago

I would go for one type of casing and since we havent promoted or filled this repository yet make the change as soon as possible.

kerstarno commented 2 years ago

Agree with Karin: one type of casing (i.e. either all small letters or with capitalisation for acronyms and the start of any nouns). Plus, if the name consists of several terms, use hyphen between the terms for readability.

That being said: it looks like the capitalised URLs are generally working better?

fordmadox commented 2 years ago

We're keeping things as is and not worrying about the case sensitivity.