Skip to main content

This site requires you to update your browser. Your browsing experience maybe affected by not having the most up to date version.

Releases and Announcements /

Latest news about the SilverStripe software.

Moderators: martimiz, Sean, biapar, Willr, Ingo, swaiba, simon_w

doc.silverstripe.org cleanup


Reply


2 Posts   1269 Views

Avatar
Ingo

Forum Moderator, 801 Posts

7 May 2010 at 9:21am

In context of releasing 2.4.0, we've gone through the documentation with the following goals:
* Remove irrelevant class placeholder pages without content which are just pointing to the API
* Move "API-style" documentation into PHPDoc sourcecode (making it version specific, and show up on api.ss.org)
* Remove references to deprecated classes
* Remove jsparty references
* Remove "Minimum requirement: SilverStripe 2.2" notices
* Move community-contributed pages into "recipes:" and "modules:" namespace

You can see the full list of changes in the RSS feed: http://doc.silverstripe.org/feed.php

There's a general theme here: We want to make the documentation more relevant, maintainable and accurate. We're at the start of this effort, and have further plans involving Markdown formatting and tutorials in version control. Stay tuned - feedback welcome of course :)

Here's a list of renamed and removed pages (they dont show up in the RSS feed).
Sorry for the inconvenience of breaking some links here, but I think everybody's better served by a lean index and relevant search results rather than hundreds of "moved page to..." placeholder pages.

# Renamed
addingprintstylesheet => recipes:addingprintstylesheet
amazing_looking_forms_using_silverstripe_form_default_rendering => recipes:amazing_looking_forms_using_silverstripe_form_default_rendering
ecommerce => modules:ecommerce
googlesummerofcode => gsoc
newslettersytemhelp => modules:newsletter
simplehtmleditorfield => modules:simplehtmleditorfield
simpletreedropdownfield => modules:simpletreedropdownfield
simplewysiwygfield => modules:simplewysiwygfield

# Removed
2.4
ajaxformaction
allclasses
authenticator
bankaccountfield
boolean
calendardatefield
compositedatefield
confirmedformaction
contentnegotiator
countrydropdownfield
creditcardfield
currency
date
dbfield
decimal
demosite
developerguide
dmycalendardatefield
ecommerce
email_bouncehandler
enum
flash
formfield
formtransformation
googlesummerofcode
gstnumberfield
htmltext
htmlvarchar
int
jquery
labelledliteralfield
manipulationarrays
newslettersytemhelp
percentage
phonenumberfield
recipies
relateddataeditor
relateddatafield
requiredfields
securityadmintest
sqlsyntaxcompatibility
ssakismet
ssdatetime
suggestions_field
text
timefield
time
varchar
windmilltesting
xhtmlsupport
xml

Avatar
ttyl

Community Member, 114 Posts

8 May 2010 at 3:16am

this is great news, documentation is one of the few things holding SS back. I believe with better documentation you'll get a lot more adoption of the platform which is good for everybody.