tonyair/silverstripe-framework
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-framework synced 2024-10-22 14:05:37 +02:00
Code Issues Projects Releases Wiki Activity

Merge pull request #5608 from chillu/pulls/4.0/contributing-docs-master

Browse Source 
Clarify where docs commits go
This commit is contained in:
Damian Mooyman 2016-06-10 11:57:27 +12:00 committed by GitHub
commit 8fdcae5c7d
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/en/05_Contributing/05_Documentation.md
View File

@ -44,6 +44,11 @@ If you submit a new feature or an API change, we strongly recommend that your pa
In order to balance editorial control with effective collaboration, we keep documentation alongside the module source code, e.g. in `framework/docs/`, or as code comments within PHP code. Contributing documentation is the same process as providing any other patch (see [Contributing code](code)).
Documentation should always be provided for the earliest stable release it applies to
(we're merging up these changes to newer versions periodically).
One exception are docs in `docs/en/contributing/`, which should always be changed on `master` since
its contents are general advice and don't apply to any particular release.
## What to write
See [what to write (jacobian.org)](http://jacobian.org/writing/great-documentation/what-to-write/) for an excellent introduction to the different types of documentation. Also see [producing OSS: "documentation"](http://producingoss.com/en/getting-started.html#documentation) for good rules of thumb