From dc887c3441ee109e6911bcf7602ce261c189e3b6 Mon Sep 17 00:00:00 2001 From: Joey Hess Date: Tue, 20 Dec 2016 15:10:33 -0400 Subject: add some links to new workflow page --- doc/how_it_works.mdwn | 7 ++++-- doc/links/key_concepts.mdwn | 1 + doc/sync.mdwn | 2 ++ ...ent_5_6ec6fb45021ba82ed6a4bb9a6f3cfceb._comment | 9 +++++++ doc/walkthrough.mdwn | 7 +++++- doc/workflow.mdwn | 29 ++++++++++++---------- 6 files changed, 39 insertions(+), 16 deletions(-) create mode 100644 doc/todo/Workflow_guide/comment_5_6ec6fb45021ba82ed6a4bb9a6f3cfceb._comment (limited to 'doc') diff --git a/doc/how_it_works.mdwn b/doc/how_it_works.mdwn index 69e5256e3..21fa39ea7 100644 --- a/doc/how_it_works.mdwn +++ b/doc/how_it_works.mdwn @@ -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" diff --git a/doc/links/key_concepts.mdwn b/doc/links/key_concepts.mdwn index f1754e0c8..3dc2f6c5d 100644 --- a/doc/links/key_concepts.mdwn +++ b/doc/links/key_concepts.mdwn @@ -3,5 +3,6 @@ * [[git-annex man page|git-annex]] * [[how_it_works]] * [[special_remotes]] +* [[workflows|workflow]] * [[sync]] * [[direct_mode]] diff --git a/doc/sync.mdwn b/doc/sync.mdwn index 0250d2fef..cddccd112 100644 --- a/doc/sync.mdwn +++ b/doc/sync.mdwn @@ -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 index 000000000..8b5b37ea3 --- /dev/null +++ b/doc/todo/Workflow_guide/comment_5_6ec6fb45021ba82ed6a4bb9a6f3cfceb._comment @@ -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. +"""]] diff --git a/doc/walkthrough.mdwn b/doc/walkthrough.mdwn index 22c94d570..b35cf808d 100644 --- a/doc/walkthrough.mdwn +++ b/doc/walkthrough.mdwn @@ -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]] diff --git a/doc/workflow.mdwn b/doc/workflow.mdwn index 52f11e217..042b4bab4 100644 --- a/doc/workflow.mdwn +++ b/doc/workflow.mdwn @@ -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 -- cgit v1.2.3