Improves docs

Signed-off-by: Ben Parizek <bparizek@uschamber.com>
barrelstrength · Sep 25, 2023 · 0a7ef9d · 0a7ef9d
1 parent 4132ea1
commit 0a7ef9d
Show file tree

Hide file tree

Showing 17 changed files with 85 additions and 20 deletions.
diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
@@ -318,6 +318,7 @@ module.exports = {
                         'data-studio',
                         'email',
                         'redirects',
+                        'sitemaps',
                     ],
                 },
                 {

diff --git a/docs/audiences/README.md b/docs/audiences/README.md
@@ -140,5 +140,5 @@ Read the [Config Settings](./../configuration/sprout-config.md) documentation to
 
 ## Updates
 
-See [update guides](../configuration/updates.md) for the Mailer and Framework modules.
+See [update guides](../update-guides/README.md) for the Mailer and Framework modules.
 
diff --git a/docs/data-studio/README.md b/docs/data-studio/README.md
@@ -33,4 +33,4 @@ Read the [Config Settings](./../configuration/sprout-config.md) documentation to
 
 ## Updates
 
-See [update guides](../configuration/updates.md) for the Data Studio and Framework modules.
+See [update guides](../update-guides/README.md) for the Data Studio and Framework modules.
diff --git a/docs/email-types/README.md b/docs/email-types/README.md
@@ -56,4 +56,4 @@ Read the [Config Settings](./../configuration/sprout-config.md) documentation to
 
 ## Updates
 
-See [update guides](../configuration/updates.md) for the Mailer and Framework modules.
+See [update guides](../update-guides/README.md) for the Mailer and Framework modules.
diff --git a/docs/mailers/README.md b/docs/mailers/README.md
@@ -29,4 +29,4 @@ Read the [Config Settings](./../configuration/sprout-config.md) documentation to
 
 ## Updates
 
-See [update guides](../configuration/updates.md) for the Mailer and Framework modules.
+See [update guides](../update-guides/README.md) for the Mailer and Framework modules.
diff --git a/docs/redirects/README.md b/docs/redirects/README.md
@@ -85,4 +85,4 @@ Read the [Config Settings](./../configuration/sprout-config.md) documentation to
 
 ## Updates
 
-See [update guides](../configuration/updates.md) for the Redirects and Framework modules.
+See [update guides](../update-guides/README.md) for the Redirects and Framework modules.
diff --git a/docs/sent-email/README.md b/docs/sent-email/README.md
@@ -21,5 +21,5 @@ Read the [Config Settings](./../configuration/sprout-config.md) documentation to
 
 ## Updates
 
-See [update guides](../configuration/updates.md) for the Sent Email and Framework modules.
+See [update guides](../update-guides/README.md) for the Sent Email and Framework modules.
 
diff --git a/docs/sitemaps/README.md b/docs/sitemaps/README.md
@@ -148,4 +148,4 @@ Read the [Config Settings](./../configuration/sprout-config.md) documentation to
 
 ## Updates
 
-See [update guides](../configuration/updates.md) for the Redirects and Framework modules.
+See [update guides](../update-guides/README.md) for the Redirects and Framework modules.
diff --git a/docs/support/support.md b/docs/support/support.md
@@ -9,7 +9,7 @@ Sprout provides dedicated support for license holders and [free training](./trai
 
 ## Bugs & Feature Requests
 
-Running into an issue while upgrading? Read the [Update Guides](../configuration/updates.md) for more information on the latest updates and releases.
+Running into an issue while upgrading? Read the [Update Guides](../update-guides/README.md) for more information on the latest updates and releases.
 
 | Plugin            | Bugs                                       | Feature Requests     | Uncategorized    |
 |:----------------- |:-------------------                        |:-------------------- |:------------------- |

diff --git a/docs/transactional-email/README.md b/docs/transactional-email/README.md
@@ -162,4 +162,4 @@ Read the [Config Settings](./../configuration/sprout-config.md) documentation to
 
 ## Updates
 
-See [update guides](../configuration/updates.md) for the Transactional, Mailer, and Framework modules.
+See [update guides](../update-guides/README.md) for the Transactional, Mailer, and Framework modules.
diff --git a/docs/update-guides/README.md b/docs/update-guides/README.md
@@ -1,6 +1,6 @@
 ---
 date: 2023-09-10
-description: The Changelog reflects the most recent updates to a plugin and can be found at the top level in the Github repo for each plugin.
+description: Update guides for Sprout plugins.
 ---
 
 # Updating Sprout
@@ -16,3 +16,4 @@ The update guides are primarily for notable changes. Not all plugin versions wil
 - [Sprout Data Studio](./data-studio.md)
 - [Sprout Email](./email.md)
 - [Sprout Redirects](./redirects.md)
+- [Sprout Sitemaps](./sitemaps.md)
diff --git a/docs/update-guides/data-studio.md b/docs/update-guides/data-studio.md
@@ -1,6 +1,6 @@
 ---
-date: 2023-02-19
-description: Create the new notification and add the appropriate sender info. The notification Rules will be setup to trigger "When a new user is created".
+date: 2023-09-25
+description: Sprout Data Studio update guide.
 ---
 
 # Data Studio

diff --git a/docs/update-guides/email.md b/docs/update-guides/email.md
@@ -1,6 +1,6 @@
 ---
-date: 2023-02-19
-description: To use globals in Sprout Email you will need to use the craft.globals.getSetByHandle tag.
+date: 2023-09-25
+description: Sprout Email update guide.
 ---
 
 # Email

diff --git a/docs/update-guides/forms.md b/docs/update-guides/forms.md
@@ -1,6 +1,6 @@
 ---
-date: 2023-09-02
-description: Upgrade Sprout Forms module 4.44.444
+date: 2023-09-25
+description: Sprout Forms update guide.
 ---
 
 # Upgrading to Forms v4.44.444

diff --git a/docs/update-guides/redirects.md b/docs/update-guides/redirects.md
@@ -1,6 +1,6 @@
 ---
-date: 2023-02-19
-description: Create the new notification and add the appropriate sender info. The notification Rules will be setup to trigger "When a new user is created".
+date: 2023-09-25
+description: Sprout Redirects update guide.
 ---
 
 # Redirects

diff --git a/docs/update-guides/sitemaps.md b/docs/update-guides/sitemaps.md
@@ -0,0 +1,63 @@
+---
+date: 2023-09-25
+description: Sprout Sitemaps update guide.
+---
+
+# Sitemaps
+
+## v4.44.444 - September 25, 2023
+
+This release adds Craft 4 support and a few new features such as Content Query Sitemaps and improved navigation.
+
+Sitemaps now has a Lite and Pro version. Existing users have been given a new license key for Sitemaps Pro.
+
+### License Migrations
+
+Existing Sprout Sitemaps license holders have received a new Sprout Sitemaps Pro license in the same Craft Console account for the old Sprout Sitemaps license key. Once upgraded to Craft 4, you will need to manually add your new licenses key to your Craft installation. Your new Sitemaps license will have the same expiration as the old license and you will need to manually re-select the auto-renew option in your Craft Console.
+
+### Breaking Changes
+
+- See the general [upgrade guide][#400-framework] for Sprout Modules to 4.0
+- Lite Edition allows managing up to 5 Content and Content Query Sitemaps per Site
+- Custom Sitemap Metadata integration has been updated from `barrelstrength\sproutbaseuris\services\UrlEnabledSections::EVENT_REGISTER_URL_ENABLED_SECTION_TYPES` => `BarrelStrength\Sprout\sitemaps\sitemapmetadata\SitemapMetadata::EVENT_REGISTER_ELEMENT_SITEMAP_METADATA`
+
+### Notable Changes
+
+#### Generated URLs for individual sitemaps have changed
+
+Your `/sitemap.xml` Sitemap index exists at the same URL, however, the URLs listed in the Sitemap Index have changed.
+
+In Craft 3, Content Sitemaps displayed with a 12 character key:
+
+``` xml
+<?xml version="1.0" encoding="UTF-8"?>
+<sitemapindex xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+    <sitemap>
+        <loc>{{ siteUrl }}sitemap-G76D5Oizt4fH-1.xml</loc>
+        <lastmod>{{ now|date('Y-m-d') }}</lastmod>
+    </sitemap>
+    <sitemap>
+        <loc>{{ siteUrl }}sitemap-9O2U0q1gdvPM-1.xml</loc>
+        <lastmod>{{ now|date('Y-m-d') }}</lastmod>
+    </sitemap>
+</sitemapindex>
+```
+
+In Craft 4, Content Sitemaps display using the Sitemap Metadata UID key:
+
+``` xml
+<?xml version="1.0" encoding="UTF-8"?>
+<sitemapindex xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+    <sitemap>
+        <loc>{{ siteUrl }}sitemap-0a0c9e98-fe8b-430a-9b47-f3e521dd048e-1.xml</loc>
+        <lastmod>{{ now|date('Y-m-d') }}</lastmod>
+    </sitemap>
+    <sitemap>
+        <loc>{{ siteUrl }}sitemap-0a0c9e98-fe8b-430a-9b47-f3e521dd048e-2.xml</loc>
+        <lastmod>{{ now|date('Y-m-d') }}</lastmod>
+    </sitemap>
+</sitemapindex>
+```
+
+[#400-framework]: ../update-guides/sprout.md
+
diff --git a/docs/update-guides/sprout.md b/docs/update-guides/sprout.md
@@ -1,6 +1,6 @@
 ---
-date: 2023-02-19
-description: Create the new notification and add the appropriate sender info. The notification Rules will be setup to trigger "When a new user is created".
+date: 2023-09-25
+description: Update guide for Sprout Framework.
 ---
 
 # Craft 4