tonyair/doc.silverstripe.org
1
0
Fork 0
mirror of https://github.com/silverstripe/doc.silverstripe.org synced 2024-06-18 10:41:52 +02:00
Code Issues Projects Releases Wiki Activity

Update Documentation

Browse Source
This commit is contained in:
Will Rossiter 2012-09-09 18:19:14 +12:00
parent 8879d6cf08
commit bb7dd2dceb
2 changed files with 60 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

69
README.md
View File

@ -1,17 +1,68 @@
doc.silverstripe.org
====================
# doc.silverstripe.org
This is the source code powering http://doc.silverstripe.org. It primarily consists of:
This is the source code powering http://doc.silverstripe.org. It primarily
consists of:
* SilverStripe
* The [docsviewer](https://github.com/silverstripe/silverstripe-docsviewer) module
* SilverStripe 3.0 framework
* The [docsviewer](https://github.com/silverstripe/silverstripe-docsviewer)
module.
Development and contribution
----------------------------
## Development
To set up a test instance:
* Clone this repository to a LAMP server.
* Run "make" to check out the repositories from which is builds the docs (this will take a while the first time)
* Run "make update" to check out the repositories from which is builds the
docs (this will take a while the first time)
To contribute an improvement, submit a pull request on GitHub. Any approved pull requests will make their way onto the doc.silverstripe.org site in the next release.
## 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)[https://github.com/silverstripe/sapphire/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 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

31
app/README.md
View File

@ -1,31 +0,0 @@
# 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