mirrors/git-annex
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

add some links to new workflow page

Browse source
This commit is contained in:
Joey Hess 2016-12-20 15:10:33 -04:00
parent 116e601989
commit 9bdb617484
No known key found for this signature in database
GPG key ID: C910D9222512E3C7
6 changed files with 39 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

7
doc/how_it_works.mdwn
View 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]]. 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 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 Still reading? Ok. Git's man page calls it "a stupid content
tracker". With git-annex, git is instead "a stupid filename and metadata" tracker". With git-annex, git is instead "a stupid filename and metadata"

1
doc/links/key_concepts.mdwn
View file

@ -3,5 +3,6 @@
* [[git-annex man page|git-annex]] * [[git-annex man page|git-annex]]
* [[how_it_works]] * [[how_it_works]]
* [[special_remotes]] * [[special_remotes]]
* [[workflows|workflow]]
* [[sync]] * [[sync]]
* [[direct_mode]] * [[direct_mode]]

2
doc/sync.mdwn
View file

@ -42,3 +42,5 @@ repositories, but does not transfer the content of annexed files. If you
want to fully synchronise two repositories content, want to fully synchronise two repositories content,
you can use `git annex sync --content`. You can also configure you can use `git annex sync --content`. You can also configure
[[preferred_content]] settings to make only some content be synced. [[preferred_content]] settings to make only some content be synced.
See [[git-annex-sync]] for the command's man page.

9
doc/todo/Workflow_guide/comment_5_6ec6fb45021ba82ed6a4bb9a6f3cfceb._comment Normal file
View file

@ -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.
"""]]

7
doc/walkthrough.mdwn
View 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]] [[!toc]]

29
doc/workflow.mdwn
View 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 willing to read the man page and wiki pages to get started, and that's
pretty much what's already out there anyway. 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]] # 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 You could call [[`git annex assistant`|git-annex-assistant]] the
command-line version of the webapp, giving you more control over creating command-line version of the webapp, giving you more control over creating
and connecting your repositories, and configuring how files are moved and connecting your repositories, and configuring how files are moved
between them. The assistant, when running, will automatically watch for between them.
file changes and synchronize them to other repositories, but you must
manually create the repositories and configure the rules for syncing. To The assistant, when running, will automatically watch for file changes and
create a repository, use `git init` and then [[`git annex synchronize them to other repositories, but you must manually create the
init`|git-annex-init]], and then `git remote add` it to any other repositories and configure the rules for syncing. To create a repository,
repositories. If you want more than one annex, you can add their paths to use `git init` and then [[`git annex init`|git-annex-init]], and then `git
`~/.config/git-annex/autostart` if you would like them to automatically remote add` it to any other repositories. If you want more than one annex,
begin syncing when `git annex assistant --autostart` is run, perhaps on you can add their paths to `~/.config/git-annex/autostart` if you would
boot or login. You can configure rules for where files are copied using the like them to automatically begin syncing when `git annex assistant
repository setup commands such as [[git annex --autostart` is run, perhaps on boot or login. You can configure rules for
preferred-content|git-annex-preferred-content]] to configure [[content where files are copied using the repository setup commands such as [[git
preferences|preferred content]] for what goes where, [[`git annex 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 numcopies`|git-annex-numcopies]] for how many [[copies]] must be kept of
each file, and [[`git config annex.largefiles`|tips/largefiles]] to define 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 small files that should be stored straight in git; most of the settings are