Merge pull request #215 from gsteel/v2-docs-dir

Collect V2 Docs into a sub-folder
laminas · Aug 17, 2023 · d987dc9 · d987dc9
2 parents 055623f + 67dbd66
commit d987dc9
Show file tree

Hide file tree

Showing 33 changed files with 80 additions and 38 deletions.
diff --git a/...ok/application-integration/stand-alone.md → ...v2/application-integration/stand-alone.md b/...ok/application-integration/stand-alone.md → ...v2/application-integration/stand-alone.md
diff --git a/...okbook/setting-module-specific-layouts.md → ...okbook/setting-module-specific-layouts.md b/...okbook/setting-module-specific-layouts.md → ...okbook/setting-module-specific-layouts.md
diff --git a/docs/book/helpers/advanced-usage.md → docs/book/v2/helpers/advanced-usage.md b/docs/book/helpers/advanced-usage.md → docs/book/v2/helpers/advanced-usage.md
diff --git a/docs/book/helpers/asset.md → docs/book/v2/helpers/asset.md b/docs/book/helpers/asset.md → docs/book/v2/helpers/asset.md
diff --git a/docs/book/helpers/base-path.md → docs/book/v2/helpers/base-path.md b/docs/book/helpers/base-path.md → docs/book/v2/helpers/base-path.md
diff --git a/docs/book/helpers/cycle.md → docs/book/v2/helpers/cycle.md b/docs/book/helpers/cycle.md → docs/book/v2/helpers/cycle.md
diff --git a/docs/book/helpers/doctype.md → docs/book/v2/helpers/doctype.md b/docs/book/helpers/doctype.md → docs/book/v2/helpers/doctype.md
diff --git a/docs/book/helpers/escape.md → docs/book/v2/helpers/escape.md b/docs/book/helpers/escape.md → docs/book/v2/helpers/escape.md
diff --git a/docs/book/helpers/flash-messenger.md → docs/book/v2/helpers/flash-messenger.md b/docs/book/helpers/flash-messenger.md → docs/book/v2/helpers/flash-messenger.md
diff --git a/docs/book/helpers/gravatar-image.md → docs/book/v2/helpers/gravatar-image.md b/docs/book/helpers/gravatar-image.md → docs/book/v2/helpers/gravatar-image.md
diff --git a/docs/book/helpers/gravatar.md → docs/book/v2/helpers/gravatar.md b/docs/book/helpers/gravatar.md → docs/book/v2/helpers/gravatar.md
diff --git a/docs/book/helpers/head-link.md → docs/book/v2/helpers/head-link.md b/docs/book/helpers/head-link.md → docs/book/v2/helpers/head-link.md
diff --git a/docs/book/helpers/head-meta.md → docs/book/v2/helpers/head-meta.md b/docs/book/helpers/head-meta.md → docs/book/v2/helpers/head-meta.md
diff --git a/docs/book/helpers/head-script.md → docs/book/v2/helpers/head-script.md b/docs/book/helpers/head-script.md → docs/book/v2/helpers/head-script.md
diff --git a/docs/book/helpers/head-style.md → docs/book/v2/helpers/head-style.md b/docs/book/helpers/head-style.md → docs/book/v2/helpers/head-style.md
diff --git a/docs/book/helpers/head-title.md → docs/book/v2/helpers/head-title.md b/docs/book/helpers/head-title.md → docs/book/v2/helpers/head-title.md
diff --git a/docs/book/helpers/html-attributes.md → docs/book/v2/helpers/html-attributes.md b/docs/book/helpers/html-attributes.md → docs/book/v2/helpers/html-attributes.md
diff --git a/docs/book/helpers/html-list.md → docs/book/v2/helpers/html-list.md b/docs/book/helpers/html-list.md → docs/book/v2/helpers/html-list.md
diff --git a/docs/book/helpers/html-object.md → docs/book/v2/helpers/html-object.md b/docs/book/helpers/html-object.md → docs/book/v2/helpers/html-object.md
diff --git a/docs/book/helpers/html-tag.md → docs/book/v2/helpers/html-tag.md b/docs/book/helpers/html-tag.md → docs/book/v2/helpers/html-tag.md
diff --git a/docs/book/helpers/identity.md → docs/book/v2/helpers/identity.md b/docs/book/helpers/identity.md → docs/book/v2/helpers/identity.md
diff --git a/docs/book/helpers/inline-script.md → docs/book/v2/helpers/inline-script.md b/docs/book/helpers/inline-script.md → docs/book/v2/helpers/inline-script.md
diff --git a/docs/book/helpers/intro.md → docs/book/v2/helpers/intro.md b/docs/book/helpers/intro.md → docs/book/v2/helpers/intro.md
@@ -61,7 +61,7 @@ for, and rendering, the various HTML `<head>` tags, such as `HeadTitle`,
 - [Cycle](cycle.md)
 - [Doctype](doctype.md)
 - [FlashMessenger](flash-messenger.md)
