From 1df3d7cee1a46b2bcb14dba145bf9a446f211e2a Mon Sep 17 00:00:00 2001 From: Cam Findlay Date: Mon, 20 Oct 2014 21:57:35 +1300 Subject: [PATCH] Rebased additional documentation since May 2014. New pages filed and metadata added. --- .../01_Installation/How_To/Setup_Nginx_and_HHVM.md} | 5 ++++- .../05_Extending/06_Aspects.md} | 8 ++++---- .../09_Security/03_Authentication.md} | 7 +++++-- .../16_Execution_Pipeline/02_Flushable.md} | 3 +++ docs/en/{changelogs => 04_Changelogs}/3.1.7.md | 0 docs/en/{changelogs => 04_Changelogs}/rc/3.1.6-rc1.md | 0 docs/en/{changelogs => 04_Changelogs}/rc/3.1.6-rc2.md | 0 docs/en/{changelogs => 04_Changelogs}/rc/3.1.6-rc3.md | 0 8 files changed, 16 insertions(+), 7 deletions(-) rename docs/en/{installation/nginx-hhvm.md => 00_Getting_Started/01_Installation/How_To/Setup_Nginx_and_HHVM.md} (96%) rename docs/en/{reference/aspects.md => 02_Developer_Guides/05_Extending/06_Aspects.md} (95%) rename docs/en/{topics/authentication.md => 02_Developer_Guides/09_Security/03_Authentication.md} (93%) rename docs/en/{reference/flushable.md => 02_Developer_Guides/16_Execution_Pipeline/02_Flushable.md} (94%) rename docs/en/{changelogs => 04_Changelogs}/3.1.7.md (100%) rename docs/en/{changelogs => 04_Changelogs}/rc/3.1.6-rc1.md (100%) rename docs/en/{changelogs => 04_Changelogs}/rc/3.1.6-rc2.md (100%) rename docs/en/{changelogs => 04_Changelogs}/rc/3.1.6-rc3.md (100%) diff --git a/docs/en/installation/nginx-hhvm.md b/docs/en/00_Getting_Started/01_Installation/How_To/Setup_Nginx_and_HHVM.md similarity index 96% rename from docs/en/installation/nginx-hhvm.md rename to docs/en/00_Getting_Started/01_Installation/How_To/Setup_Nginx_and_HHVM.md index c981290bc..45ab6ee8e 100644 --- a/docs/en/installation/nginx-hhvm.md +++ b/docs/en/00_Getting_Started/01_Installation/How_To/Setup_Nginx_and_HHVM.md @@ -1,4 +1,7 @@ -# nginx and HHVM +title: Nginx and HHVM +summary: Setting up Nginx and HHVM on Debian/Ubuntu using packages. + +# Nginx and HHVM [HHVM](http://hhvm.com/) is a faster alternative to PHP, in that it runs in a virtual machine and uses just-in-time (JIT) compilation to achieve better performance over standard PHP. diff --git a/docs/en/reference/aspects.md b/docs/en/02_Developer_Guides/05_Extending/06_Aspects.md similarity index 95% rename from docs/en/reference/aspects.md rename to docs/en/02_Developer_Guides/05_Extending/06_Aspects.md index 185842bb6..3913552ba 100644 --- a/docs/en/reference/aspects.md +++ b/docs/en/02_Developer_Guides/05_Extending/06_Aspects.md @@ -1,11 +1,11 @@ +title: Aspects +summary: Introduction to using aspect-oriented programming with SilverStripe. + # Aspects ## Introduction -Aspect oriented programming is the idea that some logic abstractions can be -applied across various type hierarchies "after the fact", altering the -behaviour of the system without altering the code structures that are already -in place. +Aspect oriented programming is the idea that some logic abstractions can be applied across various type hierarchies "after the fact", altering the behaviour of the system without altering the code structures that are already in place. > In computing, aspect-oriented programming (AOP) is a programming paradigm > which isolates secondary or supporting functions from the main program's diff --git a/docs/en/topics/authentication.md b/docs/en/02_Developer_Guides/09_Security/03_Authentication.md similarity index 93% rename from docs/en/topics/authentication.md rename to docs/en/02_Developer_Guides/09_Security/03_Authentication.md index 7bf25c10b..fa7722418 100644 --- a/docs/en/topics/authentication.md +++ b/docs/en/02_Developer_Guides/09_Security/03_Authentication.md @@ -1,6 +1,9 @@ +title: Authentication +summary: Explains SilverStripe's Authentication options and custom authenticators. + # Authentication -By default, silverstripe provides a `[api:MemberAuthenticator]` class which hooks into its own internal +By default, SilverStripe provides a `[api:MemberAuthenticator]` class which hooks into its own internal authentication system. The main login system uses these controllers to handle the various security requests: @@ -39,7 +42,7 @@ following base classes: ## Default Admin -When a new silverstripe site is created for the first time, it may be necessary to create a default admin to provide +When a new SilverStripe site is created for the first time, it may be necessary to create a default admin to provide CMS access for the first time. SilverStripe provides a default admin configuration system, which allows a username and password to be configured for a single special user outside of the normal membership system. diff --git a/docs/en/reference/flushable.md b/docs/en/02_Developer_Guides/16_Execution_Pipeline/02_Flushable.md similarity index 94% rename from docs/en/reference/flushable.md rename to docs/en/02_Developer_Guides/16_Execution_Pipeline/02_Flushable.md index 9f2c61815..1e908af67 100644 --- a/docs/en/reference/flushable.md +++ b/docs/en/02_Developer_Guides/16_Execution_Pipeline/02_Flushable.md @@ -1,3 +1,6 @@ +title: Flushable +summary: Allows a class to define it's own flush functionality. + # Flushable ## Introduction diff --git a/docs/en/changelogs/3.1.7.md b/docs/en/04_Changelogs/3.1.7.md similarity index 100% rename from docs/en/changelogs/3.1.7.md rename to docs/en/04_Changelogs/3.1.7.md diff --git a/docs/en/changelogs/rc/3.1.6-rc1.md b/docs/en/04_Changelogs/rc/3.1.6-rc1.md similarity index 100% rename from docs/en/changelogs/rc/3.1.6-rc1.md rename to docs/en/04_Changelogs/rc/3.1.6-rc1.md diff --git a/docs/en/changelogs/rc/3.1.6-rc2.md b/docs/en/04_Changelogs/rc/3.1.6-rc2.md similarity index 100% rename from docs/en/changelogs/rc/3.1.6-rc2.md rename to docs/en/04_Changelogs/rc/3.1.6-rc2.md diff --git a/docs/en/changelogs/rc/3.1.6-rc3.md b/docs/en/04_Changelogs/rc/3.1.6-rc3.md similarity index 100% rename from docs/en/changelogs/rc/3.1.6-rc3.md rename to docs/en/04_Changelogs/rc/3.1.6-rc3.md