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

standardize subfolder names #8

Open
Tracked by #1995
gschare opened this issue Jul 26, 2021 · 9 comments
Open
Tracked by #1995

standardize subfolder names #8

gschare opened this issue Jul 26, 2021 · 9 comments
Assignees
Milestone

Comments

@gschare
Copy link
Collaborator

gschare commented Jul 26, 2021

Subfolders should have consistent naming scheme. Currently the names were just taken from the existing URLs which are not terribly consistent.
First we have to decide on a naming scheme for stuff like students' names, then we must manually go through and correct them.

@njr2128
Copy link
Member

njr2128 commented Jul 27, 2021

This is the information we give our students about file naming instructions: https://docs.google.com/document/d/1XoyUMJYXKR_l-fT_j7KRLAVcSOUmuaCyXJIHIaMfV5U/edit?usp=sharing

In the most recent semesters, the naming protocol for all pages has been:

[last name] - [title] Field Notes [semester abbreviation][year]

Rosenkranz - Verdigris Field Notes FA15

Pre-2017, we may see:

[last name] - [title] [semester abbreviation][year]

Rosenkranz - Verdigris FA15

@njr2128
Copy link
Member

njr2128 commented Jul 27, 2021

various option notes IN PROGRESS

Branscum-Bread-Molding-Field-Notes-SU21

  • all lowercase - names like mcClure
  • names with hyphens, e.g., Ana-Matisse Donefer-Hickie
    donefer-hickie-ana-matisse
    mcclure-david

doneferhickie-anamatisse
donefer-hickie_ana-matisse

@njr2128
Copy link
Member

njr2128 commented Jul 28, 2021

DECISION:
[semester]_[type]_[lastname]_[firstname]_[subject]
delimited with + and - within each field

Examples:

su21_fieldnotes_branscum_elizabeth_bread-molding.html
su21_annotations_branscum_elizabeth_bread-molding.html
su21_profiles_branscum_elizabeth.html

NOTE: all type fields should be plural for consistency (i.e., fieldnotes, annotations, profiles)
(this would allow us to always break out the directory tree from the file name)

@njr2128
Copy link
Member

njr2128 commented Aug 12, 2021

intermediate files and folders:

sp17/
	./sp17_fieldnotes/
		./sp17_fieldnotes_van-buren_ariane/
			./sp17_fieldnotes_van-buren_ariane_verdigris.html

Alternately:

sp17/
	./fieldnotes/
		./van-buren_ariane/
			./sp17_fieldnotes_van-buren_ariane_verdigris.html

DECISION: the second, alternate version

@njr2128
Copy link
Member

njr2128 commented Aug 12, 2021

non-name names

we expect:
[semester]_[type]_[lastname]_[firstname]_[subject]

ORIGINAL PROBLEM - missing field:
example/
sp17_fieldnotes_example_verdigris.html

OPTIONS:
example_/
sp17_fieldnotes_example__verdigris.html

example_example/
sp17_fieldnotes_example_example_verdigris.html

DECISION:

example_/
sp17_fieldnotes_example__verdigris.html

@gschare
Copy link
Collaborator Author

gschare commented Aug 12, 2021

Reasons for 8/12 decisions:
intermediate folders
The purpose of this issue is to make sure each file contains its own metadata in its name so if you e.g. download it and it loses its context that its can still be reconstructed. If the intermediate folders follow the same structure, it just adds unnecessary noise.

folder names that are edge cases
Whatever we choose definitely needs to be consistent and machine-readable. Of the two options, though, the duplication just adds unnecessary noise: example_/ and example_example/ are equivalent in the sense that they can be interchanged with minimal computation, so it makes sense to go with the "dangling underscore" option.

plural vs singular
Consistency over semantics. Either all plural or all singular but definitely not a mix. We decided all plural because it's maybe more straightforward for the moment since the folders are already formatted that way.

@njr2128
Copy link
Member

njr2128 commented Aug 25, 2021

TO SUMMARIZE:

[semester]_[type]_[lastname]_[firstname]_[subject]
delimited with + and - within each field

directory structure and naming:

sp17/
	./fieldnotes/
		./van-buren_ariane/
			./sp17_fieldnotes_van-buren_ariane_verdigris.html

naming for any page without a specific person:

example_/
sp17_fieldnotes_example__verdigris.html

[semester] format:
["fa" | "sp" | "su" ] + [YY]
e.g., "fa17" for fall 2017, or "sp16" for spring 2016, or "su21" for summer 2021

[type] values:

  1. fieldnotes
  2. annotations
  3. profiles

@njr2128
Copy link
Member

njr2128 commented Sep 1, 2021

outstanding to do: Greg to implement this naming scheme

njr2128 added a commit that referenced this issue Sep 1, 2021
@njr2128 njr2128 added this to the v2.0.0 milestone Sep 1, 2021
@njr2128
Copy link
Member

njr2128 commented Sep 6, 2021

We also have new scheme for annotations (detailed in naming-spec.md):

annotations - directory structure and naming:

[semester]/
	./annotations/	
		./[annotation-subject]_[lastname+lastname]/
			./[semester]_annotations_[annotations-subject]_[lastname]_[subject].html

for example:

sp16/
	./annotations/	
		./distemper-and-shadows-beneath-skin_nisse/
			./sp16_annotations_distemper-and-shadows-beneath-skin_nisse_schematic-plan.html

To do: Greg implement this scheme as well

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

No branches or pull requests

2 participants