Merge pull request #30 from RobErskine/craft4

Craft 4

.craftplugin

@@ -1 +1 @@
-{"pluginName":"usermanual","pluginDescription":"Craft User Manual allows developers (or even content editors) to provide CMS documentation using Craft's built-in sections (singles, channels, or structures) to create a 'User Manual' or 'Help' section directly in the control panel.","pluginVersion":"2.0.0","pluginAuthorName":"Rob Erskine","pluginVendorName":"hillholliday","pluginAuthorUrl":"https://twitter.com/erskinerob","pluginAuthorGithub":"hillholliday","codeComments":"","pluginComponents":["settings","twigextensions","variables"],"consolecommandName":"","controllerName":"","cpsectionName":"","elementName":"","fieldName":"","modelName":"","purchasableName":"","recordName":"","serviceName":"","taskName":"","utilityName":"","widgetName":"","apiVersion":"api_version_3_0"}
+{"pluginName":"usermanual","pluginDescription":"Craft User Manual allows developers (or even content editors) to provide CMS documentation using Craft's built-in sections (singles, channels, or structures) to create a 'User Manual' or 'Help' section directly in the control panel.","pluginVersion":"4.0.0","pluginAuthorName":"Rob Erskine","pluginVendorName":"roberskine","pluginAuthorUrl":"https://twitter.com/erskinerob","pluginAuthorGithub":"roberskine","codeComments":"","pluginComponents":["settings","twigextensions","variables"],"consolecommandName":"","controllerName":"","cpsectionName":"","elementName":"","fieldName":"","modelName":"","purchasableName":"","recordName":"","serviceName":"","taskName":"","utilityName":"","widgetName":"","apiVersion":"api_version_4_0"}

CHANGELOG.md

@@ -1,13 +1,17 @@
 # Release Notes for Craft User Manual
 
