urosm
/
ikiwiki
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

reorg all the git cruft a bit, highlight setup page and de-highlight more 

complex or less perfect setup methods
master
joey 2007-10-21 00:57:10 +00:00
parent 9a060e6c6e
commit f91ebfa01b
3 changed files with 55 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/rcs/git.mdwn
View File

@ -1,17 +1,17 @@
[[meta title="Git"]]
[Git][git] is a distributed revison control system originally developed for the Linux kernel. Ikiwiki supports storing a wiki in git.
[Git][git] is a distributed revison control system originally developed for
the Linux kernel. Ikiwiki supports storing a wiki in git.
[git]: http://git.or.cz/
Ikiwiki can run as a post-update hook to update a wiki whenever commits
come in. When running as a [[cgi]] with Git, ikiwiki automatically
commits edited pages, and uses the Git history to generate the [[RecentChanges]] page.
commits edited pages, and uses the Git history to generate the
[[RecentChanges]] page.
Links:
[[Setup]] documents current best practice for using git with ikiwiki. This
involves setting up a pair of git repositories. This method isn't the most
obvious, but it works the best.
* [[Editing_wiki_pages_manually_with_git|GitManual]]
* [HOWTO: ikiwiki + git][howto]
* Common [[Git_pitfalls|/setup/git_pitfalls]] when using Git with Ikiwiki
[howto]: http://fob.po8.org/node/346
See also: [[common_git_pitfalls|/setup/git_pitfalls]]

47
doc/rcs/git/discussion.mdwn
View File

@ -1,3 +1,10 @@
## ikiwiki + git
<http://fob.po8.org/node/346>
Here's an early page documenting setting up ikiwiki with git. It shouldn't be
this hard anymore. :-) See [[setup]] --[[Joey]]
## Migrating from svn to git ##
I'd like to migrate from svn to git, because git is better in general but also has some nice properties that go well together with my use of ikiwiki.. I only change it myself. I want a single git repo so that my website directory is self-contained so that I don't need to drag around a separate svn repository on my computer. Is it possible to use ikiwiki so that it only uses a git repository in the same dir as all files are stored and edited?
@ -31,3 +38,43 @@ UlrikSverdrup (This is now crossposted to the above mentioned [website][ulrikweb
> Note that while the post-commit hook above may work in some situations, it *will* fail (or at least be suboptimal) for web commits. If you're setting up ikiwiki and git for a wiki that allows web commits, you should use
> the repository and hook setups in documented in [[setup]] instead. With that method, you do end up with two separate git repos; but it's fine to only back one of them up. :-) --[[Joey]]
## gitmanual
Main use case I am trying to accomplish: Edit wiki pages offline.
1. Imagine you're the administrator of the site and you want to checkout the wiki sources to give them some love while on a train journey.
2. Or you are writing a complex document and you want to simply use your favourite $EDITOR
3. Learn a little more about [git](http://git.or.cz/)
# Workflow
## on webconverger.org aka si.dabase.com aka hendry machine
Wiki page created with [ikiwiki](http://ikiwiki.info). Example usb.mdwn [usb](http://webconverger.org/usb/)
## on monty (my laptop)
git-clone ssh://si.dabase.com/home/hendry/wikiwc/.git/
You might want to set some config variables like your email as this [tutorial](http://www.kernel.org/pub/software/scm/git/docs/tutorial.html) describes.
echo "blah" >> usb.mdwn
Then to commit:
git-commit -a -m "added test"
Send back:
git push origin
## on webconverger.org aka si.dabase.com aka hendry machine
You should setup the "The git post-update wrapper" in the **ikiwiki.setup** file.
Then the wiki should be up-to-date! :)
# Ack
Thanks to gitte on #git on Freenode and of course joeyh. Have a look at [[rcs/details]].

37
doc/rcs/git/gitmanual.mdwn
View File

@ -1,37 +0,0 @@
Main use case I am trying to accomplish: Edit wiki pages offline.
1. Imagine you're the administrator of the site and you want to checkout the wiki sources to give them some love while on a train journey.
2. Or you are writing a complex document and you want to simply use your favourite $EDITOR
3. Learn a little more about [git](http://git.or.cz/)
# Workflow
## on webconverger.org aka si.dabase.com aka hendry machine
Wiki page created with [ikiwiki](http://ikiwiki.info). Example usb.mdwn [usb](http://webconverger.org/usb/)
## on monty (my laptop)
git-clone ssh://si.dabase.com/home/hendry/wikiwc/.git/
You might want to set some config variables like your email as this [tutorial](http://www.kernel.org/pub/software/scm/git/docs/tutorial.html) describes.
echo "blah" >> usb.mdwn
Then to commit:
git-commit -a -m "added test"
Send back:
git push origin
## on webconverger.org aka si.dabase.com aka hendry machine
You should setup the "The git post-update wrapper" in the **ikiwiki.setup** file.
Then the wiki should be up-to-date! :)
# Ack
Thanks to gitte on #git on Freenode and of course joeyh. Have a look at [[rcs/details]].