hpr_documentation/directory-structure.md

74 lines
2.4 KiB
Markdown
Raw Normal View History

2024-12-25 14:11:18 +00:00
# Goal
HPR is dedicated to sharing knowledge and as such it should be possible for someone to have the files locally and play them on a mp3 player.
It should be possible to post the entire backlog to someone and have them plug it in and for any media player be able to play it. Each episode has it's own "album" which corresponds to a directory. The directory structure is kept as flat as possible with everything related to show 9876 in a single directory `hpr9876`. This is the least common denominator, and in no way precludes web services, or other applications.
We do however need to support other functionality so the _Episodes_ are kept inside of the `eps` directory, the _Hosts_ are in `hosts/`, and _Series_ are in `series/`.
# Layers
We get files from different locations. The source files are delivered by the hosts, some are generated by processing, and others are added by the Janitors that cleanup the show notes.
All these are combined and end up as a complete entity, on one of the HPR [Origin servers](https://en.wikipedia.org/wiki/Upstream_server).
From there is delivered made available via RSS, etc.
<!--
TODO
## Upload
In our worked example a host uploads a show recorded in an audio file in [flac](https://en.wikipedia.org/wiki/FLAC) format.
The show is about a bash script which they also attach.
They describe the show in show notes, and include an image of the output.
files will be distributed using the C
The show processing supports the building of this structure,
This is how the
The `hpr_generator` places episodes are in `eps/`,
Everything related to a given show should be in the
We need to base our requirements on our own requirements and not those imposed by the IA.
It should be possible for someone to `rsync` the entire site and store it locally for use with a file manager/or media player.
To make file management clear all files must begin with the episode number `hpr9876`.
Supplemental files should be p
If there is a possibility of a clash then we need to ensure that we manage that by avoiding upload names.
should layer ontop of that so `/path/to/disk/hpr/` is the root and then `eps
If any of the sites (The IA) require special treatment, then that's fine but it's a deviation from our structure.
https://archive.org/details/hpr4230 →
The directory structure imposed by IA is less than ideal when it comes to our requirements.
-->