Craft 5 updates

barrelstrength · Jun 30, 2024 · e46cfa1 · e46cfa1
1 parent 9103e84
commit e46cfa1
Show file tree

Hide file tree

Showing 8 changed files with 743 additions and 1,612 deletions.
diff --git a/docs/.drafts/index-landing.md b/docs/.drafts/index-landing.md
@@ -10,7 +10,7 @@ hero:
     src: /logo-silhouette.svg
   actions:
     - theme: brand
-      text: Sprout for Craft 4
+      text: Sprout for Craft 5
       link: /markdown-examples
     - theme: alt
       text: Plugin store

diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts
@@ -6,15 +6,15 @@ export default defineConfig({
     titleTemplate: ':title - Sprout Plugins – Craft CMS',
     description: "Build custom Craft CMS websites with Sprout Marketing Suite",
     head: [
-        ['link', {rel: 'icon', href: '/docs/craft-v4/icons/favicon.ico'}],
-        ['link', {rel: 'icon', href: '/docs/craft-v4/icons/favicon-16x16.png'}],
-        ['link', {rel: 'apple-touch-icon', sizes: '180x180', href: '/docs/craft-v4/icons/apple-touch-icon.png'}],
-        ['link', {rel: 'icon', type: 'image/png', sizes: '32x32', href: '/docs/craft-v4/icons/favicon-32x32.png'}],
-        ['link', {rel: 'icon', type: 'image/png', sizes: '16x16', href: '/docs/craft-v4/icons/favicon-16x16.png'}],
+        ['link', {rel: 'icon', href: '/docs/craft-v5/icons/favicon.ico'}],
+        ['link', {rel: 'icon', href: '/docs/craft-v5/icons/favicon-16x16.png'}],
+        ['link', {rel: 'apple-touch-icon', sizes: '180x180', href: '/docs/craft-v5/icons/apple-touch-icon.png'}],
+        ['link', {rel: 'icon', type: 'image/png', sizes: '32x32', href: '/docs/craft-v5/icons/favicon-32x32.png'}],
+        ['link', {rel: 'icon', type: 'image/png', sizes: '16x16', href: '/docs/craft-v5/icons/favicon-16x16.png'}],
     ],
-    base: '/docs/craft-v4/',
+    base: '/docs/craft-v5/',
     sitemap: {
-        hostname: 'https://sprout.barrelstrengthdesign.com/docs/craft-v4/'
+        hostname: 'https://sprout.barrelstrengthdesign.com/docs/craft-v5/'
     },
     lastUpdated: true,
     srcExclude: [
@@ -29,19 +29,21 @@ export default defineConfig({
         nav: [
             {text: 'Support', link: '/support/support', activeMatch: '/support/'},
             {
-                text: 'Sprout v4',
+                text: 'Sprout v5',
                 items: [
                     {
                         text: "Documentation",
                         items: [
-                            {text: 'Sprout v4 (Craft 4)', link: '/'},
+                            {text: 'Sprout v5 (Craft 5)', link: '/'},
+                            {text: 'Sprout v4 (Craft 4)', link: 'https://sprout.barrelstrengthdesign.com/docs/craft-v4/'},
                             {text: 'Sprout v3 (Craft 3)', link: 'https://sprout.barrelstrengthdesign.com/docs/craft-v3/'},
                             {text: 'Sprout v2 (Craft 2)', link: 'https://sprout.barrelstrengthdesign.com/docs/craft-v2/'}
                         ]
                     },
                     {
                         text: "Plugin Store",
                         items: [
+                            {text: 'Craft 5', link: 'https://plugins.craftcms.com/developer/barrel-strength-design?craft5'},
                             {text: 'Craft 4', link: 'https://plugins.craftcms.com/developer/barrel-strength-design?craft4'},
                             {text: 'Craft 3', link: 'https://plugins.craftcms.com/developer/barrel-strength-design?craft3'},
                         ]
@@ -77,28 +79,28 @@ export default defineConfig({
                         {text: 'FAQ & Examples', link: '/examples-data-studio/custom-twig-template-report'},
                     ]
                 },
-                {
-                    text: 'Email Marketing',
-                    collapsed: false,
-                    items: [
-                        {text: 'Transactional Email', link: '/transactional-email'},
-                        {text: 'Email Types', link: '/email-types'},
-                        {text: 'Mailer Settings', link: '/mailers'},
-                        {text: 'Audiences', link: '/audiences'},
-                        {text: 'Sent Email', link: '/sent-email'},
-                        {text: 'FAQ & Examples', link: '/examples-email/faq'},
-                    ]
-                },
-                {
-                    text: 'SEO Metadata',
-                    collapsed: false,
-                    items: [
-                        {text: 'Meta Tags & Schema', link: '/meta'},
-                        {text: 'Redirects', link: '/redirects'},
-                        {text: 'Sitemaps', link: '/sitemaps'},
-                        {text: 'FAQ & Examples', link: '/examples-seo/faq'},
-                    ]
-                },
+                // {
+                //     text: 'Email Marketing',
+                //     collapsed: false,
+                //     items: [
+                //         {text: 'Transactional Email', link: '/transactional-email'},
+                //         {text: 'Email Types', link: '/email-types'},
+                //         {text: 'Mailer Settings', link: '/mailers'},
+                //         {text: 'Audiences', link: '/audiences'},
+                //         {text: 'Sent Email', link: '/sent-email'},
+                //         {text: 'FAQ & Examples', link: '/examples-email/faq'},
+                //     ]
+                // },
+                // {
+                //     text: 'SEO Metadata',
+                //     collapsed: false,
+                //     items: [
+                //         {text: 'Meta Tags & Schema', link: '/meta'},
+                //         {text: 'Redirects', link: '/redirects'},
+                //         {text: 'Sitemaps', link: '/sitemaps'},
+                //         {text: 'FAQ & Examples', link: '/examples-seo/faq'},
+                //     ]
+                // },
             ],
 
             '/support/': [
@@ -141,16 +143,16 @@ export default defineConfig({
                     text: 'Plugins',
                     items: [
                         {text: 'Data Studio', link: '/update-guides/data-studio'},
-                        {text: 'Email', link: '/update-guides/email'},
-                        {text: 'SEO', link: '/update-guides/seo'},
+                        // {text: 'Email', link: '/update-guides/email'},
+                        // {text: 'SEO', link: '/update-guides/seo'},
                         {text: 'Redirects', link: '/update-guides/redirects'},
                         {text: 'Sitemaps', link: '/update-guides/sitemaps'},
                     ]
                 },
                 {
                     text: 'All Plugins',
                     items: [
-                        {text: 'Craft 4', link: '/update-guides/sprout'},
+                        {text: 'Craft 5', link: '/update-guides/sprout'},
                     ]
                 }
             ],
@@ -227,8 +229,8 @@ export default defineConfig({
         ],
 
         editLink: {
-            // https://github.com/barrelstrength/sprout-docs/blob/craft-v4/docs/support/support.md
-            pattern: 'https://github.com/barrelstrength/sprout-docs/edit/craft-v4/docs/:path'
+            // https://github.com/barrelstrength/sprout-docs/blob/craft-v5/docs/support/support.md
+            pattern: 'https://github.com/barrelstrength/sprout-docs/edit/craft-v5/docs/:path'
         },
 
         search: {

diff --git a/docs/configuration/requirements.md b/docs/configuration/requirements.md
@@ -5,12 +5,8 @@ description: Requirements for using the Sprout Plugins.
 
 # Requirements
 
-- Craft CMS `4.0.0` and all [requirements for running Craft 4](https://craftcms.com/docs/4.x/requirements.html)
-- Sprout Framework `4.0.0` (included with all Sprout plugins)
-
-::: info 4.44.444... Why so many 4s?
-To align Sprout plugins with Craft major releases, all Sprout Marketing Suite plugins added Craft 4 support at version `4.44.444` and will add Craft 5 support using version `5.0.0`.
-:::
+- Craft CMS `5.3.0` and all [requirements for running Craft 5](https://craftcms.com/docs/5.x/requirements.html)
+- Sprout Framework `5.0.0` (included with all Sprout plugins)
 
 ## Installation via Plugin Store
 
@@ -28,13 +24,13 @@ cd /path/to/project
 2. Run Composer to retrieve the plugin
 
 ```
-composer require barrelstrength/sprout-forms
+composer require barrelstrength/sprout-data-studio
 ```
 
 3. In the Control Panel, go to _Settings → Plugins_ and select “Install”
 
-## Upgrading to Craft 4
+## Upgrading to Craft 5
 
 ::: danger BEFORE YOU UPDATE!
-Make sure you have updated to the latest version of all Sprout Plugins on Craft 3.x before updating your plugins to Craft 4.x. View the [Update Guides](/update-guides/index.md) for more details.
+Make sure you have updated to the latest version of all Sprout Plugins on Craft 4.x before updating your plugins to Craft 5.x. View the [Update Guides](/update-guides/index.md) for more details.
 :::
diff --git a/docs/data-studio.md b/docs/data-studio.md
@@ -29,7 +29,7 @@ Sprout Data Studio provides a few Data Sources out of the box:
 
 ## Data Sets
 
-Data Sets allow you to create queries into the data defined by a Data Source. You can create one or more Data Sets from a single Data Source and each Data Set can [define unique query settings](https://demo.projectmothership.com/docs/craft-v4/data-studio.html).
+Data Sets allow you to create queries into the data defined by a Data Source. You can create one or more Data Sets from a single Data Source and each Data Set can define unique query settings.
 
 Data Sets can be organized into groups and customized so that you can conveniently interact with data set results in the Control Panel or export it as you need.
 

diff --git a/docs/features.md b/docs/features.md
@@ -20,8 +20,8 @@ _Available in: Sprout Data Studio, Sprout Forms._
 
 <EditionComparison feature-list="./editions/data-studio.json" />
 
-::: tip Craft 4 Support
-Sprout Marketing Suite plugins are coming to Craft 4. See our [Road Map](./support/road-map.md) for more details.
+::: tip Craft 5 Support
+Sprout Marketing Suite plugins are coming to Craft 5. See our [Road Map](./support/road-map.md) for more details.
 :::
 
 [//]: # (## Forms Module)
@@ -36,31 +36,41 @@ Sprout Marketing Suite plugins are coming to Craft 4. See our [Road Map](./suppo
 
 [//]: # ()
 
-## Transactional Email Module
+[//]: # (## Transactional Email Module)
 
-_Available in: Sprout Notifications, Sprout Forms._
+[//]: # ()
+[//]: # (_Available in: Sprout Notifications, Sprout Forms._)
 
-<EditionComparison feature-list="./editions/notifications.json" />
+[//]: # ()
+[//]: # (<EditionComparison feature-list="./editions/notifications.json" />)
 
-## Mailer Module
+[//]: # ()
+[//]: # (## Mailer Module)
 
-_Available in: Sprout Forms, Sprout Email, Sprout Sent Email._
+[//]: # ()
+[//]: # (_Available in: Sprout Forms, Sprout Email, Sprout Sent Email._)
 
-<EditionComparison feature-list="./editions/mailer.json" />
+[//]: # ()
+[//]: # (<EditionComparison feature-list="./editions/mailer.json" />)
 
-## Sent Email
+[//]: # ()
+[//]: # (## Sent Email)
 
-_Available in: Sprout Email, Sprout Sent Email._
+[//]: # ()
+[//]: # (_Available in: Sprout Email, Sprout Sent Email._)
 
-<EditionComparison feature-list="./editions/sent-email.json" />
+[//]: # ()
+[//]: # (<EditionComparison feature-list="./editions/sent-email.json" />)
 
 [//]: # ()
 
-## Meta Module
+[//]: # (## Meta Module)
 
-_Available in: Sprout SEO._
+[//]: # ()
+[//]: # (_Available in: Sprout SEO._)
 
-<EditionComparison feature-list="./editions/seo.json" />
+[//]: # ()
+[//]: # (<EditionComparison feature-list="./editions/seo.json" />)
 
 ## Redirects Module
 

diff --git a/docs/index.md b/docs/index.md
@@ -11,8 +11,8 @@ Sprout provides a seamless Craft experience for content authors and an exception
 
 [//]: # (Sprout Plugins provide a seamless Craft experience for content authors, an exceptional amount of flexibility for designers and developers, and comprehensive multi-site support for multi-regional and multi-lingual websites.)
 
-::: tip Craft 4 Support
-Sprout Marketing Suite plugins are coming to Craft 4. See our [Road Map](./support/road-map.md) for more details.
+::: tip Craft 5 Support
+Sprout Marketing Suite plugins are coming to Craft 5. See our [Road Map](./support/road-map.md) for more details.
 :::
 
 ## Digital Marketing