Rfaulk has uploaded a new change for review.
https://gerrit.wikimedia.org/r/91355
Change subject: mod - more example docs on README.
......................................................................
mod - more example docs on README.
Change-Id: I1b9483790892cbd2217a2434b950dead20ac0fc4
---
M README.rst
1 file changed, 20 insertions(+), 35 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/sartoris refs/changes/55/91355/1
diff --git a/README.rst b/README.rst
index 6981a30..80e2e55 100644
--- a/README.rst
+++ b/README.rst
@@ -106,44 +106,18 @@
respectively. It is assumed that the git remote is configured for your
project and for this example the remote alias is
*origin* and the remote branch is *master*.
-###Client Setup
-On your client machine clone git deploy, local install, configure settings and
initialize:
+**CLIENT SETUP**
+
+On *client.realm.org* clone git deploy, local install, configure settings and
initialize:
$ git clone [email protected]:Git-Tools/git-deploy.git
-
- Cloning into 'git-deploy'...
- remote: Counting objects: 943, done.
- remote: Compressing objects: 100% (380/380), done.
- remote: Total 943 (delta 538), reused 936 (delta 531)
- Receiving objects: 100% (943/943), 153.47 KiB | 208 KiB/s, done.
- Resolving deltas: 100% (538/538), done.
-
+ ...
$ cd git-deploy
$ sudo pip install -e .
+ ...
- Obtaining file:///Users/rfaulkner/projects/git-deploy
- Running setup.py egg_info for package from
file:///Users/rfaulkner/projects/git-deploy
-
- warning: no files found matching '*' under directory 'docs'
- no previously-included directories found matching 'docs/_build'
- Requirement already satisfied (use --upgrade to upgrade): dulwich in
/Library/Python/2.7/site-packages (from sartoris==0.1-devdev-20131021)
- Requirement already satisfied (use --upgrade to upgrade):
paramiko>=1.11.0 in /Library/Python/2.7/site-packages (from
sartoris==0.1-devdev-20131021)
- Requirement already satisfied (use --upgrade to upgrade):
pycrypto>=2.1,!=2.4 in /Library/Python/2.7/site-packages (from
paramiko>=1.11.0->sartoris==0.1-devdev-20131021)
- Installing collected packages: git-deploy
- Running setup.py develop for git-deploy
-
- warning: no files found matching '*' under directory 'docs'
- no previously-included directories found matching 'docs/_build'
- Creating /Library/Python/2.7/site-packages/git-deploy.egg-link
(link to .)
- sartoris 0.1-devdev-20131021 is already the active version in
easy-install.pth
- Installing git-deploy script to /usr/local/bin
-
- Installed /Users/rfaulkner/projects/git-deploy
- Successfully installed git-deploy
- Cleaning up...
-
-Next configure the client instance with git config by assigning the following
settings:
+Next configure the client instance with git config by assigning the following
settings in *scripts/sartoris.ini*:
[deploy]
target=target.realm.org
@@ -154,18 +128,29 @@
remote=origin
branch=master
client-path=/home/me/project/
+ key-path=/home/me/.ssh/id_rsa
+ test-repo-path=/tmp/test_repo/
[system]
run_root=/usr/bin/
+Once you have defined settings in *sartoris.ini* call *init.py* to set the got
config
-###Target Setup
+ $ sudo ./scripts/init.py
-###Using Hooks
+**TARGET SETUP**
+
+On *target.realm.org* there is no need to clone and install git-deploy but
here the deploy hooks will need to be
+created. There is a default hook in
*sartoris/default-hooks/default-target-pull.py* that should be copied to
+*target.realm.org:/var/www/html/sample.com/.git/deploy/hooks/*. This is a
basic hook that will pull the changes
+pushed from the client instance on sync.
-###Using Git-Deploy
+**USING GIT DEPLOY**
+*start/sync*
+*start/abort*
+*start/rollback*
--
To view, visit https://gerrit.wikimedia.org/r/91355
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: I1b9483790892cbd2217a2434b950dead20ac0fc4
Gerrit-PatchSet: 1
Gerrit-Project: sartoris
Gerrit-Branch: master
Gerrit-Owner: Rfaulk <[email protected]>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
