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

Update documentation introduction

Browse Source
This commit is contained in:
Will Rossiter 2014-09-20 14:10:49 +12:00 committed by Cam Findlay
parent 015afe83e8
commit 1ceb10be4a
8 changed files with 49 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/en/01_Tutorials/01_Building_A_Basic_Site.md
View File

@ -1,3 +1,5 @@
summary: An overview of the SilverStripe installation and an introduction to creating a web page.
# Tutorial 1 - Building a Basic Site # Tutorial 1 - Building a Basic Site
## Overview ## Overview

2
docs/en/01_Tutorials/02_Extending_A_Basic_Site.md
View File

@ -1,3 +1,5 @@
summary: Building on tutorial 1, a look at storing data in SilverStripe and creating a latest news feed.
# Tutorial 2 - Extending a basic site # Tutorial 2 - Extending a basic site
## Overview ## Overview

2
docs/en/01_Tutorials/03_Forms.md
View File

@ -1,3 +1,5 @@
summary: Capture and store user information through web forms.
# Tutorial 3 - Forms # Tutorial 3 - Forms
## Overview ## Overview

2
docs/en/01_Tutorials/04_Site_Search.md
View File

@ -1,3 +1,5 @@
summary: Enable website search. How to handle paged result sets and the SearchForm class.
# Tutorial 4 - Site Search # Tutorial 4 - Site Search
## Overview ## Overview

3
docs/en/01_Tutorials/05_Dataobject-Relationship_Management.md
View File

@ -1,3 +1,6 @@
title: DataObject Relationship Management
summary: Learn how to create custom DataObjects and how to build interfaces for managing that data.
# Tutorial 5 - Dataobject Relationship Management # Tutorial 5 - Dataobject Relationship Management
## Overview ## Overview

0
docs/en/02_Developer_Guides/00_Model/05_Data_Model_and_ORM.md Executable file → Normal file
View File

0
docs/en/02_Developer_Guides/02_Controllers/01_Controllers.md Executable file → Normal file
View File

83
docs/en/index.md
View File

@ -1,58 +1,51 @@
This website documents high-level features of the [SilverStripe open source platform](http://www.silverstripe.org), aimed title: SilverStripe Documentation
at developers. introduction: Welcome to the SilverStripe Developer Documentation. This website is aimed at website developers looking to learn how to build and manage web applications with the SilverStripe Framework.
Please read our [guide to contributing documentation](misc/contributing/documentation) if you want to help out!
### Overview ## Getting Started with SilverStripe
* [Getting started](http://silverstripe.org/getting-started/) | [Feature Overview](http://silverstripe.org/introduction/) | [Demo](http://demo.silverstripe.org/) Before you start developing your first web application, you'll need to install the latest version of SilverStripe onto
* [Download and Installation](installation/) | [Upgrading](/installation/upgrading) | [Requirements](/installation/server-requirements) | [Changelog](/changelogs) | [Roadmap](http://www.silverstripe.org/roadmap/) a web server. The [Getting Started](getting_started/) section will show you what
* [API documentation](http://api.silverstripe.org/current) | [Official english book](http://www.silverstripe.org/silverstripe-book) | [Official german book](http://www.silverstripe.org/das-silverstripe-buch) [server requirements](/installation/server-requirements) you will need to meet and how to
[download and install SilverStripe](installation/).
To check out the features that SilverStripe offers without installing it, read the [Feature Overview](http://silverstripe.org/introduction/)
and play with the interactive [demo website](http://demo.silverstripe.org/).
## Getting support
SilverStripe has an wide range of options for getting support. The [forums](http://www.silverstripe.org/forums/)
and [IRC channel](http://silverstripe.org/irc) are the best places to talk and discuss questions and problems with the
community. There are also several other websites with SilverStripe documentation to make use of.
* The [API Documentation](http://api.silverstripe.org/current) contains technical reference and class information.
* The [User Help](http://userhelp.silverstripe.com) website contains documentation related to working within the CMS.
New features, API changes and the development [roadmap](http://www.silverstripe.org/roadmap/) for the product are
discussed on the [core mailinglist](https://groups.google.com/forum/#!forum/silverstripe-dev) along with
[UserVoice](http://silverstripe.uservoice.com/forums/251266-new-features).
### Getting support ## Building your first SilverStripe Web application
[Forum](http://www.silverstripe.org/forums/) | [IRC channel](http://silverstripe.org/irc) | [End user docs](http://userhelp.silverstripe.com) | [Core mailinglist](https://groups.google.com/forum/#!forum/silverstripe-dev) Once you have completed the [Getting Started](http://silverstripe.org/getting-started/) guide and have got SilverStripe
installed and running, the following [Tutorials](tutorials/) will lead through the basics and core concepts of
SilverStripe.
Make sure you know the basic concepts of PHP5 before attempting to follow the tutorials. If you have not programmed with
PHP5 be sure to read the [Introduction to PHP5 (zend.com)](http://devzone.zend.com/6/php-101--php-for-the-absolute-beginner).
### Level 1: Building your first SilverStripe website [CHILDREN Folder=01_Tutorials]
* [Introduction to PHP5 (zend.com)](http://devzone.zend.com/6/php-101--php-for-the-absolute-beginner) ## SilverStripe Concepts
* [Tutorials](tutorials)
* [1. Building a basic site](tutorials/1-building-a-basic-site)
* [2. Extending a basic site](tutorials/2-extending-a-basic-site)
* [3. Forms](tutorials/3-forms)
* [4. Site Search](tutorials/4-site-search)
* [5. Relationships](tutorials/5-dataobject-relationship-management)
* [Common Problems](installation/common-problems)
### Level 2: SilverStripe fundamentals The [Developer Gudes](developer_guides/) contain more detailed documentation on certain SilverStripe topics, how-to
examples and reference documentation.
* [Templates](reference/templates): SilverStripe has its own templating engine [CHILDREN Folder=02_Developer_Guides]
* [Themes](topics/themes): How to customize your site with themes
* [Controllers](topics/controller): Coordination from a URL-request to finding the controller-class
* [Pagetypes](topics/page-types): Clarifying the relationship between a page-object and a silverstripe-class
* [Datamodel](topics/datamodel): Object-relational database model with MVC
* [Database Structure](reference/database-structure): Breakdown of a typical SilverStripe database
* [Datatypes](topics/data-types): Casting database-columns
* [Forms](topics/forms): Sophisticated form generation and processing
* [Formfield Types](reference/form-field-types): Simple and complex form-elements with built-in validation
* [Javascript](topics/javascript)
* [Widgets](topics/widgets)
* [Modules](topics/modules)
* [Configuration](topics/configuration)
### Level 3: The less obvious features ## Contributing to SilverStripe
* [Security](topics/security) The SilverStripe Framework, Content Management System and related websites are open source and welcome community
* [Email](topics/email) contributions.
* [RSS Feeds](reference/rssfeed)
* [Debugging](topics/debugging)
* [Errorhandling](topics/error-handling)
* [Testing Guide](topics/testing/): Unit and integration testing
* [Execution Pipeline](reference/execution-pipeline): Tracking a request from director to template-rendering
* [Recipes/Howtos](howto/)
### Level 4: Contributing to the SilverStripe core [CHILDREN Folder=05_Contributing]
* [Contributing](misc/contributing)
* [Coding Conventions](misc/coding-conventions)