search

silverstripe / silverstripe-framework

Silverstripe Framework, the MVC framework that powers Silverstripe CMS
https://www.silverstripe.org
BSD 3-Clause "New" or "Revised" License
721 stars 821 forks source link

[2012-04-13] Document new Config/YML and DataExtension API #1456

Closed silverstripe-issues closed 9 years ago

silverstripe-issues commented 11 years ago

created by: @chillu (ischommer) created at: 2012-04-13 original ticket: http://open.silverstripe.org/ticket/7141

The Config.php class is already well documented via PHPDoc, which can serve as a starting point. The PHPDoc in there is a bit technical, ideally we'd have more examples in the Markdown docs. There's already a configuration.md topic which describes _config.php etc, please use this document for the Config API as well, and in the intro describe the difference between the two approaches.

Also migrate parts of the DataExtension guide described at https://github.com/silverstripe/sapphire/pull/345 back to the mainline documentation

silverstripe-issues commented 11 years ago

comment by: @halkyon (sharvey) created at: 2012-04-18

I've documented some of the Config API specifically when upgrading, although some of it could be re-purposed into wider documentation on Config API. https://github.com/silverstripe/sapphire/pull/345/files

silverstripe-issues commented 11 years ago

comment by: @chillu (ischommer) created at: 2012-04-19

Yeah, in general, the upgrading guide is getting too long - we should ensure that we can link to relevant parts in the docs where possible, and keep the upgrading guide to a starting point. Sean, can you attempt that documentation, heavily borrowing from the PHPDoc? Or is that something Hamish needs to do?

silverstripe-issues commented 11 years ago

comment by: @chillu (ischommer) created at: 2012-08-07

Guys, we'll never get adoption of the config API if nobody knows how to use it. http://doc.silverstripe.org/DocumentationSearchForm?Search=config&Entities=framework&Versions=3.0&action_results=Search

silverstripe-issues commented 11 years ago

comment by: @chillu (ischommer) created at: 2012-08-29

Note that there's a broader ticket about updating the existing configuration docs in http://open.silverstripe.org/ticket/7523 (where the YAML config is one aspect).

silverstripe-issues commented 11 years ago

comment by: @chillu (ischommer) created at: 2012-08-29

Added another ticket around creating a debug view for the config YAML: silverstripe/sapphire#1577

wilr commented 9 years ago

Done as part of the beta docs.