add some links to new workflow page
authorJoey Hess <joeyh@joeyh.name>
Tue, 20 Dec 2016 19:10:33 +0000 (15:10 -0400)
committerJoey Hess <joeyh@joeyh.name>
Tue, 20 Dec 2016 19:13:44 +0000 (15:13 -0400)
doc/how_it_works.mdwn
doc/links/key_concepts.mdwn
doc/sync.mdwn
doc/todo/Workflow_guide/comment_5_6ec6fb45021ba82ed6a4bb9a6f3cfceb._comment [new file with mode: 0644]
doc/walkthrough.mdwn
doc/workflow.mdwn

index 69e5256e3a6e00a0dd903d7127a61747392c2001..21fa39ea7ec0e660b13daa05c47526d825eb2a35 100644 (file)
@@ -1,8 +1,11 @@
-This page gives a high-level view of git-annex. For a detailed
+This page gives a high-level view of how git-annex works. For a detailed
 low-level view, see [[the_man_page|git-annex]] and [[internals]].
 
 You do not need to read this page to get started with using git-annex. The
-[[walkthrough]] provides step-by-step instructions.
+[[walkthrough]] provides step-by-step examples, and [[workflow]] discusses
+different ways you can use git-annex.
+
+----
 
 Still reading? Ok. Git's man page calls it "a stupid content
 tracker". With git-annex, git is instead "a stupid filename and metadata"
index f1754e0c83e35cd88f0a990f9d3ce9223d3c31f5..3dc2f6c5d612e286090629ae703ef589df3f2bd7 100644 (file)
@@ -3,5 +3,6 @@
 * [[git-annex man page|git-annex]]
 * [[how_it_works]]
 * [[special_remotes]]
+* [[workflows|workflow]]
 * [[sync]]
 * [[direct_mode]]
index 0250d2fef0f0d378a2d80377a37ebc09d48aa77a..cddccd11243aa78a56f727150cf372a7e3a1a554 100644 (file)
@@ -42,3 +42,5 @@ repositories, but does not transfer the content of annexed files. If you
 want to fully synchronise two repositories content,
 you can use `git annex sync --content`. You can also configure
 [[preferred_content]] settings to make only some content be synced.
+
+See [[git-annex-sync]] for the command's man page.
diff --git a/doc/todo/Workflow_guide/comment_5_6ec6fb45021ba82ed6a4bb9a6f3cfceb._comment b/doc/todo/Workflow_guide/comment_5_6ec6fb45021ba82ed6a4bb9a6f3cfceb._comment
new file mode 100644 (file)
index 0000000..8b5b37e
--- /dev/null
@@ -0,0 +1,9 @@
+[[!comment format=mdwn
+ username="joey"
+ subject="""comment 5"""
+ date="2016-12-20T19:04:12Z"
+ content="""
+Good start on the workflow page!
+
+I've added some links to it to make it discoverable.
+"""]]
index 22c94d570ffafe785176892244f93ba9cd5a93be..b35cf808d8add0f71a911d1d7a9189ebd28b1fca 100644 (file)
@@ -1,4 +1,9 @@
-A walkthrough of the basic features of git-annex.
+A walkthrough of some of the basic features of git-annex, using the command
+line. If you don't want to use the command line, see [[assistant/quickstart]]
+instead.
+
+What follows is only one possible [[workflow]] for using git-annex,
+but following along will teach you the basic concepts from the ground up.
 
 [[!toc]]
 
index 52f11e217fc679b1e40f5cdf561d2290521d4a59..042b4bab43feb089ff3f27443e965c093be35e7f 100644 (file)
@@ -12,7 +12,9 @@ commandline usage would be much more intuitive, but you'd have to be
 willing to read the man page and wiki pages to get started, and that's
 pretty much what's already out there anyway.
 
-Note that for each of these levels of interaction, all the levels following will also work as well. So you can actually manually move annexed files around while the webapp is running, etc.
+Note that for each of these levels of interaction, all the levels following
+will also work as well. So you can actually manually move annexed files
+around while the webapp is running, etc.
 
 # 1. [[git annex webapp|git-annex-webapp]]
 
@@ -27,18 +29,19 @@ needed. This should be run on every machine that may produce file changes.
 You could call [[`git annex assistant`|git-annex-assistant]] the
 command-line version of the webapp, giving you more control over creating
 and connecting your repositories, and configuring how files are moved
-between them. The assistant, when running, will automatically watch for
-file changes and synchronize them to other repositories, but you must
-manually create the repositories and configure the rules for syncing. To
-create a repository, use `git init` and then [[`git annex
-init`|git-annex-init]], and then `git remote add` it to any other
-repositories. If you want more than one annex, you can add their paths to
-`~/.config/git-annex/autostart` if you would like them to automatically
-begin syncing when `git annex assistant --autostart` is run, perhaps on
-boot or login. You can configure rules for where files are copied using the
-repository setup commands such as [[git annex
-preferred-content|git-annex-preferred-content]] to configure [[content
-preferences|preferred content]] for what goes where, [[`git annex
+between them.
+
+The assistant, when running, will automatically watch for file changes and
+synchronize them to other repositories, but you must manually create the
+repositories and configure the rules for syncing. To create a repository,
+use `git init` and then [[`git annex init`|git-annex-init]], and then `git
+remote add` it to any other repositories. If you want more than one annex,
+you can add their paths to `~/.config/git-annex/autostart` if you would
+like them to automatically begin syncing when `git annex assistant
+--autostart` is run, perhaps on boot or login. You can configure rules for
+where files are copied using the repository setup commands such as [[git
+annex preferred-content|git-annex-preferred-content]] to configure
+[[content preferences|preferred content]] for what goes where, [[`git annex
 numcopies`|git-annex-numcopies]] for how many [[copies]] must be kept of
 each file, and [[`git config annex.largefiles`|tips/largefiles]] to define
 small files that should be stored straight in git; most of the settings are