6.2 KiB
- proto
- intro
- TODOS
- notes
- standard docs
- show undo tree: install undo-tree
- tsr/nn base
- fix M-N-left subtree denoting
- also re: gogs explore/repo thx for pointing that out… solike, if ircbang wants a list of todos that people could help with, I would want it to take the form of what we did with the irc-how-to for example, where now it is implemented in text, git, etherpad, etc.
I want all of my projects to speak for themselves, regardless of what others say!
proto
intro
The purpose of proto is to document a process for projex, etc.
The first step is emacs / pandoc / git. (we've basically solved this)
The next step is that I would like to have a tsr/nn base that has one doc that has all of our projects with links to their docs that take the structure below…
After that I would like to articulate / implement a file directory structure standard for all of these projects.
TODOS
TODO establish a standard directory structure for projex repos
notes: /notnull/proto/src/branch/master/org/standard%20docs I propose:
- a docs/ folder with org/, html/, md/ (for now)
- scripts/ <– not sure about this one. For my purposes this is text processing so should probably go in docs/ ? but for now whatever
- src/ (for projects w/ executable code
- index.html, README.md at the root
README
a 1-paragraph concise summary of:
- the goal / purpose
- the context (e.g. audience, who has access to the project, whether the repo is public/private, etc)
- how to get new people involved in the project (we will need a overarching overview that explains the process which I will get to when I can)
TODOs
the todo contains things that actually need to be done (i.e. action items, these can be linked to pull requests or issues, and eventually we can probably even set up hooks etc.)
the thing that would be REALLY NICE about having these be separate files called todo.org is that it would make it easy to add them to agenda mode. on the other hand, then there would be too many todo.org files.
I also decided I hate the idea of breaking these up into multiple files.
For now I will be including a file _projectName.org in org/ and in .gitignore that I will organize like this one. If I can figure out how to export those separte headers I will; otherwise I"ll do it manually for now.
notes
I want to keep track of these but I don't necessarily want them cluttering up the repos. I use them for, e.g. walking kittens through tutorials, asking you questions and getting answers, etc. I have been putting a notes directory in .gitignore for now I'm going to probably leave this in TODOs because I'm not sure what the answer is yet.
TODO decide on a workflow for exporting html files to /var/www
I'm reluctant to write these directly with a hook because not everything will be ready, some will be a work in progress.
I kind of like the idea of having /var/www/irc.anarchyplanet.org/dox being another repo of dox that pulls only a 'build' branch or something similar, and this build branch having a web hook that runs the pandoc script. That way all of the md and html files will be automatically updated.
(I know that the 'master' branch would be the standard convention but becuause we don't have branch protection I just think doing an unconventional branch would be easier)
TODO decide on / create a tsr/nn base
It's kind of looking like /root/serge/docs/serverl337.org is becoming that base? nn is trying to adapt to tsr's process too :)
this would basically be a single .org file that has all projex (including prok!) on it with a kind of overview of where it's at.
see /notnull/proto/src/branch/master/org/tsr/nn%20base
Here's an example of the kinds of projects I think should be in it:
projects
server backup
<link to the directory or something> <link to the todo file> etc.
projex
prok
proto
tech tuesdays
ircbang
etc.
e.g., things here: https://irc.anarchyplanet.org/git/explore/repos
TODO document an onboarding sequence for AP projex ppl
-
something like:
- SSH
- tmux/wemux
- git
- hidden services
- pandoc
notes
standard docs
I decided that I kind of hate the idea of breaking this up into three files, so I'm currently looking to see if it's possible to export subjections of a single file, e.g.
https://emacs.stackexchange.com/questions/40870/under-org-mode-save-section-of-file-to-another-file
This works well but (1) I don't like how it adds the :PROPERTIES: drawer automatically to the headline, (2) It would need to have an option for controlling the depth, (3) it currently writes pdfs using latex, and the syntax would have to be changed a bit in order to make it work for exporting text. etc.
Anyway, this is peak autismo :P
Ok so it looks like it probably exports the :PROPERTIES: drawer because that's how it gets linked to the file when it gets exported…
But… if I didn't really care about that I'm sure there'd be another way to fix it.
Or, maybe it makes more sense to open the three files in three separate buffers…. I like the idea to merge stuff it is on the same topic.
show undo tree: install undo-tree
tsr/nn base
Another step is coming up with an admin/dev process (i.e. tsr and notnull) I thought that using README.org would be a good way to have the one intro document but I'd say the main function of README.md is to give outsiders an overview of the project, so it doesn't make sense for dev todos and notes. +1
One option might be to have a centralized org doc that links to the directories for our other projects, with TODOs. +1 linking indices among proj would help
Ideally, each directory will have a file (thinking todo.org) that has the todos. - superseeded by agenda mode? then the central document will link to each project directory's todos (also, I will show you about how to use agendamode).
and then each of these will have a repo and then a directory with the file struture outlined in projex (directories = org md html etc etc) and then the files README, todo, and notes can be in any or all of these.
that way when I'm like 'what is tsr working on that I need to know about?' It can all be in one place but also in all o fthe places (repo on gogs, personal directories, etc) I see, you want links to repos and files.
I am not opposed to autoamating the generation of that process by hitting an api that gogs has for that expore place, for example. (or building an API)