SilverStripe Documentation Restructuring Project
This is a temporary repository for developer documentation about the SilverStripe framework, currently located at [http://doc.silverstripe.org].
Note: This repository is used for collaboration during the restructuring phase, and will move elsewhere afterwards
- Documentation questions: Ingo Schommer (ingo at silverstripe dot com)
- Markdown Conversion: Mark Stephens (mark at silverstripe dot com)
You'll need to install git, which is quite straightforward on most operating systems.
To preview changes, you will need to run a local webserver capable of running SilverStripe. XAMPP is a good option.
master: The new markdown files - please edit in here
scripts: Helper scripts for conversion and file management
Forking the project into your github account
You can fork this project within github, as described on help.github.com. This fork will show up on your own github profile, and can be checked out to your local machine. You don't need a webserver on there, or run any project-specific scripts.
Updating your project fork
You should update your own repository every now and then from "upstream" (the original repository), to ensure you make any changes on the most recent version of files. See "Pulling in upstream changes" on help.github.com.
Committing changes back through "pull requests"
See "Pull requests" on help.github.com.
Merging in "pull requests"
Previewing your changes
The preview/ directory contains a SilverStripe site that you can visit to preview what the documentation site will look like. You will need to create a
_ss_environment.php file in the root of your project or in the directory above.
Here is a minimal one. Alter the database settings to suit your set-up.
<?php define('SS_ENVIRONMENT_TYPE', 'dev'); define('SS_DATABASE_SERVER', 'localhost'); define('SS_DATABASE_USERNAME', 'root'); define('SS_DATABASE_PASSWORD', '');
If you have check out silverstripe-doc-restructuring into your webroot, you should be able to visit a URL such as http://localhost/silverstripe-doc-restructuring/preview/ to preview your changes.
Contributing your changes
After pushing your changes to your own github fork, you can send us pull requests.
The following scripts should no longer be used, as they were designed for an earlier stage in the project.
Import DokuWiki files
Note: This is only possible by SilverStripe staff.
scp -P 2222 -r <username>@doc.silverstripe.org:/sites/ss2doc/www/assets/data/pages/* input/
Convert to Markdown files
cd scripts php TranslateSSDocs.php ../input ../output