Merge branch 'feature/doc-build-chain'

Close #279

.gitignore

@@ -1,5 +1,7 @@
 doc/html/
 vendor/
+zf-mkdoc-theme/
 clover.xml
 composer.lock
 coveralls-upload.json
+zf-mkdoc-theme.tgz

.travis.yml

@@ -5,44 +5,59 @@ language: php
 cache:
   directories:
     - $HOME/.composer/cache
+    - $HOME/.local
     - vendor
+    - zf-mkdoc-theme
+
+env:
+  global:
+    - SITE_URL: https://zendframework.github.io/zend-expressive
+    - GH_USER_NAME: "Matthew Weier O'Phinney"
+    - GH_USER_EMAIL: [email protected]
+    - GH_REF: github.com/zendframework/zend-expressive.git
+    - secure: "C3RfQG69KAbqQqyQAgF6LhPvIpy5zSk0XnILvGEbcDoB36gg6/OcEHFCfFGdDZdSc3itDwwt65eiCVvKC4K5deuvqbCR1gAHAacYpW4jDV4fVaO40eiqZmQ7BZ1LHBQssJsa46yd0lwMmnj7V1Gya8MhD7ga5LINUe6ZxGzgo2Y3XRSWUzYcIiiGbCXXTgix8yG4de+Z5batsx0aT+99E0+U0DVB+DGoVaWRNwOY0UNdggTaKG0ahPJczlMsMsXyafop7LVAsYdIvaYoOMC8gshB/tket+q0b+61i9zaDtQv+x0oWvkobyDksr24jYkLAKMMQGFBq1cVJElVbNHSdtY0dLunpnQn9iaZ8PW8IhIw83YeyR9KPgbX3bF9SRt+Eay2j/YB2RbNK5BG2c/NeidnflMjcjPEhA4Ab6f0N1vy9wex5w/FAJUrhpfQB6AZgIJ/wovnJJAvF1etBSfZ0CYA+oAzYRRFQXo5Eq+lxvX5mQ2w2+sv6sUBS0IoP+1+JKzR98k2pi+q+4HhVVPH28aRfr8PTR/YRCmcUK68H7OKWf8h1vuJYjtN3V5FBOhlej8N9cYqQUBj4YpITqYP0PdzE1iUOoDpZVBMlWqxYw1vKhNiWusMCdJlI1psGWNs9t7hrMpJCg9eRWCe16akEoRrZGreU53ekFZpgeEQgGI="
 
 matrix:
   fast_finish: true
   include:
     - php: 5.5
       env:
         - EXECUTE_CS_CHECK=true
-        - EXECUTE_DOC_CHECK=true
     - php: 5.6
       env:
         - EXECUTE_TEST_COVERALLS=true
+        - DEPLOY_DOCS=true
     - php: 7
-    - php: hhvm 
+    - php: hhvm
   allow_failures:
     - php: hhvm
 
 before_install:
+  - export PATH="$HOME/.local/bin:$PATH"
   - if [[ $EXECUTE_TEST_COVERALLS != 'true' ]]; then phpenv config-rm xdebug.ini || return 0 ; fi
   - composer self-update
-  - if [[ $EXECUTE_DOC_CHECK == 'true' ]]; then composer require --dev --no-update phly/bookdown2mkdocs ; fi
   - if [[ $EXECUTE_TEST_COVERALLS == 'true' ]]; then composer require --dev --no-update satooshi/php-coveralls:dev-master ; fi
 
 install:
   - travis_retry composer install --no-interaction
   - composer info -i
 
-before_script:
-  - if [[ $EXECUTE_DOC_CHECK == 'true' ]]; then cp mkdocs.yml mkdocs.yml.orig ; fi
-
 script:
   - if [[ $EXECUTE_TEST_COVERALLS == 'true' ]]; then composer test-coverage ; fi
   - if [[ $EXECUTE_TEST_COVERALLS != 'true' ]]; then composer test ; fi
   - if [[ $EXECUTE_CS_CHECK == 'true' ]]; then composer cs ; fi
