]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/rcs/git.mdwn
web commit by ManojSrivastava
[git.ikiwiki.info.git] / doc / rcs / git.mdwn
index 2876cecfcb2a3f68f0b33f88bebd5af874445d6d..c02189cdd749819500b19791ffc9c3294e311a3e 100644 (file)
@@ -19,6 +19,8 @@ working clones (with working directories) as leaf nodes.  The root
 (bare) repository is meant to be pushed to and pulled from the various
 working clones. 
 
+![Git repository relationships](http://people.debian.org/~srivasta/ikiwiki_git.png)
+
 One of the leaf node clone repositories is special; it has working
 directory which is used to compile the wiki from, and is also used by the
 [[cgi]] to commit changes made via the web interface. It is special
@@ -42,7 +44,7 @@ repositories:
 * The second repository is a clone of the bare root repository, and has a working tree which is used as ikiwiki's srcdir for compiling the wiki. **Never** push to this repository. When running as a [[cgi]], the changes are committed to this repository, and pushed to the master repository above. This is called _srcdir_ in [[ikiwiki-makerepo]]'s manual page.
 * The other (third, fourth, fifth, sixth -- however many pleases you) repositories are also clones of the bare root repository above -- and these have a working directory for you to work on. Use either the `git` transport (if available), or `ssh`. These repositories may be on remote machines, your laptop, whereever you find convenient to hack on your wiki. Any new content should be pushed to the bare master repository when you are ready to publish it, and then the post-commit hook of the bare repository will ensure that the ikiwiki's source directory is updated, and the ikiwiki refreshed with the new content.
 
-[[ikiwiki-makerepo]] can automate setting this up. Using three or more of repositories isn't the most obvious set up, but it works the best for typical ikiwiki use.  [[tips/Laptop_wiki_with_git]] describes a different way to set up ikiwiki and git.
+Using three or more of repositories isn't the most obvious set up, but it works the best for typical ikiwiki use.  [[tips/Laptop_wiki_with_git]] describes a different way to set up ikiwiki and git.
 
 It is **paramount** that you **never** push to the non-bare repository
 ([this FAQ entry explains why](http://git.or.cz/gitwiki/GitFaq#head-b96f48bc9c925074be9f95c0fce69bcece5f6e73)).
@@ -50,6 +52,21 @@ Instead, clone the bare repository as mentioned above, and push **only** to the
 
 The ikiwiki `post-commit` hook should be put in the bare repository.
 
+### Nine steps to get rich using git as your ikiwiki SCM  
+
+1. `mkdir -p /path/to/repository && cd /path/to/repository`
+2. `git --bare init --shared`
+3. `mkdir -p /path/to/clone0 && cd  /path/to/clone0`
+4. `git clone /path/to/repository`
+5. `echo /.ikiwiki > .gitignore`
+6. `git add .gitignore`
+7. Now, populate your wiki. You could us `cp` to copy over files, use you favourite editor to create files and `git add` them, or you could import a wiki repository from another VCS using `git-svnimport`, `git-archimport`, or `git-cvsimport`. Make sure the permissions are correct in order for [[cgi]] to commit here (consider actually cloning another reposotory for yourself, on this or on another machine). Use `git add` to add these files to the index.
+8. `git push`
+9. Profit.
+
+[[ikiwiki-makerepo]] can automate setting this up for the common case
+where there is no pre-existing wiki.
+
 ## git repository with multiple committers
 
 It can be tricky to get the permissions right to allow multiple people to