index.btft

[table class="topnav"]
[tr]
[td class="logotab"]wiki[e]
[td][see name="index"]home[e][e]
[td][see name="irc"]irc[e][e]
[td][see name="git"]git[e][e]
[td][see name="files"]files[e][e]
[td][url url="u/index.html"]users[e][e]
[e]
[e]
 
[h1]wiki.druid.rocks[e]
 
reference wiki for druid.rocks's public-facing services, and a small open knowledge base anyone with a git.druid.rocks account can add to. not a database-backed wiki app, not rsync/sftp/ftp either anymore - pages are plain btf source (the same tool the rest of the site is built with), published the same way site.git and mp.git already are: `git push`, and a host-side job builds and deploys whatever changed.
 
[h2]reference pages[e]
 
[see name="irc"]irc[e] - connecting to irc.druid.rocks, now public.
 
[see name="git"]git[e] - cloning repos off git.druid.rocks.
 
[see name="files"]files[e] - pulling bulk files off files.druid.rocks.
 
only services with something worth telling a stranger get a page here. cc.druid.rocks, the dev/compile nodes, and mp.druid.rocks (which already has its own docs site) don't.
 
[h2]how this works[e]
 
every account's wiki content lives in that account's own `wiki` repo on git.druid.rocks - a real repo, with real history, same as any other repo here. `druid520/wiki` (this repo) is the one exception: being the site owner's own repo, it deploys to the site root instead of a `u/` subdirectory - everyone else's `<name>/wiki` repo deploys to `wiki.druid.rocks/u/<name>/`. [url url="u/index.html"]u/[e] lists every account with a wiki repo and auto-generates each one a hub page listing what they've published.
 
[h2]getting an account[e]
 
register on [see name="irc"]irc.druid.rocks[e] (self-service, `/REGISTER <email> <password>` once connected), then ask for a git.druid.rocks account - the same account this whole site's git hosting runs on, not a separate wiki-specific one. there's no signup form - an account is one command on this end (`gitadd <key.pub> <name>`), so it's quick once asked for, but it's not automatic and isn't meant to be: this keeps a real person in the loop before anyone gets write access to the domain.
 
[h2]publishing a page[e]
 
once you have a git.druid.rocks account, create your wiki repo the same way you'd create any other repo here - ssh in and run:
 
[code]ssh git@git.druid.rocks -p 2222
git> mk wiki[e]
 
then clone it, add `.btft` pages, and push:
 
[code]git clone ssh://git@git.druid.rocks:2222/<name>/wiki.git
cd wiki
$EDITOR mypage.btft
git add mypage.btft
git commit -m "ADD: mypage.btft"
git push[e]
 
wait up to 5 minutes for the deploy job to pick it up, or just check the site. a broken page never takes down the rest of it - the last good build stays up until it's fixed. no ssh config snippets, no knock ports, no separate upload account - it's exactly the same git workflow as every other repo on this host.
 
[h2]writing a page here[e]
 
keep it lowercase, keep it short, and explain why something is the way it is instead of just what it is. no marketing tone, no "welcome to our wiki!" - this is a reference, not a pitch.
 
pages are btf source (.btft), the same format used for mp's docs and the main site. don't guess the syntax from scratch - read this repo's own `.btft` files (`git clone git://git.druid.rocks/druid520/wiki.git`) or anything under mp's docs/ tree for real, working examples: headings, paragraphs, links to other pages on the same site, links elsewhere, tables, and fenced code all show up there in context. `build.sh` in this repo (`sh build.sh`, needs `btf` on `$PATH` - `git clone git://git.druid.rocks/druid520/btf.git`) renders it locally before you push, if you want to check first.