summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Joey Hess <joey@kitenet.net>2010-10-19 19:28:29 -0400
committerGravatar Joey Hess <joey@kitenet.net>2010-10-19 19:28:29 -0400
commit9d5b8ebab0e247c5c9c05a5216dcd4c638299190 (patch)
tree94dbc073f44c0acd6875a00441e2a24fa7e7a67a
parente7572f9249f0e4c3f757bb8da889a41f53fd9e34 (diff)
update
-rw-r--r--Makefile3
-rw-r--r--doc/bugs.mdwn2
-rw-r--r--doc/bugs/done.mdwn3
-rw-r--r--doc/index.mdwn18
-rw-r--r--doc/not.mdwn10
-rw-r--r--doc/templates/bare.tmpl1
-rw-r--r--doc/use_case/Alice.mdwn18
-rw-r--r--doc/use_case/Bob.mdwn18
8 files changed, 70 insertions, 3 deletions
diff --git a/Makefile b/Makefile
index 39f5ba8ad..d35e82ad5 100644
--- a/Makefile
+++ b/Makefile
@@ -19,7 +19,8 @@ endif
docs:
./mdwn2man git-annex 1 doc/git-annex.mdwn > git-annex.1
$(IKIWIKI) doc html -v --wikiname git-annex --plugin=goodstuff \
- --no-usedirs --disable-plugin=openid
+ --no-usedirs --disable-plugin=openid --plugin=sidebar \
+ --underlaydir=/dev/null
clean:
rm -rf build git-annex git-annex.1
diff --git a/doc/bugs.mdwn b/doc/bugs.mdwn
index dd2a9b403..2786e5bf7 100644
--- a/doc/bugs.mdwn
+++ b/doc/bugs.mdwn
@@ -1,4 +1,4 @@
This is git-annex's bug list. Link bugs to [[bugs/done]] when done.
[[!inline pages="./bugs/* and !./bugs/done and !link(done)
-and !*/Discussion" actions=yes postform=yes show=0]]
+and !*/Discussion" actions=yes postform=yes show=0 archive=yes]]
diff --git a/doc/bugs/done.mdwn b/doc/bugs/done.mdwn
index ad332e2a2..a35d42719 100644
--- a/doc/bugs/done.mdwn
+++ b/doc/bugs/done.mdwn
@@ -1,3 +1,4 @@
recently fixed [[bugs]]
-[[!inline pages="./* and link(./done) and !*/Discussion" sort=mtime show=10]]
+[[!inline pages="./* and link(./done) and !*/Discussion" sort=mtime show=10
+archive=yes]]
diff --git a/doc/index.mdwn b/doc/index.mdwn
index e30326853..b3a871627 100644
--- a/doc/index.mdwn
+++ b/doc/index.mdwn
@@ -11,11 +11,28 @@ versioned files, which is convenient for maintaining documents, Makefiles,
etc that are associated with annexed files but that benefit from full
revision control.
+[[!sidebar content="""
* **[[download]]**
* [[install]]
* [[news]]
* [[bugs]]
* [[contact]]
+"""]]
+
+
+## sample use cases
+
+<table>
+<tr>
+<td>[[!inline feeds=no template=bare pages=use_case/bob]]</td>
+<td>[[!inline feeds=no template=bare pages=use_case/alice]]</td>
+</tr>
+</table>
+
+If that describes you, or if you're some from column A and some from column
+B, then git-annex may be the tool you've been looking for to expand from
+keeping all your small important files in git, to managing your large
+files with git.
## documentation
@@ -24,6 +41,7 @@ revision control.
* [[location_tracking]] reminds you where git-annex has seen files
* git-annex prevents accidential data loss by [[tracking copies|copies]]
of your files
+* [[what git annex is not|not]]
* git-annex is Free Software, licensed under the [[GPL]].
----
diff --git a/doc/not.mdwn b/doc/not.mdwn
new file mode 100644
index 000000000..2697a9b1f
--- /dev/null
+++ b/doc/not.mdwn
@@ -0,0 +1,10 @@
+[[!meta title="what git-annex is not"]]
+
+* git-annex is not a backup system. It may be a useful component of an
+ [[archival|use_case/bob]] system, or a way to deliver files to a backup
+ system.
+
+ For a backup system that uses git, take a look at
+ [bup](http://github.com/apenwarr/bup).
+
+* probably several other things..
diff --git a/doc/templates/bare.tmpl b/doc/templates/bare.tmpl
new file mode 100644
index 000000000..2d476b716
--- /dev/null
+++ b/doc/templates/bare.tmpl
@@ -0,0 +1 @@
+<TMPL_VAR CONTENT>
diff --git a/doc/use_case/Alice.mdwn b/doc/use_case/Alice.mdwn
new file mode 100644
index 000000000..c42eb3a74
--- /dev/null
+++ b/doc/use_case/Alice.mdwn
@@ -0,0 +1,18 @@
+### The Nomad
+
+Alice is always on the move, often with her trusty netbook and a small
+handheld terabyte USB drive, or a smaller USB keydrive. She has a server
+out there on the net. All these things can have different files on them,
+but Alice no longer has to deal with the tedious process of keeping them
+manually in sync.
+
+When she has 1 bar on her cell, Alice queues up interesting files on her
+server for later. At a coffee shop, she has git-annex download them to her
+USB drive. High in the sky or in a remote cabin, she catches up on
+podcasts, videos, and games, first letting git-annex copy them from
+her USB drive to the netbook (this saves battery power).
+
+When she's done, she tells git-annex which to keep and which to remove.
+They're all removed from her netbook to save space, and Alice knowns
+that next time she syncs up to the net, her changes will be synced back
+to her server.
diff --git a/doc/use_case/Bob.mdwn b/doc/use_case/Bob.mdwn
new file mode 100644
index 000000000..a5dc01b37
--- /dev/null
+++ b/doc/use_case/Bob.mdwn
@@ -0,0 +1,18 @@
+### The Archivist
+
+Bob has many drives to archive his data, most of them kept offline, in a
+safe place.
+
+With git-annex, Bob has a single directory tree that includes all
+his files, even if their content is being stored offline. He can
+reorganize his files using that tree, committing new versions to git,
+without worry about accidentially deleting anything.
+
+When Bob needs access to some files, git-annex can tell him which drive(s)
+they're on, and easily make them available. Indeed, every drive knows what
+is on every other drive.
+
+Run in a cron job, git-annex adds new files to achival drives at night. It
+also helps Bob keep track of intentional, and unintentional copies of
+files, and logs information he can use to decide when it's time to duplicate
+the content of old drives.