Note on current project organisation - lmmx/devnotes GitHub Wiki
Current project organisation (may be useful for others to see/compare to) is:
/gits/
contains git-versioned repositories- Time-based projects (e.g "
msc
" for MSc year, "benev
" for internship with benevolent.ai etc.) are stored under~/
- In the case of
~/benev/
, there are 2 types of sub-node: development (code) and notes (documentation in and around projects, which isn't the code itself).- the code is symlinked to a repo under
/gits/
, e.g. to/gits/benev/projectnamegoeshere
- the notes folders are related to other repos I've made in the past, so under
~/benev/
there are:copermut
- service that spins up Wiki with various levels of interactivity, enrichment, connectivity etc. as Wiki projects tend towards with linked data automated services: see permut.codevnotes
- useful for just jotting down pure plaintext notes rather than worrying about going carefully into a notes repo such as this straight away - allowing maturation and ensuring proper confidentiality etc. in sharing technical details on the fly (guarding against accidental disclosures that would otherwise make open source style programming untenable or undesirable)spin
- see spinneret, spin.systems in general [ongoing] and ideas around literature feed services as enrichment (e.g. scholaRbots - at time of writing on hiatus due to technical breakdown)
- the code is symlinked to a repo under
Why?
- nicer to look at ~/ than full
git
path down to project - separation of structure and functional linkage - e.g. overly chaotic gitmodule / git submodule avoidance
Why not?
- Doesn't work nicely with
tmux
: split into a new pane, will show/gits
hidden path... workaround available - If not careful [i.e. without systematic avoidance] splintering of versioned services [e.g. devnotes], falling behind current
Further resources
- Talk by Mozilla Open Science team member (
TODO:annotate
)
Space for improvement
- The movement aliases that go to things would be better done with the tool Samuel Lampa shared a while ago and I never got round to using (Go tool?)
- Note lowercase ensuring deterministic behaviours without
-i
for example with tools likegrep