Skip to content

Commit

Permalink
Adding info block templates
Browse files Browse the repository at this point in the history
  • Loading branch information
lenadoc committed Apr 30, 2021
1 parent 61d92b7 commit 35f1fd3
Show file tree
Hide file tree
Showing 39 changed files with 105 additions and 11 deletions.
5 changes: 5 additions & 0 deletions _templates/back-office-user-guide-template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: {Meta name}
description: {Meta description}
template: back-office-user-guide-template
---
4 changes: 4 additions & 0 deletions _templates/block-without-title.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
<p>WarningBlock without title:</p>
{% info_block warningBox %}
Your content
{% endinfo_block %}
5 changes: 5 additions & 0 deletions _templates/concept-topic-template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: {Meta name}
description: {Meta description}
template: concept-topic-template
---
6 changes: 6 additions & 0 deletions _templates/feature-integration-guide-template.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
title: {Feature Name} feature integration
description: Integrate the {Feature Name} into your project
template: feature-integration-guide-template
---

<!-- This document is an integration guide template.
All the described steps are optional. If you want to add a step that's not described in the template, contact Karoly Gerner.
Expand Down
5 changes: 5 additions & 0 deletions _templates/glue-api-storefront-guide-template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: {Meta title}
description: {Meta description}
template: glue-api-storefront-guide-template
---
2 changes: 1 addition & 1 deletion _templates/howto-guide-template.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: {Meta name}
description: {Meta description}
tags: [, ]
template: howto-guide-template
---

#{Title} <!---in -ing form, e.g. Creating a new CMS page)-->
Expand Down
5 changes: 5 additions & 0 deletions _templates/import-file-template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: {Meta name}
description: {Meta description}
template: import-file-template
---
3 changes: 3 additions & 0 deletions _templates/info-blocks/error.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{% info_block errorBox "Error" %}
Your content
{% endinfo_block %}
3 changes: 3 additions & 0 deletions _templates/info-blocks/info.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{% info_block infoBox "Info" %}
Your content
{% endinfo_block %}
9 changes: 9 additions & 0 deletions _templates/info-blocks/verification.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{% info_block warningBox "Warning" %}
Make sure that the following changes have been applied in transfer objects:

| TRANSFER | TYPE | EVENT | PATH |
|-|-|-|-|
| | | | |
| | | | |

{% endinfo_block %}
3 changes: 3 additions & 0 deletions _templates/info-blocks/warning.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{% info_block warningBox "Warning" %}
Your content
{% endinfo_block %}
2 changes: 1 addition & 1 deletion _templates/module-migration-guide-template.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: {Meta name}
description: {Meta description}
tags: [, ]
template: module-migration-guide-template
---

# Upgrading from version {version number} to version {version number}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: File details - merchant_profile.csv
last_updated: Feb 26, 2021
description: This document describes the merchant_profile.csv file to configure merchant information in your Spryker shop.
template: import-file-template
---

This document describes the `merchant_profile.csv` file to configure merchant profile information in your Spryker shop.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: File details - merchant_user.csv
last_updated: Mar 01, 2021
description: This document describes the merchant_user.csv file to configure merchant information in your Spryker shop.
template: import-file-template
---

This document describes the `merchant-user.csv` file to configure [merchant user](/docs/marketplace/user/features/merchants/merchant-users-feature-overview.html) information in your Spryker shop.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: File details - merchant.csv
last_updated: Feb 26, 2021
description: This document describes the merchant.csv file to configure merchant information in your Spryker shop.
template: import-file-template
---

This document describes the `merchant.csv` file to configure [merchant](/docs/marketplace/user/features/merchants/merchants-feature-overview.html) information in your Spryker shop.
Expand Down
2 changes: 1 addition & 1 deletion docs/marketplace/dev/howtos/howtos-sample-page.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: HowTos sample page
summary: "You can insert notes, tips, warnings, and important alerts in your content. These notes make use of Bootstrap styling and are available through data references such as site.data.alerts.note."
template: howto-guide-template
---