-- [Gravatar](gravatar.md) _(Deprecated)_
+- [Gravatar](gravatar.md) *(Deprecated)*
 - [GravatarImage](gravatar-image.md)
 - [HeadLink](head-link.md)
 - [HeadMeta](head-meta.md)

diff --git a/docs/book/helpers/json.md → docs/book/v2/helpers/json.md b/docs/book/helpers/json.md → docs/book/v2/helpers/json.md
diff --git a/docs/book/helpers/layout.md → docs/book/v2/helpers/layout.md b/docs/book/helpers/layout.md → docs/book/v2/helpers/layout.md
diff --git a/docs/book/helpers/partial.md → docs/book/v2/helpers/partial.md b/docs/book/helpers/partial.md → docs/book/v2/helpers/partial.md
diff --git a/docs/book/helpers/placeholder.md → docs/book/v2/helpers/placeholder.md b/docs/book/helpers/placeholder.md → docs/book/v2/helpers/placeholder.md
diff --git a/docs/book/helpers/url.md → docs/book/v2/helpers/url.md b/docs/book/helpers/url.md → docs/book/v2/helpers/url.md
diff --git a/docs/book/php-renderer.md → docs/book/v2/php-renderer.md b/docs/book/php-renderer.md → docs/book/v2/php-renderer.md
diff --git a/docs/book/quick-start.md → docs/book/v2/quick-start.md b/docs/book/quick-start.md → docs/book/v2/quick-start.md
diff --git a/docs/book/view-event.md → docs/book/v2/view-event.md b/docs/book/view-event.md → docs/book/v2/view-event.md
diff --git a/docs/book/view-scripts.md → docs/book/v2/view-scripts.md b/docs/book/view-scripts.md → docs/book/v2/view-scripts.md
@@ -5,6 +5,8 @@ requested view script and executes it "inside" the scope of the `PhpRenderer`
 instance. Therefore, in your view scripts, references to `$this` actually point
 to the `PhpRenderer` instance itself.
 
