summaryrefslogtreecommitdiff
path: root/doc/assistant
diff options
context:
space:
mode:
authorGravatar Joey Hess <joey@kitenet.net>2012-11-11 17:36:57 -0400
committerGravatar Joey Hess <joey@kitenet.net>2012-11-11 17:36:57 -0400
commit8881c671d3bbd0c7a31fac0746146a4dea5729b1 (patch)
tree5823ea397ffaa6b46fbf9e3d8e529dc2b634d873 /doc/assistant
parent6068fd160ffeb930368a4c4c2a8818ace71f29ab (diff)
add a new walkthrough for xmpp pairing
Diffstat (limited to 'doc/assistant')
-rw-r--r--doc/assistant/pairing_walkthrough.mdwn13
-rw-r--r--doc/assistant/share_with_a_friend_walkthrough.mdwn58
-rw-r--r--doc/assistant/share_with_a_friend_walkthrough/buddylist.pngbin0 -> 5114 bytes
-rw-r--r--doc/assistant/share_with_a_friend_walkthrough/repolist.pngbin0 -> 8525 bytes
-rw-r--r--doc/assistant/share_with_a_friend_walkthrough/xmppalert.pngbin0 -> 4070 bytes
5 files changed, 66 insertions, 5 deletions
diff --git a/doc/assistant/pairing_walkthrough.mdwn b/doc/assistant/pairing_walkthrough.mdwn
index 4c0b7f2df..07b639910 100644
--- a/doc/assistant/pairing_walkthrough.mdwn
+++ b/doc/assistant/pairing_walkthrough.mdwn
@@ -10,7 +10,9 @@ We'll start on your computer, where you open up your git annex dashboard.
`*click*`
-[[!img pairing.png alt="Pair with local computer"]]
+[[!img pairing.png alt="Pair with another computer"]]
+
+`*click*`
Now the hard bit. You have to think up a secret phrase, and type it in,
(and perhaps get the spelling correct).
@@ -41,10 +43,11 @@ plugged into the same router.
Also, the file sharing set up by this pairing only works when both
computers are on the same network. If you go on a trip, any files you
-edit will not be visible to your friend until you get back. **But**,
-you can get around this by hooking both computers up to a server on the
-internet, which they can use to exchange files while disconnected. The
-git annex assistant makes that easy too.
+edit will not be visible to your friend until you get back.
+
+To get around this, you'll often also want to set up
+[[jabber_pairing|share_with_a_friend_walkthrough]], and a server
+in the cloud, which they can use to exchange files while away.
And also, you can pair with as many other computers as you like, not just
one!
diff --git a/doc/assistant/share_with_a_friend_walkthrough.mdwn b/doc/assistant/share_with_a_friend_walkthrough.mdwn
new file mode 100644
index 000000000..b99b1bcff
--- /dev/null
+++ b/doc/assistant/share_with_a_friend_walkthrough.mdwn
@@ -0,0 +1,58 @@
+Want to share all the files in your repository with a friend?
+
+Let's suppose you use Google Mail, and so does your friend, and you
+sometimes also chat in Google Talk. The git-annex assistant will
+use your Google account to share with your friend. (This actually
+works with any Jabber account you use, not just Google Talk.)
+
+Start by opening up your git annex dashboard.
+
+[[!img addrepository.png alt="Add another repository button"]]
+
+`*click*`
+
+[[!img pairing.png alt="Share with a friend"]]
+
+`*click*`
+
+[[!img xmpp.png alt="Configuring Jabber account"]]
+
+Fill that out, and git-annex will be able to show you a list of your
+friends.
+
+[[!img buddylist.png alt="Buddy list"]]
+
+This list will refresh as friends log on and off, so you can
+leave it open in a tab until a friend is available to start pairing.
+
+(If your friend is not using git-annex yet, now's a great time to spread
+the word!)
+
+Once you click on "Start Pairing", your friend will see this pop up
+on their git annex dashboard.
+
+[[!img xmppalert.png alt="Pair request"]]
+
+Once your friend clicks on that, your repositories will be paired.
+
+### But, wait, there's one more step...
+
+Despite the repositories being paired now, you and your friend can't yet
+quite share files. You'll start to see your friend's files show up in your
+git-annex folder, but you won't be able to open them yet.
+
+What you need to do now is set up a repository out there in the cloud,
+that both you and your friend can access. This will be used to transfer
+files between the two of you.
+
+At the end of the pairing process, a number of cloud providers are
+suggested, and the git-annex assistant makes it easy to configure one of
+them. Once you or your friend sets it up, it'll show up in the other
+one's list of repositories:
+
+[[!img repolist.png alt="Repository list"]]
+
+The final step is to share the login information for the cloud repository
+with your friend, so they can enable it too.
+
+With that complete, you'll be able to open your friend's files!
diff --git a/doc/assistant/share_with_a_friend_walkthrough/buddylist.png b/doc/assistant/share_with_a_friend_walkthrough/buddylist.png
new file mode 100644
index 000000000..ce3d61a96
--- /dev/null
+++ b/doc/assistant/share_with_a_friend_walkthrough/buddylist.png
Binary files differ
diff --git a/doc/assistant/share_with_a_friend_walkthrough/repolist.png b/doc/assistant/share_with_a_friend_walkthrough/repolist.png
new file mode 100644
index 000000000..409da4aa4
--- /dev/null
+++ b/doc/assistant/share_with_a_friend_walkthrough/repolist.png
Binary files differ
diff --git a/doc/assistant/share_with_a_friend_walkthrough/xmppalert.png b/doc/assistant/share_with_a_friend_walkthrough/xmppalert.png
new file mode 100644
index 000000000..5e2d56289
--- /dev/null
+++ b/doc/assistant/share_with_a_friend_walkthrough/xmppalert.png
Binary files differ