Merge pull request #47 from froschdesign/hotfix/docs/missing-installa…

…tion-page

Adds missing installation page and updates introduction

.github/workflows/docs-build.yml

@@ -3,8 +3,7 @@ name: docs-build
 on:
   release:
     types: [published]
-  repository_dispatch:
-    types: docs-build
+  workflow_dispatch:
 
 jobs:
   build-deploy:
@@ -13,5 +12,5 @@ jobs:
       - name: Build Docs
         uses: laminas/documentation-theme/github-actions/docs@master
         env:
-          "DOCS_DEPLOY_KEY": ${{ secrets.DOCS_DEPLOY_KEY }}
-          "GITHUB_TOKEN": ${{ secrets.GITHUB_TOKEN }}
+          DEPLOY_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

docs/book/v1/installation.md

@@ -0,0 +1,30 @@
+---
+show_file_content: true
+---
+
+<!-- markdownlint-disable MD001 MD041 -->
+## Cache Implementation Required
+<!-- markdownlint-restore -->
+
+To use this component, a PSR-6 `CacheItemPoolInterface` implementation is required.
+[laminas-cache](https://docs.laminas.dev/laminas-cache/) provides the PSR-6 implementations, install it and choose one of the cache adapters.
+
+### Install laminas-cache and a Cache Adapter
+
+Install laminas-cache via [Composer](https://getcomposer.org/):
+
+```bash
+$ composer require laminas/laminas-cache
+```
+
+laminas-cache is shipped without a specific cache adapter to allow free choice of storage backends and their dependencies.
+For example, install the [laminas-cache `Filesystem` adapter](https://docs.laminas.dev/laminas-cache/v3/storage/adapter/#filesystem-adapter):
+
+```bash
+$ composer require laminas/laminas-cache-storage-adapter-filesystem
+```
+
+### Read More in the laminas-cache Documentation
+
+- [PSR-6](https://docs.laminas.dev/laminas-cache/v3/psr6/)
+- [Cache Adapters](https://docs.laminas.dev/laminas-cache/v3/storage/adapter/)

docs/book/v1/intro.md

@@ -8,20 +8,6 @@ pool in which to store and retrieve sessions. PSR-6 was chosen over the simpler
 [PSR-16](https://www.php-fig.org/psr/psr-16/) as it specifically provides
 functionality around _expiry_, which allows us to expire sessions.
 
-## Installation
-
-Install mezzio-session-cache via [Composer](https://getcomposer.org/):
-
-```bash
-$ composer require mezzio/mezzio-session-cache
-```
-
-You will also need to install a package that provides a PSR-6
-`CacheItemPoolInterface` implementation. You can [search for PSR-6 providers on
-Packagist](https://packagist.org/providers/psr/cache-implementation). We have
-had excellent luck with the various implementations provided by the [PHP-Cache
-project](http://www.php-cache.com/en/latest/).
-
 ## Usage
 
 Generally, you will only provide configuration for this service, including

mkdocs.yml

@@ -3,10 +3,13 @@ site_dir: docs/html
 nav:
     - Home: index.md
     - Introduction: v1/intro.md
+    - Installation: v1/installation.md
     - Configuration: v1/config.md
     - "Manual Usage": v1/manual.md
 site_name: mezzio-session-cache
 site_description: 'PSR-6 session persistence adapter for mezzio-session.'
 repo_url: 'https://github.com/mezzio/mezzio-session-cache'
 extra:
     project: Mezzio
+    installation:
+        config_provider_class: 'Mezzio\Session\Cache\ConfigProvider'