tonyair/silverstripe-framework
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-framework synced 2024-06-29 07:59:31 +02:00
Code Issues Projects Releases Wiki Activity

MINOR Added docs/ contributing notes

Browse Source
This commit is contained in:
Ingo Schommer 2011-02-23 20:14:04 -08:00
parent d045970d83
commit 7cb687b5e0
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/en/misc/contributing.md
View File

@ -152,7 +152,13 @@ reviewing existing documentation, and translating the whole thing.
Modifying documentation requires basic [PHPDoc](http://en.wikipedia.org/wiki/PHPDoc) and
[Markdown](http://daringfireball.net/projects/markdown/)/[SSMarkdown](ss-markdown) knowledge.
If you have downloaded SilverStripe or a module, chances
are that you already have the documentation files - they are kept alongside the source code.
are that you already have the documentation files - they are kept alongside the source code (in the `docs/` subfolder).
In general, you have to "[fork](http://help.github.com/forking/)" the [github.com/silverstripe/sapphire](http://github.com/silverstripe/sapphire)
and [github.com/silverstripe/silverstripe-cms](http://github.com/silverstripe/silverstripe-cms) repositories
and send us "[pull requests](http://help.github.com/pull-requests/)".
Note: Smaller edits can be performed in the github.com web interface on your fork,
every page view should have an "edit this file" button.
The [doc.silverstripe.org](http://doc.silverstripe.org) website itself is powered by a
SilverStripe project that uses the ["sapphiredocs" module](http://open.silverstripe.org/browser/modules/sapphiredocs/trunk)