## HowTos sample page
2 changes: 1 addition & 1 deletion docs/marketplace/dev/setup/installation.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Installation
summary: "You can insert notes, tips, warnings, and important alerts in your content. These notes make use of Bootstrap styling and are available through data references such as site.data.alerts.note."
template: howto-guide-template
---

## Installation
2 changes: 1 addition & 1 deletion docs/marketplace/dev/setup/post-installation-steps.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Post-installation steps
summary: "You can insert notes, tips, warnings, and important alerts in your content. These notes make use of Bootstrap styling and are available through data references such as site.data.alerts.note."
template: howto-guide-template
---

## Post-installation steps
2 changes: 1 addition & 1 deletion docs/marketplace/dev/setup/system-requirements.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: System requirements
summary: "You can insert notes, tips, warnings, and important alerts in your content. These notes make use of Bootstrap styling and are available through data references such as site.data.alerts.note."
template: howto-guide-template
---

## System requirements
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Availability - reference information
last_updated: Feb 02, 2021
description: This document contains reference information for working with the Availability section in Back Office.
template: back-office-user-guide-template
---

This article includes the information you need to know when working with the **Availability** section in Back Office.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Abstract product - reference information
last_updated: Apr 19, 2021
description: This document contains reference information for creating and editing concrete and abstract products.
template: back-office-user-guide-template
---

## Create/edit abstract product
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Products - reference information
last_updated: Feb 02, 2021
description: This document describes the attributes that you see and enter on different product's pages.
template: back-office-user-guide-template
---

This topic describes the attributes that you see and enter on different product pages.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Managing merchant users
last_updated: Apr 23, 2021
description: This guide explains how Marketplace Administrator can manage merchant users in the Back Office.
template: back-office-user-guide-template
---

Merchant user is the user that performs tasks on behalf of the merchant in the Merchant Portal. Marketplace Administrator can manage merchant users in the Back Office.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Managing merchants
last_updated: Apr 23, 2021
description: This guide explains how to create and manage merchant records on the Merchants page.
template: back-office-user-guide-template
---

In the *Merchants* page, you can manage the merchants' records and facilitate the merchant registration and approval process, as well as apply any changes to the existing merchants' records. This topic describes the procedures of creating and managing merchant records.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Merchants - reference information
last_updated: Apr 23, 2021
description: This document contains the reference information that you need to know when working in the Marketplace > Merchants section in the Back Office.
template: back-office-user-guide-template
---

This topic contains the reference information that you need to know when working in the *Marketplace* > *Merchants* section in the Back Office.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Offers - reference information
last_updated: Apr 19, 2021
description: This document contains reference information for working with merchant product offers in Marketplace > Offers.
template: back-office-user-guide-template
---

This topic contains reference information for working with merchant product offers in *Marketplace* > *Offers*.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Managing merchant product offers
last_updated: Apr 19, 2021
description: This topic describes how to view and manage merchant product offers in the Back Office.
template: back-office-user-guide-template
---

This topic describes how to view and manage [merchant product offers](/docs/marketplace/user/features/products-and-offers/product-offer-feature-overview.html) in the Back Office.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
title: Marketplace and merchant state machine module schema
template: concept-topic-template
---
The following schema demonstrates the connections between the Marketplace and merchant state machine.

![Marketplace and merchant state machine module schema](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Marketplace/Marketplace+and+Merchant+orders/Marketplace+and+Merchant+State+Machines+feature+overview/marketplace-and-merchant-state-machine-module-schema.png)
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: Marketplace and merchant state machine feature overview
template: concept-topic-template
---