+## Variables
+
 Variables assigned to the view, either via a [View Model](quick-start.md#controllers-and-view-models),
 [Variables container](quick-start.md), or by passing an array of variables to
 `render()`, may be retrieved in three ways:
@@ -64,6 +66,7 @@ introduction.
 >  * @var Laminas\View\Renderer\PhpRenderer $this
 >  */
 > ```
+>
 > The different Laminas components that contain view helpers provide `HelperTrait` traits with more aliases of the view helpers.
 > These traits can be chained with a pipe symbol (a.k.a. vertical bar) `|` as many as needed, depending on which view helpers from the different Laminas component are used and where the auto-completion is to be made.
 

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1,44 +1,83 @@
 docs_dir: docs/book
 site_dir: docs/html
 nav:
-    - Home: index.md
-    - "Quick Start": quick-start.md
-    - "Rendering Views":
-        - "The PhpRenderer": php-renderer.md
-        - "View Scripts": view-scripts.md
-        - "The ViewEvent": view-event.md
-    - Helpers:
-        - Introduction: helpers/intro.md
-        - Asset: helpers/asset.md
-        - BasePath: helpers/base-path.md
-        - Cycle: helpers/cycle.md
-        - Doctype: helpers/doctype.md
-        - Escape: helpers/escape.md
-        - FlashMessenger: helpers/flash-messenger.md
-        - Gravatar: helpers/gravatar.md
-        - HeadLink: helpers/head-link.md
-        - HeadMeta: helpers/head-meta.md
-        - HeadScript: helpers/head-script.md
-        - HeadStyle: helpers/head-style.md
-        - HeadTitle: helpers/head-title.md
-        - HtmlAttributes: helpers/html-attributes.md
-        - HtmlList: helpers/html-list.md
-        - HtmlObject: helpers/html-object.md
-        - HtmlTag: helpers/html-tag.md
-        - Identity: helpers/identity.md
-        - InlineScript: helpers/inline-script.md
-        - Json: helpers/json.md
-        - Layout: helpers/layout.md
-        - Partial: helpers/partial.md
-        - Placeholder: helpers/placeholder.md
-        - Url: helpers/url.md
-        - "Advanced usage of helpers": helpers/advanced-usage.md
-    - 'Application Integration':
-        - 'Stand-Alone': application-integration/stand-alone.md
-    - Cookbook:
-        - "Setting module-specific Layouts": cookbook/setting-module-specific-layouts.md
+  - Home: index.md
+  - v2:
+      - "Quick Start": v2/quick-start.md
+      - "Rendering Views":
+          - "The PhpRenderer": v2/php-renderer.md
+          - "View Scripts": v2/view-scripts.md
+          - "The ViewEvent": v2/view-event.md
+      - Helpers:
+          - Introduction: v2/helpers/intro.md
+          - Asset: v2/helpers/asset.md
+          - BasePath: v2/helpers/base-path.md
+          - Cycle: v2/helpers/cycle.md
+          - Doctype: v2/helpers/doctype.md
+          - Escape: v2/helpers/escape.md
+          - FlashMessenger: v2/helpers/flash-messenger.md
+          - Gravatar: v2/helpers/gravatar.md
+          - HeadLink: v2/helpers/head-link.md
+          - HeadMeta: v2/helpers/head-meta.md
+          - HeadScript: v2/helpers/head-script.md
+          - HeadStyle: v2/helpers/head-style.md
+          - HeadTitle: v2/helpers/head-title.md
+          - HtmlAttributes: v2/helpers/html-attributes.md
+          - HtmlList: v2/helpers/html-list.md
+          - HtmlObject: v2/helpers/html-object.md
+          - HtmlTag: v2/helpers/html-tag.md
+          - Identity: v2/helpers/identity.md
+          - InlineScript: v2/helpers/inline-script.md
+          - Json: v2/helpers/json.md
+          - Layout: v2/helpers/layout.md
+          - Partial: v2/helpers/partial.md
+          - Placeholder: v2/helpers/placeholder.md
+          - Url: v2/helpers/url.md
+          - "Advanced usage of helpers": v2/helpers/advanced-usage.md
+      - 'Application Integration':
+          - 'Stand-Alone': v2/application-integration/stand-alone.md
+      - Cookbook:
+          - "Setting module-specific Layouts": v2/cookbook/setting-module-specific-layouts.md
 site_name: laminas-view
 site_description: 'Flexible view layer supporting and providing multiple view layers, helpers, and more.'
 repo_url: 'https://github.com/laminas/laminas-view'
 extra:
-    project: Components
+  project: Components
+  current_version: v2
+  versions:
+    - v2
+
+plugins:
+  - redirects:
+      redirect_maps:
+        quick-start.md: v2/quick-start.md
+        php-renderer.md: v2/php-renderer.md
+        view-scripts.md: v2/view-scripts.md
+        view-event.md: v2/view-event.md
+        helpers/intro.md: v2/helpers/intro.md
+        helpers/asset.md: v2/helpers/asset.md
+        helpers/base-path.md: v2/helpers/base-path.md
+        helpers/cycle.md: v2/helpers/cycle.md
+        helpers/doctype.md: v2/helpers/doctype.md
+        helpers/escape.md: v2/helpers/escape.md
+        helpers/flash-messenger.md: v2/helpers/flash-messenger.md
+        helpers/gravatar.md: v2/helpers/gravatar.md
+        helpers/head-link.md: v2/helpers/head-link.md
+        helpers/head-meta.md: v2/helpers/head-meta.md
+        helpers/head-script.md: v2/helpers/head-script.md
+        helpers/head-style.md: v2/helpers/head-style.md
+        helpers/head-title.md: v2/helpers/head-title.md
+        helpers/html-attributes.md: v2/helpers/html-attributes.md
+        helpers/html-list.md: v2/helpers/html-list.md
+        helpers/html-object.md: v2/helpers/html-object.md
+        helpers/html-tag.md: v2/helpers/html-tag.md
+        helpers/identity.md: v2/helpers/identity.md
+        helpers/inline-script.md: v2/helpers/inline-script.md
+        helpers/json.md: v2/helpers/json.md
+        helpers/layout.md: v2/helpers/layout.md
+        helpers/partial.md: v2/helpers/partial.md
+        helpers/placeholder.md: v2/helpers/placeholder.md
+        helpers/url.md: v2/helpers/url.md
+        helpers/advanced-usage.md: v2/helpers/advanced-usage.md
+        application-integration/stand-alone.md: v2/application-integration/stand-alone.md
+        cookbook/setting-module-specific-layouts.md: v2/cookbook/setting-module-specific-layouts.md