diff --git a/Makefile b/Makefile index 285cad6..0f0cd3f 100644 --- a/Makefile +++ b/Makefile @@ -5,6 +5,10 @@ # Most users should simply visit the site root in your web browser. # +update: + cd $(CURDIR)/src/github/; git pull + cd $(CURDIR); php sapphire/cli-script.php dev/tasks/RebuildLuceneDocsIndex flush=1 + test: if [ ! -d "src" ]; then \ git clone git://github.com/chillu/silverstripe-doc-restructuring.git src/github; \ diff --git a/mysite/README.md b/mysite/README.md new file mode 100644 index 0000000..ddebe63 --- /dev/null +++ b/mysite/README.md @@ -0,0 +1,31 @@ +# doc.silverstripe.org # + +## Installation ## + +See `sapphiredocs/README.md` for main setup instructions. + +## Source Documentation Files + +Source registration is documented in `sapphiredocs` module. +We keep sources in a `src/` subdirectory. +For this project the different sources are NOT included in version control, +because we need to check out from git and subversion (so svn:externals won't work in this case). All sources have to be checked out and updated manually. +We use the `Makefile` for this, which exposes a new `make update` command. + +In `mysite/_config.php`: + + DocumentationService::register("sapphire", BASE_PATH ."/src/github/master/sapphire/docs/", '2.4'); + +When registering a new module, you have to update the `Makefile` as well. + +## Cronjob Setup ## + + 05 * * * * sites make -f /sites/ss2doc-v2/www/Makefile -C /sites/ss2doc-v2/www update + +## Legacy Dokuwiki ## + +We assume that DokuWiki (which ran the original doc.silverstripe.org) +is served on the same webserver from a different webroot, thats +symlinked in under the URL http://doc.silverstripe.org/old. + + ln -s /sites/ss2doc/www /sites/ss2doc-v2/www/old \ No newline at end of file