diff --git a/docs/en/01_Tutorials/01_Building_A_Basic_Site.md b/docs/en/01_Tutorials/01_Building_A_Basic_Site.md index 6e582e9b8..94fbfb9c5 100644 --- a/docs/en/01_Tutorials/01_Building_A_Basic_Site.md +++ b/docs/en/01_Tutorials/01_Building_A_Basic_Site.md @@ -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 ## Overview diff --git a/docs/en/01_Tutorials/02_Extending_A_Basic_Site.md b/docs/en/01_Tutorials/02_Extending_A_Basic_Site.md index 491c21689..e25555711 100644 --- a/docs/en/01_Tutorials/02_Extending_A_Basic_Site.md +++ b/docs/en/01_Tutorials/02_Extending_A_Basic_Site.md @@ -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 ## Overview diff --git a/docs/en/01_Tutorials/03_Forms.md b/docs/en/01_Tutorials/03_Forms.md index 4f63f3f3d..1049d25f0 100644 --- a/docs/en/01_Tutorials/03_Forms.md +++ b/docs/en/01_Tutorials/03_Forms.md @@ -1,3 +1,5 @@ +summary: Capture and store user information through web forms. + # Tutorial 3 - Forms ## Overview diff --git a/docs/en/01_Tutorials/04_Site_Search.md b/docs/en/01_Tutorials/04_Site_Search.md index 05ccef493..f575b43d0 100644 --- a/docs/en/01_Tutorials/04_Site_Search.md +++ b/docs/en/01_Tutorials/04_Site_Search.md @@ -1,3 +1,5 @@ +summary: Enable website search. How to handle paged result sets and the SearchForm class. + # Tutorial 4 - Site Search ## Overview diff --git a/docs/en/01_Tutorials/05_Dataobject-Relationship_Management.md b/docs/en/01_Tutorials/05_Dataobject-Relationship_Management.md index 61ddb7abc..425ef9ff5 100644 --- a/docs/en/01_Tutorials/05_Dataobject-Relationship_Management.md +++ b/docs/en/01_Tutorials/05_Dataobject-Relationship_Management.md @@ -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 ## Overview diff --git a/docs/en/02_Developer_Guides/00_Model/05_Data_Model_and_ORM.md b/docs/en/02_Developer_Guides/00_Model/05_Data_Model_and_ORM.md old mode 100755 new mode 100644 diff --git a/docs/en/02_Developer_Guides/02_Controllers/01_Controllers.md b/docs/en/02_Developer_Guides/02_Controllers/01_Controllers.md old mode 100755 new mode 100644 diff --git a/docs/en/index.md b/docs/en/index.md index d3dda88ef..d91661449 100644 --- a/docs/en/index.md +++ b/docs/en/index.md @@ -1,58 +1,51 @@ -This website documents high-level features of the [SilverStripe open source platform](http://www.silverstripe.org), aimed -at developers. -Please read our [guide to contributing documentation](misc/contributing/documentation) if you want to help out! +title: SilverStripe Documentation +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. -### Overview +## Getting Started with SilverStripe - * [Getting started](http://silverstripe.org/getting-started/) | [Feature Overview](http://silverstripe.org/introduction/) | [Demo](http://demo.silverstripe.org/) - * [Download and Installation](installation/) | [Upgrading](/installation/upgrading) | [Requirements](/installation/server-requirements) | [Changelog](/changelogs) | [Roadmap](http://www.silverstripe.org/roadmap/) - * [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) +Before you start developing your first web application, you'll need to install the latest version of SilverStripe onto +a web server. The [Getting Started](getting_started/) section will show you what +[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) - * [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) +## SilverStripe Concepts -### 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 -* [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) +[CHILDREN Folder=02_Developer_Guides] -### Level 3: The less obvious features +## Contributing to SilverStripe -* [Security](topics/security) -* [Email](topics/email) -* [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/) +The SilverStripe Framework, Content Management System and related websites are open source and welcome community +contributions. -### Level 4: Contributing to the SilverStripe core - -* [Contributing](misc/contributing) -* [Coding Conventions](misc/coding-conventions) \ No newline at end of file +[CHILDREN Folder=05_Contributing]