The basic concept of state machines allows creating a patterned behavior and automation for complicated processes defined by the business, for example, order processes.
With the help of the state machine, a business owner can coordinate the process of changing the statuses of orders and order items according to the business logic.
To provide the algorithm of dealing with orders for Marketplace administrators and merchants simultaneously, we have implemented multiple state machine templates. These templates help the Marketplace owners to make the order management process flexible and corresponding to the business logic. As the process of managing marketplace orders is different from managing the merchant orders, there are two separate state machine engine templates: *Marketplace state machine* and *Merchant state machine*.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: Marketplace and merchant state machines interaction
template: concept-topic-template
---

When viewed independently of each other, the Marketplace and Merchant State Machines workflows look like this:

Marketplace State Machine workflow:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
title: Marketplace order feature overview
template: concept-topic-template
---

When a customer places an order on the Marketplace, the system creates the *Marketplace order*. The Marketplace order, in comparison to a regular order in Spryker Commerce OS, contains information about merchant(s) and one or several [merchant orders](https://documentation.spryker.com/marketplace/docs/merchant-order-feature-overview). Thus, the Marketplace order represents a list of items the customer has bought from one or multiple merchants in a single order.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
title: Marketplace order module relations
template: concept-topic-template
---

The schema below illustates relations between modules in the [Marketplace Order](https://documentation.spryker.com/marketplace/docs/marketplace-order-feature-overview) feature.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: Merchant order feature overview
template: concept-topic-template
---

In the marketplace, when a buyer goes through checkout, the [Marketplace order](https://documentation.spryker.com/marketplace/docs/marketplace-order-feature-overview) is created. Such an order can contain offers and products from different merchants. The part of the order that belongs to a certain merchant is called *merchant order*, and it’s created in the system after the Marketplace order is has been placed. Thus, each merchant order contains at least one item from the Marketplace order.

![Merchant order](https://confluence-connect.gliffy.net/embed/image/1c2da1e6-9e30-4413-a799-bcf18d401167.png?utm_medium=live&utm_source=custom)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: Merchant order module relations
template: concept-topic-template
---

The schema below illustates relations between modules in the [Merchant Order](https://documentation.spryker.com/marketplace/docs/merchant-order-feature-overview) feature.

![Merchant order module relations](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Marketplace/Marketplace+and+Merchant+orders/Merchant+order+feature+overview/merchant-order-module-relations.png)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Merchant users feature overview
summary: "Learn the concept of merchant users in the Spryker Marketplace."
template: concept-topic-template
---

---

The merchant concept presupposes having employees with access to the Merchant Portal that will perform various actions on behalf of the merchants. To allow that, the *merchant user* entity is introduced.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Merchants feature overview
summary: "Learn the concept of merchants in the Spryker Marketplace."
template: concept-topic-template
---

*Merchant* is a seller of goods or services, either a business or a private person working in the Marketplace environment. Merchants manage their business in the *Merchant Portal*. The *Merchant Portal* allows merchants to upload and manage merchant products and [offers](https://documentation.spryker.com/marketplace/docs/product-offer-feature-overview), define prices and stock, fulfill orders, and edit merchant profile information.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Product offers feature overview
summary: "Learn the concept of merproduct offers in the Spryker Marketplace."
template: concept-topic-template
---

The *product offer* entity is created when multiple merchants need to sell the same product on the Marketplace.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Marketplace concept
summary: "This page provides an overview of what a Marketplace is in the Spryker Commerce OS."
template: concept-topic-template
---

An online *Marketplace* is a type of e-commerce business where products or services are sold and fulfilled by multiple sellers (*merchants*). The growing number of large companies are adopting the Marketplace business model to create new revenue streams, differentiate from the competition, get a better ROI, and increase customer loyalty by adding more products or services to their assortment.
Expand Down
3 changes: 2 additions & 1 deletion index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,5 @@ Ensure that the following modules have been updated:
<p>Demo WarningBlock without title:</p>
{% info_block warningBox %}
The following feature integration guide expects the basic feature to be in place. The current feature integration guide only adds:
{% endinfo_block %}
{% endinfo_block %}

0 comments on commit 35f1fd3

Please sign in to comment.