+## 4.0.0 - 2022-06-20
+- Craft 4 support. Thanks to Chris DuCharme for migrating. [PR #29](https://github.com/roberskine/Craft-User-Manual/pull/29)
+
 ## 2.1.2 - 2022-01-15
 - Forcing an update for the plugin store
+
 ## 2.1.1 - 2021-11-24
-- Removing fixed positioning from #content within the user manual [PR #24](https://github.com/hillholliday/Craft-User-Manual/pull/24)
+- Removing fixed positioning from #content within the user manual [PR #24](https://github.com/roberskine/Craft-User-Manual/pull/24)
 
 ## 2.1.0 - 2021-11-10
-- Merging PR from JorgeAnzalo for an optional sidebar [PR #23](https://github.com/hillholliday/Craft-User-Manual/pull/23)
-- Merging PR from for a hashed based navigation for long navbars [PR #19](https://github.com/hillholliday/Craft-User-Manual/pull/19)
+- Merging PR from JorgeAnzalo for an optional sidebar [PR #23](https://github.com/roberskine/Craft-User-Manual/pull/23)
+- Merging PR from for a hashed based navigation for long navbars [PR #19](https://github.com/roberskine/Craft-User-Manual/pull/19)
 
 ## v2.0.2 - 2019-02-27
 ### Updated

README.md

@@ -1,24 +1,25 @@
-# Craft User Manual plugin for Craft CMS 3.x
+# Craft User Manual plugin for Craft CMS 4.x
 
 Craft User Manual allows developers (or even content editors) to provide CMS documentation using Craft's built-in sections (singles, channels, or structures) to create a "User Manual" or "Help" section directly in the control panel.
 
 ![Screenshot](resources/img/screenshot.jpg)
 
 ## Requirements
 
-This plugin requires Craft CMS 3.0.0-beta.23 or later.
+This plugin requires Craft CMS 4.0.0 or later.
 
 ## Installation
 
-To install the plugin, follow these instructions.
+### Craft 4
+To install the plugin in your Craft 4 project, follow these instructions.
 
 1. Open your terminal and go to your Craft project:
 
         cd /path/to/project
 
 2. Then tell Composer to load the plugin:
 
-        composer require hillholliday/craft-user-manual
+        composer require roberskine/craft-user-manual
 
 3. In the Control Panel, go to Settings → Plugins and click the “Install” button for usermanual.
 
@@ -28,9 +29,27 @@ To install the plugin, follow these instructions.
 
 5. Click the **User Manual** link in the CP nav.
 
+### Craft 3
+To install the plugin in your Craft 3 project, follow these instructions.
+
+1. Open your terminal and go to your Craft project:
+
+        cd /path/to/project
+
+2. Then tell Composer to load the plugin:
+
+        composer require roberskine/craft-user-manual:2.1.2
+
+3. In the Control Panel, go to Settings → Plugins and click the “Install” button for usermanual.
+
+4. Select the section the plugin should use as the **User Manual** page in the CP.
+    * (Optional) - Replace the plugin's name to something your user's will understand.
+    * (Optional) - Use more than the default `body` fieldhandle by setting up custom template overrides.
+
+5. Click the **User Manual** link in the CP nav.
 ## Configuration
 
-* All settings may be optionally configured using a [config file](http://buildwithcraft.com/docs/plugins/plugin-settings#config-file). The values, contained in [`config.php`](https://github.com/hillholliday/Craft-User-Manual/blob/master/src/config.php), are described below:
+* All settings may be optionally configured using a [config file](http://buildwithcraft.com/docs/plugins/plugin-settings#config-file). The values, contained in [`config.php`](https://github.com/roberskine/Craft-User-Manual/blob/master/src/config.php), are described below:
 
 <a id="config-settings-pluginNameOverride"></a>
 ### pluginNameOverride
@@ -61,13 +80,14 @@ Defaults to true.
 This plugin was inspired by the team over at [70kft](http://70kft.com/) for their work on [Craft-Help](https://github.com/70kft/craft-help). While their plugin is definitely more flexible in terms of writing custom markdown in separate files, we wanted to create something that would make it easier for anyone to edit documentation without making any changes to the server. This works particularly well for larger projects where more than one person (especially non-devs) are writing documentation for how to use the CMS.
 
 ## Releases
+* **4.0.0** - Craft 4 support! Thanks to [Chris DuCharme](https://github.com/Chris-DuCharme) for migrating up to Craft 4.
 * **2.1.0** - Merging PRs from [JorgeAnzola](https://github.com/JorgeAnzola) and [sameerast](https://github.com/sameerast)
 * **2.0.3** - Forcing updating to plugin store
-* **2.0.2** - Merging in [@aaronbushnell](https://github.com/aaronbushnell)'s [fix for incorrect reference to asset bundle](https://github.com/hillholliday/Craft-User-Manual/pull/17).
-* **2.0.1** - Merging in [@mgburns](https://github.com/mgburns)' [fix for Craft 3 deprecation warnings](https://github.com/hillholliday/Craft-User-Manual/pull/11).
-* **2.0.0** - Merging in [@jcdarwin](https://github.com/jcdarwin) Craft 3 port. [Craft 3 version of Craft User Manual](https://github.com/hillholliday/Craft-User-Manual/pull/8).
+* **2.0.2** - Merging in [@aaronbushnell](https://github.com/aaronbushnell)'s [fix for incorrect reference to asset bundle](https://github.com/roberskine/Craft-User-Manual/pull/17).
+* **2.0.1** - Merging in [@mgburns](https://github.com/mgburns)' [fix for Craft 3 deprecation warnings](https://github.com/roberskine/Craft-User-Manual/pull/11).
+* **2.0.0** - Merging in [@jcdarwin](https://github.com/jcdarwin) Craft 3 port. [Craft 3 version of Craft User Manual](https://github.com/roberskine/Craft-User-Manual/pull/8).
 * **1.1.1** - Adding in RTL language support.
-* **1.1.0** - Merging in [@timkelty](https://github.com/timkelty)'s work which [includes template overrides, updated error prompts, and other misc improvements](https://github.com/hillholliday/Craft-User-Manual/pull/3).
+* **1.1.0** - Merging in [@timkelty](https://github.com/timkelty)'s work which [includes template overrides, updated error prompts, and other misc improvements](https://github.com/roberskine/Craft-User-Manual/pull/3).
 * **1.0.1** - Adding support for plugin custom icons in Craft 2.5.
 * **1.0.0** - Initital release of Craft User Manual.
 

composer.json

@@ -2,7 +2,7 @@
     "name": "roberskine/craft-user-manual",
     "description": "Craft User Manual allows developers (or even content editors) to provide CMS documentation using Craft's built-in sections (singles, channels, or structures) to create a `User Manual` or `Help` section directly in the control panel.",
     "type": "craft-plugin",
-    "version": "2.1.2",
+    "version": "4.0.0",
     "keywords": [
         "craft",
         "cms",
@@ -22,11 +22,12 @@
         }
     ],
     "require": {
-        "craftcms/cms": "^3.0.0"
+        "php": "^8.0.2",
+        "craftcms/cms": "^4.0.0"
     },
     "autoload": {
         "psr-4": {
-            "hillholliday\\usermanual\\": "src/"
+            "roberskine\\usermanual\\": "src/"
         }
     },
     "extra": {
@@ -35,6 +36,17 @@
         "hasCpSettings": true,
         "hasCpSection": true,
         "changelogUrl": "https://raw.githubusercontent.com/roberskine/Craft-User-Manual/master/CHANGELOG.md",
-        "class": "hillholliday\\usermanual\\UserManual"
+        "class": "roberskine\\usermanual\\UserManual"
+    },
+    "minimum-stability": "dev",
+    "prefer-stable": true,
+    "require-dev": {
+        "craftcms/rector": "dev-main"
+    },
+    "config": {
+        "allow-plugins": {
+            "yiisoft/yii2-composer": true,
+            "craftcms/plugin-installer": true
+        }
     }
 }