Skip to content

Commit

Permalink
Updates docs for Craft 5
Browse files Browse the repository at this point in the history
  • Loading branch information
BenParizek committed Jun 30, 2024
1 parent 9103e84 commit 84e52e3
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 42 deletions.
9 changes: 6 additions & 3 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ export default defineConfig({
{
text: "Documentation",
items: [
{text: 'Sprout v5 (Craft 5)', link: 'https://sprout.barrelstrengthdesign.com/docs/craft-v5/'},
{text: 'Sprout v4 (Craft 4)', link: '/'},
{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/'}
Expand All @@ -42,6 +43,7 @@ export default defineConfig({
{
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'},
]
Expand Down Expand Up @@ -141,6 +143,7 @@ export default defineConfig({
text: 'Plugins',
items: [
{text: 'Data Studio', link: '/update-guides/data-studio'},
{text: 'Forms', link: '/update-guides/forms'},
{text: 'Email', link: '/update-guides/email'},
{text: 'SEO', link: '/update-guides/seo'},
{text: 'Redirects', link: '/update-guides/redirects'},
Expand Down Expand Up @@ -257,14 +260,14 @@ export default defineConfig({
port: 5173, // Use port 3000 for dev server.
// port: 4173, // Use port 3000 for dev server.
strictPort: true, // Don't try next available port if 3000 isn't available.
origin: 'http://demo.projectmothership.com.ddev.site:5174', // Rewrite asset URLs explicitly since the CMS web server is on a different host.
// origin: 'http://demo.projectmothership.com.ddev.site:4173', // Rewrite asset URLs explicitly since the CMS web server is on a different host.
origin: 'http://5.projectmothership.com.ddev.site:5174', // Rewrite asset URLs explicitly since the CMS web server is on a different host.
// origin: 'http://5.projectmothership.com.ddev.site:4173', // Rewrite asset URLs explicitly since the CMS web server is on a different host.
hmr: {
port: 5173,
clientPort: 5174,
// port: 4173,
// clientPort: 4174,
host: 'demo.projectmothership.com.ddev.site',
host: '5.projectmothership.com.ddev.site',
protocol: 'wss',
},
}
Expand Down
18 changes: 1 addition & 17 deletions docs/features.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,22 +20,6 @@ _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.
:::

[//]: # (## Forms Module)

[//]: # ()

[//]: # (_Available in: Sprout Forms._)

[//]: # ()

[//]: # (<EditionComparison feature-list="./editions/forms.json" />)

[//]: # ()

## Transactional Email Module

_Available in: Sprout Notifications, Sprout Forms._
Expand Down Expand Up @@ -72,4 +56,4 @@ _Available in: Sprout Redirects, Sprout SEO._

_Available in: Sprout Sitemaps, Sprout SEO._

<EditionComparison feature-list="./editions/sitemaps.json" />
<EditionComparison feature-list="./editions/sitemaps.json" />
4 changes: 0 additions & 4 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,6 @@ 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.
:::

## Digital Marketing

Sprout adds new components to use in your content architecture including Forms, Emails, and Reports.
Expand Down
15 changes: 3 additions & 12 deletions docs/update-guides/forms.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,10 @@ date: 2023-09-25
description: Sprout Forms update guide.
---

# Upgrading to Forms v4.44.444
# Upgrading from Craft 3

Sprout Reports is now Sprout Data Studio and now includes integrated Commerce Data Sets and Date Range Helper classes. Data Sets now support a custom field layout and element sources can be customized based on a Data Source condition rule or any custom fields in your field layout.
Sprout Forms is available on Craft 3 and Craft 5 but was never released on Craft 4.

## Breaking Changes
When upgrading other plugins and Craft to their respective Craft 4 releases on the path to Craft 5, leave Sprout Forms in the database and once the codebase is upgraded to Craft 5 the appropriate migrations will be applied. See the upgrade notes in the Sprout 5 docs for more information on upgrading from Craft 3 to Craft 5.

### Source Groups have been removed in favor of Custom Sources

To implement custom sources for your Forms you must be an Admin:

1. Add a custom Dropdown or Relation field to your Form Type field layout `Settings->Data Studio->Field Layout`
2. Edit any Forms you want to group and select the appropriate value in your new field
3. On the Forms Element Index page, select the gear icon and choose "Customize Sources"
4. From the "Customize Sources" modal, select the `+` icon and choose "New custom source"
5. Give your custom source a Label and select your Custom Field and Form Criteria to create a Condition Rule
6. Repeat step 5 for each custom source you want to add
7 changes: 1 addition & 6 deletions docs/update-guides/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,12 @@ The Sprout plugins are built using the Sprout Framework – a collection of modu

The upgrade guides are organized by plugin and releases are listed by date. Where appropriate, a plugin might link to update notes in another plugin. For example, the Sprout Forms changelog might link to the Sprout Email changelog for a particular update if notable changes have been made to email-specific features.

::: warning Migrations and Craft Commands
Sprout plugins for Craft 4 currently require that you update via the browser to trigger migrations. Running `./craft migrate/all` will not trigger the Sprout module migrations.

Each Sprout module has its own migration track and a single migration might get triggered by one or more modules. Sprout plugins manage the order that migrations need to run and ensure that migrations only run once, but, currently, Craft's CLI commands for migrations do not consider the scenario where a plugin runs migrations that are not using the plugin migration track. We're working on finding a Craft-friendly way to handle this scenario, but for now, to ensure all Sprout migrations run correctly you'll need to run migrations via the Update button in the browser.
:::

## Update Guides

The update guides are primarily for notable changes. Not all plugin versions will appear here in the update guides. See the changelogs for a given plugin for more detailed notes on every release.

- [Sprout Data Studio](./data-studio.md)
- [Sprout Forms](./forms.md)
- [Sprout Email](./email.md)
- [Sprout Redirects](./redirects.md)
- [Sprout Seo](./seo.md)
Expand Down

0 comments on commit 84e52e3

Please sign in to comment.