Go to file

Will Rossiter 16ad199210 Merge pull request #39 from dhensby/master Adding .editorconfig		2014-12-05 15:16:02 +13:00
app	FIX github repo for edit links	2014-11-11 13:22:59 +13:00
bin	FIX unexpected operator	2014-11-14 17:36:22 +13:00
themes/docs	Updated toolbar and framework (including icons)	2014-09-19 16:31:43 +12:00
.editorconfig	Adding .editorconfig	2014-12-04 15:27:53 +00:00
.gitignore	Adding new toolbar to documentation viewer	2014-07-23 11:00:29 +12:00
.htaccess	Rewrite rules for changed URLs	2013-09-12 22:21:00 +02:00
.htaccess_live	Removed changelog redirection to master	2012-10-30 18:22:26 +01:00
Makefile	FIX: DRY update for managing documented module checkouts. (Fixes #2 )	2012-09-09 18:23:06 +12:00
README.md	Fixed broken link to sapphire docs	2013-07-21 17:35:40 +10:00
composer.json	Updated toolbar and framework (including icons)	2014-09-19 16:31:43 +12:00
composer.lock	Updated docviewer module	2014-11-12 16:54:10 +13:00
favicon.ico	MINOR Updated favicon	2011-01-18 02:52:12 +00:00
google9d5116bbb46f4c16.html	Added Google Webmaster Tools verification	2013-09-06 20:53:22 +02:00
phpunit.xml.dist	Updated PHPUnit default file	2013-05-29 18:08:35 +02:00

README.md

doc.silverstripe.org

This is the source code powering http://doc.silverstripe.org. It primarily consists of the SilverStripe framework and docsviewer module with minimal configuration.

For adding functionality or editing the style of the documentation see the docsviewer module.

Development

To set up a test instance:

Clone this repository to a LAMP server.
Install Composer
After installing composer run composer install --prefer-source to grab the modules.
Run "make update" to check out the repositories from which is builds the docs (this will take a while the first time)

Source Documentation Files

Documentation for each module is stored on the filesystem via a full git clone of the module to the src/ subdirectory in this project. These checkouts are ignored from this repository to allow for easier updating and to keep this project small.

To update or download the source documentation at any time run the following make command in your terminal:

cd /Sites/doc.silverstripe.org/
make fetch

make fetch will call bin/update.sh to download / update each module as listed in the bin/update.sh file.

Once the make fetch command has executed and downloaded the latest files, those files are registered along with the module version the folder relates to. through the app/_config.php file.

DocumentationService::register("sapphire", BASE_PATH ."/src/github/master/sapphire/docs/", '2.4');

Contribution

To contribute an improvement to the doc.silverstripe.org functionality or theme, submit a pull request on GitHub. Any approved pull requests will make their way onto the doc.silverstripe.org site in the next release.

The content for doc.silverstripe.org is stored in the modules repository inside a "docs" folder (for example, the framework documentation is stored at github.com/silverstripe/sapphire).

If you wish to edit the documentation content, submit a pull request on that Github project. Updates to the content are synced regularly with docs.silverstripe.org via a cron job.

Cron job

The cron job keeps doc.silverstripe.org up to date with the latest code. This cron task calls make update, a script that fetches the latest documentation for each module from git and rebuilds the search indexes.

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, that's symlinked in under the URL http://doc.silverstripe.org/old.

ln -s /sites/ss2doc/www /sites/ss2doc-v2/www/old