Go to file
Cam Findlay 41cd0829c5 Merge pull request #87 from mandrew/hotfix/new-favicons
MINOR: Update to favicons and new favicons which are also being added to silverstripe.org
2015-10-29 13:17:30 +13:00
app Update version UI for archive and more obvious stable 2015-10-13 16:10:07 +13:00
bin Updated docs for 3.2 2015-06-19 17:22:44 +12:00
themes/docs MINOR: Update to favicons and new favicons which are also being added to silverstripe.org 2015-10-28 11:29:05 +13:00
.editorconfig Added EditorConfig for coding convention consistency. 2015-01-20 10:06:14 +13:00
.gitignore Block unstable versions from being indexed by search engines 2015-07-08 12:00:41 +12:00
.htaccess Issue 66 : commented out three extraneous RewriteConds and tightened a RewriteRule to avoid redirect loops 2015-07-19 14:08:19 +12:00
.htaccess_live Removed changelog redirection to master 2012-10-30 18:22:26 +01:00
android-chrome-36x36.png MINOR: Update to favicons and new favicons which are also being added to silverstripe.org 2015-10-28 11:29:05 +13:00
android-chrome-48x48.png MINOR: Update to favicons and new favicons which are also being added to silverstripe.org 2015-10-28 11:29:05 +13:00
android-chrome-72x72.png MINOR: Update to favicons and new favicons which are also being added to silverstripe.org 2015-10-28 11:29:05 +13:00
android-chrome-96x96.png MINOR: Update to favicons and new favicons which are also being added to silverstripe.org 2015-10-28 11:29:05 +13:00
android-chrome-144x144.png MINOR: Update to favicons and new favicons which are also being added to silverstripe.org 2015-10-28 11:29:05 +13:00
android-chrome-192x192.png MINOR: Update to favicons and new favicons which are also being added to silverstripe.org 2015-10-28 11:29:05 +13:00
apple-touch-icon-57x57.png MINOR: Update to favicons and new favicons which are also being added to silverstripe.org 2015-10-28 11:29:05 +13:00
apple-touch-icon-60x60.png MINOR: Update to favicons and new favicons which are also being added to silverstripe.org 2015-10-28 11:29:05 +13:00
apple-touch-icon-72x72.png MINOR: Update to favicons and new favicons which are also being added to silverstripe.org 2015-10-28 11:29:05 +13:00
apple-touch-icon-76x76.png MINOR: Update to favicons and new favicons which are also being added to silverstripe.org 2015-10-28 11:29:05 +13:00
apple-touch-icon-114x114.png MINOR: Update to favicons and new favicons which are also being added to silverstripe.org 2015-10-28 11:29:05 +13:00
apple-touch-icon-120x120.png MINOR: Update to favicons and new favicons which are also being added to silverstripe.org 2015-10-28 11:29:05 +13:00
apple-touch-icon-144x144.png MINOR: Update to favicons and new favicons which are also being added to silverstripe.org 2015-10-28 11:29:05 +13:00
apple-touch-icon-152x152.png MINOR: Update to favicons and new favicons which are also being added to silverstripe.org 2015-10-28 11:29:05 +13:00
apple-touch-icon-180x180.png MINOR: Update to favicons and new favicons which are also being added to silverstripe.org 2015-10-28 11:29:05 +13:00
apple-touch-icon-precomposed.png MINOR: Update to favicons and new favicons which are also being added to silverstripe.org 2015-10-28 11:29:05 +13:00
apple-touch-icon.png MINOR: Update to favicons and new favicons which are also being added to silverstripe.org 2015-10-28 11:29:05 +13:00
browserconfig.xml MINOR: Update to favicons and new favicons which are also being added to silverstripe.org 2015-10-28 11:29:05 +13:00
composer.json Framework version upgrade + tidy up 2015-10-14 09:35:07 +13:00
composer.lock Update toolbar version 4.0.8 2015-10-14 15:06:12 +13:00
favicon-16x16.png MINOR: Update to favicons and new favicons which are also being added to silverstripe.org 2015-10-28 11:29:05 +13:00
favicon-32x32.png MINOR: Update to favicons and new favicons which are also being added to silverstripe.org 2015-10-28 11:29:05 +13:00
favicon-96x96.png MINOR: Update to favicons and new favicons which are also being added to silverstripe.org 2015-10-28 11:29:05 +13:00
favicon-194x194.png MINOR: Update to favicons and new favicons which are also being added to silverstripe.org 2015-10-28 11:29:05 +13:00
favicon.ico MINOR: Update to favicons and new favicons which are also being added to silverstripe.org 2015-10-28 11:29:05 +13:00
favicon.png MINOR: Update to favicons and new favicons which are also being added to silverstripe.org 2015-10-28 11:29:05 +13:00
google9d5116bbb46f4c16.html Added Google Webmaster Tools verification 2013-09-06 20:53:22 +02:00
Makefile Adding explicit branch names so the edit links work as expected. Fixed ss-cache bug due to unrequited link in makefile. 2015-01-20 10:06:14 +13:00
manifest.json MINOR: Update to favicons and new favicons which are also being added to silverstripe.org 2015-10-28 11:29:05 +13:00
mstile-70x70.png MINOR: Update to favicons and new favicons which are also being added to silverstripe.org 2015-10-28 11:29:05 +13:00
mstile-144x144.png MINOR: Update to favicons and new favicons which are also being added to silverstripe.org 2015-10-28 11:29:05 +13:00
mstile-150x150.png MINOR: Update to favicons and new favicons which are also being added to silverstripe.org 2015-10-28 11:29:05 +13:00
mstile-310x150.png MINOR: Update to favicons and new favicons which are also being added to silverstripe.org 2015-10-28 11:29:05 +13:00
mstile-310x310.png MINOR: Update to favicons and new favicons which are also being added to silverstripe.org 2015-10-28 11:29:05 +13:00
phpunit.xml.dist Updated PHPUnit default file 2013-05-29 18:08:35 +02:00
README.md README.md : update links, fix typos 2015-07-19 16:21:19 +12:00
robots.txt Block unstable versions from being indexed by search engines 2015-07-08 12:00:41 +12:00

doc.silverstripe.org

This is the source code powering http://docs.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 it 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 docsviewer.yml file.

Contribution

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

The content for docs.silverstripe.org is stored in the modules repository inside a "docs" folder (for example, the framework documentation is stored at https://github.com/silverstripe/silverstripe-framework/tree/master/docs.

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 docs.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