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

Massive overwrite, fixing all of the linter issues that were cropping up whilst editing the repository. #93

Open
wants to merge 38 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
38 commits
Select commit Hold shift + click to select a range
72e3156
🚨 CHANGED: ./CONTRIBUTING.md
mitsuo-makuda May 25, 2024
149349a
🚨 CHANGED: ./README.md
mitsuo-makuda May 25, 2024
169c2f9
🚨 CHANGED: ./root/README.md
mitsuo-makuda May 25, 2024
f00b4a1
🚨 CHANGED: ./root/archives/README.md
mitsuo-makuda May 25, 2024
712d431
🚨 CHANGED: ./root/archives/datasets/README.md
mitsuo-makuda May 25, 2024
fe1201d
🚨 CHANGED: ./root/archives/datasets/research/README.md
mitsuo-makuda May 26, 2024
f816dbf
🚨 CHANGED: ./root/archives/datasets/statistics/README.md
mitsuo-makuda May 26, 2024
839e6e0
🚨 CHANGED: ./root/archives/news/README.md
mitsuo-makuda May 26, 2024
cd64793
🚨 CHANGED: ./root/archives/sientific/README.md
mitsuo-makuda May 26, 2024
4e8f76a
🚨 CHANGED: ./root/archives/websites/README.MD
mitsuo-makuda May 26, 2024
52078e8
🚨 CHANGED: ./root/audio/README.MD
mitsuo-makuda May 26, 2024
5d8bd98
🚨 CHANGED: ./root/audio/music/README.md
mitsuo-makuda May 26, 2024
92e772d
🚨 CHANGED: ./root/audio/soundtracks/README.md
mitsuo-makuda May 26, 2024
ed534cd
🚨 CHANGED: ./root/documents/README.md
mitsuo-makuda May 26, 2024
5d1eb2d
🚨 CHANGED: ./root/games/README.MD
mitsuo-makuda May 26, 2024
92154c8
🐛 UPDATE: Fixed the resource link's alternate text.
mitsuo-makuda May 26, 2024
6a5b407
🚨 CHANGED: ./root/games/sport/README.md
mitsuo-makuda May 26, 2024
c2a4074
🚨 CHANGED: ./root/games/video/arcade/README.md
mitsuo-makuda May 26, 2024
e15dd25
🚨 CHANGED: ./root/games/video/computer/README.md
mitsuo-makuda May 26, 2024
8abea6c
🚨 CHANGED: ./root/games/video/console/README.md
mitsuo-makuda May 26, 2024
718d512
🚨 CHANGED: ./root/games/video/handheld/README.md
mitsuo-makuda May 26, 2024
9b7b6d2
🚨 CHANGED: ./root/games/video/mobile/README.md
mitsuo-makuda May 26, 2024
738cd58
🚨 CHANGED: ./root/images/README.md
mitsuo-makuda May 26, 2024
304fab2
🚨 CHANGED: ./root/images/photos/README.md
mitsuo-makuda May 26, 2024
bd975c0
🚨 CHANGED: ./root/literature/README.MD
mitsuo-makuda May 26, 2024
0277f75
🚨 CHANGED: ./root/software/README.md
mitsuo-makuda May 26, 2024
aa34ff9
🚨 CHANGED: ./root/software/Applications/README.md
mitsuo-makuda May 26, 2024
850afec
🚨 CHANGED: ./root/software/firmware/README.md
mitsuo-makuda May 26, 2024
d22b7f6
🚨 CHANGED: ./root/software/scripts/README.md
mitsuo-makuda May 26, 2024
17a74ae
🚨 CHANGED: ./root/software/source/README.md
mitsuo-makuda May 26, 2024
1aeb911
🚨 CHANGED: ./root/software/systems/README.md
mitsuo-makuda May 26, 2024
2063d4e
🚨 CHANGED: ./root/video/README.MD
mitsuo-makuda May 26, 2024
65dd4d2
🚨 CHANGED: ./root/video/discs/README.MD
mitsuo-makuda May 26, 2024
66daf80
🚨 CHANGED: ./root/video/movies/README.md
mitsuo-makuda May 26, 2024
ee0f78d
🚨 CHANGED: ./root/video/tv-anime/README.md
mitsuo-makuda May 26, 2024
526412e
🚨 CHANGED: ./root/video/tv-shows/README.MD
mitsuo-makuda May 26, 2024
a0a5e6b
🚨 CHANGED: ./root/video/web/README.md
mitsuo-makuda May 26, 2024
e8f9afe
🚨 CHANGED: ./root/software/typefaces/README.md
mitsuo-makuda May 26, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 2 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ If you want to help out and contribute to this filetree, please follow this basi

