Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

Updated Posts user documentation (#13339)

jaburghes98572ab7592c
diff --git a/docs/docs.json b/docs/docs.json
index 165d070b1a..99691a6fdd 100644
--- a/docs/docs.json
+++ b/docs/docs.json
@@ -1050,8 +1050,7 @@
"user/storefront/create-post",
"user/storefront/edit-post",
"user/storefront/search-posts",
- "user/storefront/delete-post",
- "user/storefront/import-posts"
+ "user/storefront/delete-post"
]
},
"user/storefront/storefront-settings",
diff --git a/docs/images/user/storefront/posts/create-post/1-posts-tab.png b/docs/images/user/storefront/posts/create-post/1-posts-tab.png
new file mode 100644
index 0000000000..4e4b3efc6f
Binary files /dev/null and b/docs/images/user/storefront/posts/create-post/1-posts-tab.png differ
diff --git a/docs/images/user/storefront/posts/create-post/2-post-creation-form.png b/docs/images/user/storefront/posts/create-post/2-post-creation-form.png
new file mode 100644
index 0000000000..1c85ffd9ba
Binary files /dev/null and b/docs/images/user/storefront/posts/create-post/2-post-creation-form.png differ
diff --git a/docs/images/user/storefront/posts/create-post/3-content-fields.png b/docs/images/user/storefront/posts/create-post/3-content-fields.png
new file mode 100644
index 0000000000..10fc6db164
Binary files /dev/null and b/docs/images/user/storefront/posts/create-post/3-content-fields.png differ
diff --git a/docs/images/user/storefront/posts/create-post/4-featured-image.png b/docs/images/user/storefront/posts/create-post/4-featured-image.png
new file mode 100644
index 0000000000..e483916bfb
Binary files /dev/null and b/docs/images/user/storefront/posts/create-post/4-featured-image.png differ
diff --git a/docs/images/user/storefront/posts/create-post/5-post-details.png b/docs/images/user/storefront/posts/create-post/5-post-details.png
new file mode 100644
index 0000000000..e5261dac1c
Binary files /dev/null and b/docs/images/user/storefront/posts/create-post/5-post-details.png differ
diff --git a/docs/images/user/storefront/posts/create-post/6-post-seo.png b/docs/images/user/storefront/posts/create-post/6-post-seo.png
new file mode 100644
index 0000000000..f45125a291
Binary files /dev/null and b/docs/images/user/storefront/posts/create-post/6-post-seo.png differ
diff --git a/docs/images/user/storefront/posts/delete-post/1-delete-post.png b/docs/images/user/storefront/posts/delete-post/1-delete-post.png
new file mode 100644
index 0000000000..aa1d8b82fe
Binary files /dev/null and b/docs/images/user/storefront/posts/delete-post/1-delete-post.png differ
diff --git a/docs/images/user/storefront/posts/delete-post/2-post-editor.png b/docs/images/user/storefront/posts/delete-post/2-post-editor.png
new file mode 100644
index 0000000000..7f8c720831
Binary files /dev/null and b/docs/images/user/storefront/posts/delete-post/2-post-editor.png differ
diff --git a/docs/images/user/storefront/posts/edit-post/1-edit-post.png b/docs/images/user/storefront/posts/edit-post/1-edit-post.png
new file mode 100644
index 0000000000..7bbab70a67
Binary files /dev/null and b/docs/images/user/storefront/posts/edit-post/1-edit-post.png differ
diff --git a/docs/images/user/storefront/posts/edit-post/2-post-editor.png b/docs/images/user/storefront/posts/edit-post/2-post-editor.png
new file mode 100644
index 0000000000..c0991888f9
Binary files /dev/null and b/docs/images/user/storefront/posts/edit-post/2-post-editor.png differ
diff --git a/docs/user/storefront/create-post.mdx b/docs/user/storefront/create-post.mdx
index 78f9c9472d..e05e6123d2 100644
--- a/docs/user/storefront/create-post.mdx
+++ b/docs/user/storefront/create-post.mdx
@@ -1,70 +1,67 @@
---
title: "Create a Blog Post"
-description: "Add a new blog post and manage your blog using Spree Commerce for improved SEO, product discovery and sales."
+description: "Learn how to create a blog post in Spree Commerce."
---
-Blog posts are a powerful tool in ecommerce, helping to drive traffic to your store through SEO while building trust and credibility with your audience. They allow you to showcase expertise, share product tips, and engage customers with content that keeps them coming back.
+Blog posts are a powerful tool in ecommerce. They help drive organic traffic to your store via SEO, build trust with customers, and provide opportunities to promote products or share helpful content like tutorials, stories, or news.
-To add a new post, navigate to the Posts sections of the admin dashboard found under Storefront.
+In Spree, adding blog posts is fast and intuitive - no developer required.
-![](https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1738166759/docs/Storefront/Create%20a%20Post/7.3.1.1_Create_a_Post_-_Navigate_To_Tab_ebd96e.png)
+## Add a New Post
-Locate the blue ‘New Post’ button in the top right corner and click on. This will open the post creation page.
+To create a blog post, navigate to **Storefront → Posts** in the Spree admin dashboard.
-![](https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1738166759/docs/Storefront/Create%20a%20Post/7.3.1.2_Create_a_Post_-_Add_New_Post_jmtxbm.png)
+![The Posts tab in the Spree Commerce dashboard](/docs/images/user/storefront/posts/create-post/1-posts-tab.png)
-This page is divided into four sections designed to help you create and publish your post.
+Click **New Post** in the top-right corner to open the post creation form.
-## Content
+![The Post creation form in the Spree Commerce dashboard](/docs/images/user/storefront/posts/create-post/2-post-creation-form.png)
-![](https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1738166759/docs/Storefront/Create%20a%20Post/7.3.1.3_Create_a_Post_-_Content_dpyuzv.png)
+Here you'll see several sections designed to help you create, structure, and publish your blog post.
-As the name suggests, this section is where you will insert the content of the post. There are three fields to fill in:
+## Post Content
-* Title link - the title of the blog post
+![Add content to blog post in Spree](/docs/images/user/storefront/posts/create-post/3-content-fields.png)
-* Content - the main body of the post, you can make use of the rich text editor to format your pos, insert images, and embed videos.
+This section includes the main content of your blog post.
-* Excerpt - a short summary of the post that will be displayed on your website
+- **Title** - The title of your blog post. This is shown on the storefront and used in the URL (slug).
+- **Content** - The body of the blog post. Use the rich text editor to format text, add images, and embed videos.
+- **Excerpt** - A short summary displayed on the storefront post preview and in meta tags if no meta description is set.
## Featured Image
-![](https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1738166759/docs/Storefront/Create%20a%20Post/7.3.1.4_Create_a_Post_-_Featured_Image_fqwf5y.png)
+![Adding an image to a blog post in Spree](/docs/images/user/storefront/posts/create-post/4-featured-image.png)
-This is where you can upload an image to accompany the post wherever it is displayed. We recommend using an image of size 1200x600.
+Upload an image that will be displayed alongside the blog post in listings and previews.
-## Post Details
-
-![](https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1738166759/docs/Storefront/Create%20a%20Post/7.3.1.5_Create_a_Post_-_Post_Details_e6jvsq.png)
+<Note>Recommended dimensions: 1200 × 600 pixels.</Note>
-The post details section contains four fields, two of which are required for the post to be published:
-
-* Author (required)  - the team member who wrote the post, by default the user who is creating the post will be selected
+## Post Details
-* Category - helps to organize the posts into broad topics or groups
+![Setting an author and publish date on a blog post](/docs/images/user/storefront/posts/create-post/5-post-details.png)
-* Published At (required) - the date the post should go live
+This section defines important metadata for the post:
-* Tags - provide more specific labels for your posts, allowing for finer sorting and search
+- **Author**- The admin user associated with the post. Defaults to the user creating the post.
+- **Category** - Helps organize posts into high-level topics (e.g., News, Guides, Recipes).
+- **Published At** - The date/time when the post should go live.
+- **Tags** - Add keywords for better search filtering and to categorize posts further.
-Important: If the Author and Publish At date are not set, the post will not appear on your live website.
+<Warning>If either **Author** or **Published At** is not set, the post will not appear on the storefront.</Warning>
## Search Engine Listing
-![](https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1738166759/docs/Storefront/Create%20a%20Post/7.3.1.6_Create_a_Post_-_Search_Engine_Listing_ftqwwo.png)
-
-Here you can edit the following fields:
-
-* Meta Title - if not set, the Title Link will be used
-
-* Meta Description - if not set, the Excerpt will be used
+![Configure blog post SEO in Spree Commerce](/docs/images/user/storefront/posts/create-post/6-post-seo.png)
-* Slug - if not set, the Title Link will be used
+Manage how the post appears in search engine results (all optional):
-## Click Create
+- **Meta Title** - defaults to the Title if left blank.
+- **Meta Description** - defaults to the Excerpt if left blank.
+- **Slug** - defaults to a URL-friendly version of the Title if left blank.
-Now that you’ve finished adding all of the content to your post and configuring the settings, all that’s left to do is to click the blue ‘Create’ button at the bottom of the page.
+## Create the Post
-Congratulations, you’ve just published your first post!
+Once all sections are filled out, click **Create** at the bottom of the page to finalize your new post.
-![](https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1738166759/docs/Storefront/Create%20a%20Post/7.3.1.6_Create_a_Post_-_Post_Created_hnyfej.png)
+Your post will now be published and visible on the storefront (if a Published At date is set). You can return to this section at any time to edit or delete the post.
diff --git a/docs/user/storefront/delete-post.mdx b/docs/user/storefront/delete-post.mdx
index 259f27fb56..dd71241f51 100644
--- a/docs/user/storefront/delete-post.mdx
+++ b/docs/user/storefront/delete-post.mdx
@@ -1,22 +1,28 @@
---
title: "Delete a Blog Post"
-description: "Delete a blog post and manage your entire blog using Spree Commerce."
+description: "Learn how to delete a blog post in Spree Commerce."
---
-At some point, you might want to delete a post if it’s outdated, no longer relevant, or doesn’t align with your current content strategy.
+Need to remove outdated or irrelevant content? Deleting a blog post in Spree is quick and easy.
-To delete a post, navigate to the Posts tab of the admin dashboard found under Storefront.
+## When to Delete a Post
-![](https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1738166764/docs/Storefront/Delete%20a%20Post/7.3.4.1_Delete_a_Post_-_Navigate_To_Tab_yzzske.png)
+You might want to delete a post if:
-Find the post you’d like to delete and click on it to open the post editor for that specific post.
+- It's no longer relevant
+- It's out of date
+- It no longer aligns with your content strategy
-![](https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1738166764/docs/Storefront/Delete%20a%20Post/7.3.4.2_Delete_a_Post_-_Find_Post_jqc7lg.png)
+## How to Delete a Blog Post
-Scroll to the bottom of the page and locate the red ‘Delete’ button in the bottom right corner under SEO settings.
+To delete a blog post, navigate to **Storefront → Posts** in the admin dashboard.
-![](https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1738166764/docs/Storefront/Delete%20a%20Post/7.3.4.3_Delete_a_Post_-_Find_Delete_Button_un8twa.png)
+![Deleting a blog post in Spree Commerce](/docs/images/user/storefront/posts/delete-post/1-delete-post.png)
-Click ‘Delete’ and the post will be removed from your site.
+Click on the post you want to delete to open the post editor, scroll to the bottom of the page and click **Delete** in the bottom-right corner.
-![](https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1738166764/docs/Storefront/Delete%20a%20Post/7.3.4.4_Delete_a_Post_-_Delete_Post_xcjc0w.png)
+![Delete a post using the blog CMS in Spree Commerce](/docs/images/user/storefront/posts/delete-post/2-post-editor.png)
+
+Once deleted, the post will be removed from your site immediately.
+
+<Warning>This action cannot be undone. Once deleted, the post and its content cannot be recovered.</Warning>
diff --git a/docs/user/storefront/edit-post.mdx b/docs/user/storefront/edit-post.mdx
index 5d2ac66a26..c08dc07e44 100644
--- a/docs/user/storefront/edit-post.mdx
+++ b/docs/user/storefront/edit-post.mdx
@@ -1,22 +1,22 @@
---
title: "Edit a Blog Post"
-description: "Edit your blog post and manage your blog using Spree Commerce"
+description: "Learn how to edit a blog post in Spree Commerce."
---
-At some point, you might want to edit a blog post after it’s published to ensure the information remains accurate and up-to-date. Additionally, updating the content can help improve SEO performance and keep it relevant for your audience.
+Updating blog content is a great way to keep your posts accurate, relevant, and SEO-optimized. Whether you’re fixing a typo, updating a link, or revising product details, editing a blog post is simple.
-To edit a post, navigate to the Posts tab of the admin dashboard found under Storefront.
+## How to Edit a Blog Post
-![](https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1738166764/docs/Storefront/Edit%20a%20Post/7.3.2.1_Edit_a_Post_-_Navigate_To_Tab_ebapnt.png)
+To edit a blog post, go to **Storefront → Posts** in the admin dashboard.
-Find the post you’d like to edit and click on it. This will open the post editor for that specific post.
+![The Blog CMS in the Spree Commerce dashboard](/docs/images/user/storefront/posts/edit-post/1-edit-post.png)
-![](https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1738166764/docs/Storefront/Edit%20a%20Post/7.3.2.2_Edit_a_Post_-_Click_On_Post_w2xqey.png)
+Locate the post you want to edit and click on it to open the blog post editor.
-Feel free to edit any of the content or settings visible on the page.
+![Blog post editor in Spree Commerce](/docs/images/user/storefront/posts/edit-post/2-post-editor.png)
-Once you’re done, make sure to click the blue ‘Update’ button at the bottom of the page, otherwise any changes you’ve made will not be saved.
+Make any necessary changes to the content, SEO settings, featured image, or metadata.
-![](https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1738166764/docs/Storefront/Edit%20a%20Post/7.3.2.3_Edit_a_Post_-_Post_Updated_mmni5r.png)
+When you’re finished, click **Update** to save your changes.
-Congratulations, you’ve just edited a post!
\ No newline at end of file
+<Warning>Changes won’t be saved unless you click **Update**.</Warning>