tonyair/doc.silverstripe.org
1
0
Fork 0
mirror of https://github.com/silverstripe/doc.silverstripe.org synced 2024-10-22 17:05:50 +02:00
Code Issues Projects Releases Wiki Activity
368f591b77
doc.silverstripe.org/README.md
Will Rossiter 0a9865e4d2 Temporary updates for preview site.
2015-01-20 09:59:57 +13:00

2.7 KiB
Raw Blame History

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/docsviewer.yml file.

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