-  - if [[ $EXECUTE_DOC_CHECK == 'true' ]]; then make mkdocs ; diff mkdocs.yml mkdocs.yml.orig ; return $? ; fi
 
 after_script:
   - if [[ $EXECUTE_TEST_COVERALLS == 'true' ]]; then composer coveralls ; fi
 
+after_success:
+  - export DEPLOY=$(if [[ $DEPLOY_DOCS == 'true' && $TRAVIS_BRANCH == 'master' && $TRAVIS_PULL_REQUEST == 'false' ]]; then echo -n "true" ; else echo -n "false" ; fi)
+  - export NEEDS_THEME=$([ -d zf-mkdoc-theme/theme ] ; result=$? ; if (( result == 0 )); then echo -n "false"; else echo -n "true" ; fi)
+  - if [[ $DEPLOY == "true" ]]; then pip install --user mkdocs ; fi
+  - if [[ $DEPLOY == "true" ]]; then pip install --user pymdown-extensions ; fi
+  - if [[ $DEPLOY == "true" && $NEEDS_THEME == "true" ]]; then echo "Downloading zf-mkdoc-theme" ; $(if [[ ! -d zf-mkdoc-theme ]];then mkdir zf-mkdoc-theme ; fi) ; $(curl -s -L https://github.com/zendframework/zf-mkdoc-theme/releases/latest | egrep -o '/zendframework/zf-mkdoc-theme/archive/[0-9]*\.[0-9]*\.[0-9]*.tar.gz' | head -n1 | wget -O zf-mkdoc-theme.tgz --base=https://github.com/ -i -) ; $(cd zf-mkdoc-theme ; tar xzf ../zf-mkdoc-theme.tgz --strip-components=1) ; echo "Finished downloading and installing zf-mkdoc-theme" ; fi
+  - export CAN_DEPLOY=$([ -f zf-mkdoc-theme/deploy.sh ] ; result=$? ; if (( result == 0 )); then echo -n "true"; else echo -n "false" ; fi)
+  - if [[ $DEPLOY == "true" && $CAN_DEPLOY == "true" ]]; then echo "Preparing to build and deploy documentation" ; ./zf-mkdoc-theme/deploy.sh ; echo "Completed deploying documentation" ; else echo "Missing deployment script" ; fi
+
 notifications:
   email: true

CHANGELOG.md

@@ -2,6 +2,29 @@
 
 All notable changes to this project will be documented in this file, in reverse chronological order by release.
 
+## 1.0.0 - TBD
+
+Initial stable release.
+
+### Added
+
+- [#279](https://github.com/zendframework/zend-expressive/pull/279) updates
+  the documentation to provide automation for pushing to GitHub pages. As part
+  of that work, documentation was re-organized, and a landing page provided.
+  Documentation can now be found at: https://zendframework.github.io/zend-expressive/
+
+### Deprecated
+
+- Nothing.
+
+### Removed
+
+- Nothing.
+
+### Fixed
+
+- Nothing.
+
 ## 1.0.0rc7 - 2016-01-21
 
 Seventh release candidate.

README.md

@@ -83,20 +83,14 @@ documentation.
 
 ## Documentation
 
-Documentation is [in the doc tree](doc/), and can be compiled using [bookdown](http://bookdown.io):
+Documentation is [in the doc tree](doc/book/), and can be compiled using [mkdocs](http://www.mkdocs.org):
 
 ```bash
-$ bookdown doc/bookdown.json
-$ php -S 0.0.0.0:8080 -t doc/html/ # then browse to http://localhost:8080/
+$ mkdocs build
 ```
 
-> ### Bookdown
->
-> You can install bookdown globally using `composer global require bookdown/bookdown`. If you do
-> this, make sure that `$HOME/.composer/vendor/bin` is on your `$PATH`.
-
 Additionally, public-facing, browseable documentation is available at
-http://zend-expressive.rtfd.org.
+https://zendframework.github.io/zend-expressive/
 
 ## Architecture
 

doc/book/cookbook/common-prefix-for-routes.md

@@ -19,7 +19,7 @@ As your application progresses, you may have a mixture of different content, and
 the above segregated under the path `/api`.
 
 This is essentially the same problem as addressed in the
-["Segregating your application to a subpath"](../usage-examples.md#segregating-your-application-to-a-subpath) example.
+["Segregating your application to a subpath"](../reference/usage-examples.md#segregating-your-application-to-a-subpath) example.
 
 To accomplish it:
 

doc/book/cookbook/custom-404-page-handling.md

@@ -1,7 +1,7 @@
 # How can I set custom 404 page handling?
 
 In some cases, you may want to handle 404 errors separately from the
-[final handler](../error-handling.md). This can be done by registering
+[final handler](../features/error-handling.md). This can be done by registering
 middleware that operates late — specifically, after the routing
 middleware. Such middleware will be executed if no other middleware has
 executed, and/or when all other middleware calls `return $next()`
@@ -78,7 +78,7 @@ that does not rely on the final handler.
 ## Registering custom 404 handlers
 
 We can register either `Application\NotFound` class above as service in the
-[service container](../container/intro.md). In the case of the second approach,
+[service container](../features/container/intro.md). In the case of the second approach,
 you would also need to provide a factory for creating the middleware (to ensure
 you inject the template renderer).
 

doc/book/features.md → doc/book/getting-started/features.md

@@ -69,7 +69,7 @@ features it provides include:
 
 Below is a diagram detailing the workflow used by Expressive.
 
-![Expressive Architectural Flow](images/architecture.png)
+![Expressive Architectural Flow](../images/architecture.png)
 
 The `Application` acts as an "onion"; in the diagram above, the top is the
 outer-most layer of the onion, while the bottom is the inner-most.
@@ -151,7 +151,7 @@ will execute in one of two conditions:
 - routed middleware called on the next middleware instead of returning a response.
 
 As such, the largest use case for such middleware is for error handling.
-One possibility is for [providing custom 404 handling](cookbook/custom-404-page-handling.md),
+One possibility is for [providing custom 404 handling](../cookbook/custom-404-page-handling.md),
 or handling application-specific error conditions (such as authentication or
 authorization failures).
 

doc/book/quick-start-skeleton.md → doc/book/getting-started/skeleton.md

@@ -271,7 +271,7 @@ Congratulations! You've now created your application, and started writing
 middleware! It's time to start learning about the rest of the features of
 Expressive:
 
-- [Containers](container/intro.md)
-- [Routing](router/intro.md)
-- [Templating](template/intro.md)
-- [Error Handling](error-handling.md)
+- [Containers](../features/container/intro.md)
+- [Routing](../features/router/intro.md)
+- [Templating](../features/template/intro.md)
+- [Error Handling](../features/error-handling.md)

doc/book/quick-start.md → doc/book/getting-started/standalone.md

@@ -2,7 +2,7 @@
 
 Expressive allows you to get started at your own pace. You can start with
 the simplest example, detailed below, or move on to a more structured,
-configuration-driven approach as detailed in the [use case examples](usage-examples.md).
+configuration-driven approach as detailed in the [use case examples](../reference/usage-examples.md).
 
 ## 1. Create a new project directory
 
@@ -113,10 +113,10 @@ http://localhost:8080/ to see if your application responds correctly!
 At this point, you have a working zend-expressive application, that responds to
 a single route. From here, you may want to read up on:
 
-- [Applications](application.md)
-- [Containers](container/intro.md)
-- [Routing](router/intro.md)
-- [Templating](template/intro.md)
-- [Error Handling](error-handling.md)
+- [Applications](../features/application.md)
+- [Containers](../features/container/intro.md)
+- [Routing](../features/router/intro.md)
+- [Templating](../features/template/intro.md)
+- [Error Handling](../features/error-handling.md)
 
-Additionally, we have more [use case examples](usage-examples.md).
+Additionally, we have more [use case examples](../reference/usage-examples.md).