* create/extends the folder structure → e.g. `/root/foo/bar`

* make sure the deeply nested folder contains at least one placeholder file →
* make sure the deeply nested folder contains at least one placeholder file →

`/root/foo/bar/example.doc`

Expand All @@ -26,17 +26,14 @@ If you want to help out and contribute to this filetree, please follow this basi

please create a new branch on your fork with this pattern: `user/nickname`



------

## Issues

We also welcome any discussion in the *issues* section. Feel free to open a new issue if you see something missing or an error. You can also help discuss uncertain topics and contribute by posting your opinion on certain structures/namings/etc.


------

## Further Notes:
## Further Notes

* If you are going to refactor a certain section or want to add a completely new section, we'd appreciate it that you create a feature branch for it, since that makes it a lot easier tracking the project and handling pull-requests.
9 changes: 1 addition & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ Hello and welcome to the [r/datacurator](https://reddit.com/r/datacurator) filet

We aim to create a unified filetree for all kinds of data, which should help in storing, categorising and retrieving.


Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

MD012/no-multiple-blanks: Multiple consecutive blank line [Expected: 1, Actual: 2] markdownlint(MD012)


Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

MD012/no-multiple-blanks: Multiple consecutive blank line [Expected: 1, Actual: 3] markdownlint(MD012)

## Branches

You are now looking at the default full-blown filetree. Often times you don't need that. So we have a few other variants that you can use, which may better fit your use-case.
Expand All @@ -22,16 +20,11 @@ You are now looking at the default full-blown filetree. Often times you don't ne
>
> We will try to review and incorporate it here.


Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

MD012/no-multiple-blanks: Multiple consecutive blank line [Expected: 1, Actual: 2] markdownlint(MD012)


Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

MD012/no-multiple-blanks: Multiple consecutive blank line [Expected: 1, Actual: 3] markdownlint(MD012)


Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

MD012/no-multiple-blanks: Multiple consecutive blank line [Expected: 1, Actual: 4] markdownlint(MD012)

## Overview

Here is a quick screenshot on what the current tree looks like (occasionally updated).

![](overview.png)
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

MD045/no-alt-text: Images should have alternate text (alt text) markdownlint(MD045)


Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

MD012/no-multiple-blanks: Multiple consecutive blank line [Expected: 1, Actual: 2] markdownlint(MD012)


Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

MD012/no-multiple-blanks: Multiple consecutive blank line [Expected: 1, Actual: 3] markdownlint(MD012)

![file-tree](overview.png)

## Contributing

Expand Down
8 changes: 2 additions & 6 deletions root/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ Usually people use an external drive, a network share exposed by a NAS or even b

The **root** defines several *main sections*. These main sections allow for an easy seperation of content and should stay within a certain cognitive complexity.



## Overview

| Folder | Contents |
Expand All @@ -22,8 +20,6 @@ The **root** defines several *main sections*. These main sections allow for an e
| software | Computer Applications, Mobile Apps, Operating Systems |
| video | Movies, Short Movies/Films, TV-Shows, ... |



## General Advice

In this Section we want to give you some general advice on things you should be aware of.
Expand All @@ -34,7 +30,7 @@ These are optional and sometimes biased. If you do not agree to them - be it par

1. Naming in General

Naming is hard. We know that. You want everything neat and tidy, but sometimes things just don't go that way - and that is perfectly fine. **Don't be afraid to break the rules and adjust this tree to your needs.**
Naming is hard. We know that. You want everything neat and tidy, but sometimes things just don't go that way - and that is perfectly fine. **Don't be afraid to break the rules and adjust this tree to your needs.**

2. Technical Issues

Expand All @@ -45,7 +41,7 @@ Here is a small (and incomplete) list of characters you should avoid (AKA "Forbi
- *Please use this list as a general rule of thumb.*
- *The List applies to all major operating systems.*

```
```txt
File Seperators:
: (colon)
/ (forward slash)
Expand Down
8 changes: 3 additions & 5 deletions root/archives/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# ./archives

## Content

The archives section has the least strict rules about file allocation for any top-level directory, however, it is still important that it is understood what can go in the section and what cannot. Generally, any particular file that you struggle to allocate to any top-level directory can typically be put into the archives directory, as those files will typically be for 'archival' purposes. The only potential exception is creative assets, as these can often be actively used, so these could also be split into a new top-level directory if you choose.
Expand All @@ -13,10 +15,6 @@ The archives section has the least strict rules about file allocation for any to
| websites | snapshots of websites at a specific time |
| | |



## Patterns



## Resources
## Resources
11 changes: 4 additions & 7 deletions root/archives/datasets/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
# Content
# ./archives/datasets

collections of data, typically in tabular format
## Content

Collections of data, typically in tabular format




- https://en.wikipedia.org/wiki/Data_set

- [Data set](https://en.wikipedia.org/wiki/Data_set)
3 changes: 2 additions & 1 deletion root/archives/datasets/research/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# ./archives/datasets/research

Example Datasets for Machine Learning Research:

- CIFAR-10, CIFAR-100
- MNIST
- FIND

3 changes: 2 additions & 1 deletion root/archives/datasets/statistics/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# ./archives/datasets/statistics

Tabular Data for Statistics

- mostly CSV, XLSX, XML, JSON

1 change: 0 additions & 1 deletion root/archives/news/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
# News

> Information/intel about events/history, including leaked confidential data.

7 changes: 6 additions & 1 deletion root/archives/sientific/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,16 @@
# ./archives/scientific

For scientific papers

Naming scheme could be:

```html
<year> <author> - <(short) title> (<DOI>)
```

DOI would be optional.

For author you can use:
One: [author 1]
Two: [author 1] & [author 2]
Three or more: [author1] et al.
Three or more: [author1] et al.
4 changes: 3 additions & 1 deletion root/archives/websites/README.MD
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# ./archives/websites

## Content

Basically snapshots/dumps/rips of a given website/webapp bound to a point in time.
Expand All @@ -10,4 +12,4 @@ Basically snapshots/dumps/rips of a given website/webapp bound to a point in tim

## Resources

- https://archive.org/
- [Archive.org](https://archive.org/)
12 changes: 7 additions & 5 deletions root/audio/README.MD
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# ./audio

## Content

The (digital) audio section contains any kind of sound that is contained within a file - such as music, sounds, sound effects, podcasts, audiobooks, event recordings (musicals, concerts, standup comedy), games and many others.
Expand All @@ -22,7 +24,7 @@ File naming among music files is a very common topic among enthusiasts and it di

Please feel free to create your own pattern, by reading through the many many forum posts that people started. If you want a quickstart, here are a few common patterns:

```
```md
# + --------------------------------------------------------------------------------
# | Music

Expand All @@ -46,7 +48,7 @@ ALBUM_ARTIST/ALBUM_ARTIST - ALBUM (YEAR) [FORMAT]/CD N/TRACKNR - ARTIST - TRACKT

## Resources

- https://musicbrainz.org/ - A community-maintained music metadata database.
- https://www.discogs.com/ - A database and marketplace for music.
- https://hydrogenaud.io/ - A community for discussion of audio technology.
- http://beets.io/ - A command-line based music tagger and cataloger.
- [A community-maintained music metadata database.](https://musicbrainz.org/)
- [A database and marketplace for music.](https://www.discogs.com/)
- [A community for discussion of audio technology.](https://hydrogenaud.io/)
- [A command-line based music tagger and cataloger.](http://beets.io/)
18 changes: 10 additions & 8 deletions root/audio/music/README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,30 @@
# ./audio/music

Artist
\ Artist - Year - Album [SOURCE - FORMAT - RES] {Catalog/Info}
\ Disc#-Track# - TrackTitle
\ Artist - Year - Album [SOURCE - FORMAT - RES] {Catalog/Info}
\ Disc#-Track# - TrackTitle

Notes:

- Artist is case sensitive
- Unicode is possible, if you have problems - refer to plain ASCII
- The `{Catalog/Info}` is optional
- should be used if Logs are present or you are 100% sure of the content
- Almost always applies to CD only
- Should be used if Logs are present or you are 100% sure of the content
- Almost always applies to CD only
- `Disc#-` is optional if one likes to avoid CD1,CD2 subfolders
- In case of FLAC+Logfile splitted folders are considered best practice.
- In case of FLAC+Logfile splitted folders are considered best practice.

Examples:

```
```md
A Great Big World - 2014 - Is There Anybody Out There [CD - FLAC - Lossless]

Adele - 2015 - 25 [CD - FLAC - Lossless] {XLCD740}
Adele - 2015 - Hello [WEB - FLAC - Lossless]

Alligatoah - 2015 - Musik ist keine Lösung (Limited Deluxe Edition) [CD - FLAC - Lossless]
\ CD1,CD2,CD3 |or| Disc 1, Disc 2, Disc 3
\ CD1,CD2,CD3 |or| Disc 1, Disc 2, Disc 3


Billy Talent - 2009 - III [CD - ALAC - Lossless] {Unknown Release}
```
```
17 changes: 5 additions & 12 deletions root/audio/soundtracks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,12 @@

> Music and sound specifically created/composed/compiled for a movie, television show or videogame etc.



**NOTE:**

This folder is pretty much **optional**. Every Soundtrack usually comes with an album-artist, composer, artist, etc.

This folder only exists for people who like to separate the common `artist - album` releases from soundtracks specifically. Reasons vary, but you can usually find things faster when it's splitted.



## Variants

Soundtracks:
Expand All @@ -28,7 +24,7 @@ Soundtracks:

> An officially released album that contains music from the original in-game audio.
>
> Examples:
> Examples:
>
> - Chrono Trigger Original Sound Version

Expand All @@ -41,18 +37,15 @@ Soundtracks:
> - Title (Score)
> - Title (Soundtrack)

```
```md
Music From The Original Motion Picture Soundtrack
Music From And Inspired By The Motion Picture
```



## Resources

- https://en.wikipedia.org/wiki/Soundtrack

- https://en.wikipedia.org/wiki/Soundtrack_album
- [Soundtrack](https://en.wikipedia.org/wiki/Soundtrack)

- https://en.wikipedia.org/wiki/Video_game_music
- [Soundtrack album](https://en.wikipedia.org/wiki/Soundtrack_album)

- [Video game music](https://en.wikipedia.org/wiki/Video_game_music)
6 changes: 4 additions & 2 deletions root/documents/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# ./documents

## Content

Personal documents like letters, poems, forms, bills, etc.
Expand All @@ -14,11 +16,11 @@ One of the most common file naming schemes is the use of the date in ISO8601 for

> 2019-09-01 - August 2019 Utilities Bill.pdf

```
```md
# TODO: Personal File Naming Patterns
# e.g. bills (yyyy-mm-dd - 20 char description.pdf)
```

## Resources

- http://www.asianefficiency.com/organization/organizing-files-folders-documents/
- [How to Organize Files, Folders and Documents For Maximum Productivity](http://www.asianefficiency.com/organization/organizing-files-folders-documents/)
7 changes: 1 addition & 6 deletions root/games/README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,12 @@

> A game is a structured form of play, usually undertaken for entertainment or fun, and sometimes used as an educational tool.



For archiving games, we must shift our focus away from the pure videogame section towards the broader landscape that is interactive entertainment. There is a lot to cover, but we try to keep it simple.

If you only use this games folder for videogames, you can remove the other folders and reduce the depth a bit. Each Section here has enough sub-sections to deal with. You can (and should) always keep it as flat as possible until you outgrow that system and need to nest more.

Folder names are intentionally lowercase to not mess with different systems and to have a cli friendy structure. You can change that if you wish to, especially further down e.g. on the individual videogame systems or on certain tabletop games. It really depends if you curate for accessiblity or for pure archival.



## Resources

- https://en.wikipedia.org/wiki/Game

- [Game](https://en.wikipedia.org/wiki/Game)
3 changes: 1 addition & 2 deletions root/games/sport/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
# Sport Games

>

>
1 change: 0 additions & 1 deletion root/games/video/arcade/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
# Arcade

8 changes: 2 additions & 6 deletions root/games/video/computer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

> Mainly Linux, Mac and Windows



Potential Naming Options

| <~ | ~~ | ~> |
Expand All @@ -12,9 +10,7 @@ Potential Naming Options
| win | windows | Windows |
| nix | linux | Linux |



## Resources

- https://en.wikipedia.org/wiki/PC_game
- https://en.wikipedia.org/wiki/Mac_gaming
- [PC game](https://en.wikipedia.org/wiki/PC_game)
- [Mac gaming](https://en.wikipedia.org/wiki/Mac_gaming)
9 changes: 1 addition & 8 deletions root/games/video/console/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

> = Home Video Game Consoles



Potential Folder Names for each Platform/System (short→long)

```ini
Expand All @@ -16,8 +14,6 @@ Sony PlayStation

> Use the style that fits your case best. If you have lots of automation, you appreciate the shorter and lowercase+dashed variants. If you want a "nice to browse" collection, choose the longer and explicit style.



Each System Folder may include

- Games
Expand All @@ -27,9 +23,6 @@ Each System Folder may include
- Instructions, Manuals, Booklets
- Design Documents



## Resources

- https://en.wikipedia.org/wiki/List_of_home_video_game_consoles

- [List of home video game consoles](https://en.wikipedia.org/wiki/List_of_home_video_game_consoles)
Loading