Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add CMS setting up guide #147

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added apps/docs/images/cms/homepage/banner-header.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added apps/docs/images/cms/homepage/banner-image.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added apps/docs/images/cms/homepage/button-text.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added apps/docs/images/cms/navigation/navigation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
139 changes: 139 additions & 0 deletions apps/docs/pages/quickstart/saleor-cms.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,139 @@
import { Steps } from "nextra/components";

# Saleor CMS

This guide will help you set up Saleor CMS, which manages your storefront's **homepage**, **footer**, and **navigation**.

## Configure homepage

Saleor CMS relies on attributes to organize content and specific attributes are required for setting up the homepage. Refer to the screenshots below to identify the necessary attributes.

<Steps>
### Create required attributes

Navigate to Saleor dashboard > **Configuration** > **Attributes and Product Types** and select **Attributes**.
Create the following attributes:

**Carousel products** - used to display up to 8 products in a carousel on the homepage:
![Carousel products attribute](../../images/cms/homepage/carousel-products.png)

**Homepage banner button text** - used to display button text on banner section:
![Banner button text attribute](../../images/cms/homepage/banner-button-text.png)

**Homepage banner header** - used to display header on banner section:
![Banner header attribute](../../images/cms/homepage/banner-header.png)

**Homepage banner image** - used to display the background image of the banner section:
![Banner image attribute](../../images/cms/homepage/banner-image.png)

**Homepage button text** - used to display button text on page bottom:
![Button text attribute](../../images/cms/homepage/button-text.png)

**Homepage grid item header** - used to display header on featured carousel's element:
![Grid item header attribute](../../images/cms/homepage/grid-item-header.png)

**Homepage grid item header font color** - used to set the font color of the header on featured carousel's element:
![Grid item header font color attribute](../../images/cms/homepage/grid-item-header-font-color.png)

**Homepage grid item image** - used to display the background image of the featured carousel's element:
![Grid item image attribute](../../images/cms/homepage/grid-item-image.png)

**Homepage grid item subheader** - used to display subheader on featured carousel's element:
![Grid item subheader attribute](../../images/cms/homepage/grid-item-subheader.png)

**Homepage grid item subheader font color** - used to set the font color of subheader on featured carousel's element:
![Grid item subheader font color attribute](../../images/cms/homepage/grid-item-subheader-font-color.png)

### Create Homepage page type

To set up the homepage, you need to create **Page Type** and assign appropriate attributes. Follow these steps:

<Steps>

#### Navigate to Page Types

Go to Saleor dashboard > **Configuration** > **Content Management** and select **Page Types**.

#### Create new Page Type

Click on **Create page type**.
Enter the name **Homepage** for Content Type Name and click **Save**.

#### Assign attributes

Assign all required attributes to **Homepage Page Type**:
![Homepage page type attribute](../../images/cms/homepage/homepage-page-type.png)

</Steps>

### Create an actual homepage

Once **Homepage Page Type** is set up, you can create the actual homepage content by following these steps:

<Steps>
#### Navigate to Content management

Go to Saleor dashboard > **Content** and click **Create content**.

#### Select Page Type

In the dropdown, select **Homepage**.
This ensures that attributes assigned to **Homepage Page Type** are available for editing.

#### Fill in attributes

</Steps>
</Steps>

## Configure navigation & footer

<Steps>

### Navigate to Navigation management

Go to Saleor dashboard > **Configuration** > **Miscellaneous** and select **Navigation**

### Create Menu for navigation and footer

Click **Create menu** to open menu creation form.
For the main navigation, name menu **navbar**.
This menu will manage links displayed in your website's header navigation.
For the footer, create another menu and name it **footer**.
This menu will handle links displayed in the footer section of your website.
![Navigation menus](../../images/cms/navigation/navigation.png)

### Create Menu items

Select the menu you want to edit and click **Create new item** to open the menu item creation form.
Menu items can link to various resources:

- **Category**,
- **Collection**,
- **Static Page** - link to page created in **Content** section,
- **URL** - URL to an external website or link to an internal page within your storefront.

</Steps>

## Configure Static Page

A static page in Saleor is used for standalone content, such as "About Us" or "Contact" page. Unlike **Homepage** page type, **Static Page** does not require attributes. Follow these steps to create one:

<Steps>
### Navigate to Content Management
Go to Saleor dashboard > **Configuration** > **Content Management** and select **Page Types**.
#### Create new Page Type

Click on **Create page type**.
Enter the name **Static page** for Content Type Name and click **Save**.

### Enter page details

- **Title** - provide a title for the page (e.g., "About Us").
- **Slug** - specify the slug for the page, this will determine its URL (e.g., /about-us).
- **Content** - use a rich text editor to add your content (e.g., text paragraphs, headings, bullet points or numbered lists, images, hyperlinks)

### Create an actual static page

Creating an actual static page follows the same steps as creating a homepage.

</Steps>
Loading