Skip to content

Commit

Permalink
Merge pull request #1916 from spryker/DOC-108-move-docs
Browse files Browse the repository at this point in the history
 Move docs to UC
  • Loading branch information
lenadoc committed Jul 14, 2023
2 parents b9fed0d + 396e4ca commit 2ff3330
Show file tree
Hide file tree
Showing 61 changed files with 240 additions and 223 deletions.
15 changes: 10 additions & 5 deletions Rakefile
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,8 @@ task :check_mp_dev do
/docs\/marketplace\/\w+\/[\w-]+\/202108\.0\/.+/,
/docs\/sdk\/.+/,
/docs\/marketplace\/\w+\/[\w-]+\/202204\.0\/.+/,
/docs\/marketplace\/\w+\/[\w-]+\/202304\.0\/.+/
/docs\/marketplace\/\w+\/[\w-]+\/202304\.0\/.+/,
/docs\/marketplace\/\w+\/[\w-]+\/202400\.0\/.+/
]
HTMLProofer.check_directory("./_site", options).run
end
Expand All @@ -135,7 +136,8 @@ task :check_mp_user do
/docs\/marketplace\/\w+\/[\w-]+\/202108\.0\/.+/,
/docs\/pbc\/.+/,
/docs\/sdk\/.+/,
/docs\/marketplace\/\w+\/[\w-]+\/202304\.0\/.+/
/docs\/marketplace\/\w+\/[\w-]+\/202304\.0\/.+/,
/docs\/marketplace\/\w+\/[\w-]+\/202400\.0\/.+/
]
HTMLProofer.check_directory("./_site", options).run
end
Expand All @@ -159,7 +161,8 @@ task :check_scos_dev do
/docs\/scos\/\w+\/[\w-]+\/202009\.0\/.+/,
/docs\/scos\/\w+\/[\w-]+\/202108\.0\/.+/,
/docs\/scos\/\w+\/[\w-]+\/202204\.0\/.+/,
/docs\/scos\/\w+\/[\w-]+\/202304\.0\/.+/
/docs\/scos\/\w+\/[\w-]+\/202304\.0\/.+/,
/docs\/scos\/\w+\/[\w-]+\/202400\.0\/.+/
]
HTMLProofer.check_directory("./_site", options).run
end
Expand All @@ -183,7 +186,8 @@ task :check_scos_user do
/docs\/scos\/\w+\/[\w-]+\/202009\.0\/.+/,
/docs\/scos\/\w+\/[\w-]+\/202108\.0\/.+/,
/docs\/scos\/\w+\/[\w-]+\/202204\.0\/.+/,
/docs\/scos\/\w+\/[\w-]+\/202304\.0\/.+/
/docs\/scos\/\w+\/[\w-]+\/202304\.0\/.+/,
/docs\/scos\/\w+\/[\w-]+\/202400\.0\/.+/
]
HTMLProofer.check_directory("./_site", options).run
end
Expand Down Expand Up @@ -213,7 +217,8 @@ task :check_pbc do
/docs\/acp\/.+/,
/docs\/scu\/.+/,
/docs\/pbc\/\w+\/[\w-]+\/202212\.0\/.+/,
/docs\/pbc\/\w+\/[\w-]+\/202304\.0\/.+/
/docs\/pbc\/\w+\/[\w-]+\/202304\.0\/.+/,
/docs\/pbc\/\w+\/[\w-]+\/202400\.0\/.+/
]
HTMLProofer.check_directory("./_site", options).run
end
Expand Down
6 changes: 5 additions & 1 deletion _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,6 @@ defaults:
sidebar: "pbc_all_sidebar"
role: "all"


versions:
'201811.0': '201811.0'
'201903.0': '201903.0'
Expand All @@ -183,6 +182,7 @@ versions:
'202204.0': '202204.0'
'202212.0': '202212.0'
'202304.0': 'Upcoming release'
'202400.0': 'Winter release'

# versioned categories - these must match corresponding directories
versioned_categories:
Expand Down Expand Up @@ -250,6 +250,10 @@ versioned_categories:
- tax-management
- user-management
- warehouse-management-system
- push notification
- warehouse-picking
- service-points



# these are defaults used for the front matter for these file types
Expand Down
26 changes: 1 addition & 25 deletions _data/sidebars/pbc_all_sidebar.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
title: PBC guides
title: PBC guides
entries:
- product: PBC
nested:
Expand All @@ -12,14 +12,6 @@ entries:
url: /docs/pbc/all/back-office/back-office-translations-overview.html
- title: Install the Spryker Core Back Office feature
url: /docs/pbc/all/back-office/install-the-spryker-core-back-office-feature.html
- title: Install the Warehouse User Management feature
url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-the-warehouse-user-management-feature.html
include_versions:
- "202304.0"
- title: Install the Spryker Core Back Office + Warehouse User Management feature
url: /docs/pbc/all/back-office/install-spryker-core-back-office-warehouse-user-management-feature.html
include_versions:
- "202304.0"
- title: "HowTo: Add support of number formatting in the Back Office"
url: /docs/pbc/all/back-office/howto-add-support-of-number-formatting-in-the-back-office.html
- title: Manage in the Back Office
Expand Down Expand Up @@ -192,14 +184,6 @@ entries:
url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-feature.html
- title: Cart + Non-splittable Products
url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-non-splittable-products-feature.html
- title: Cart Notes
url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-notes-feature.html
include_versions:
- "202304.0"
- title: Cart + Prices
url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-prices-feature.html
include_versions:
- "202304.0"
- title: Cart + Product
url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-product-feature.html
- title: Cart + Product Bundles
Expand Down Expand Up @@ -472,10 +456,6 @@ entries:
url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-cms-product-lists-catalog-feature.html
- title: Content Items
url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-content-items-feature.html
- title: File Manager
url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-file-manager-feature.html
include_versions:
- "202304.0"
- title: Navigation
url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-navigation-feature.html
- title: Product Sets
Expand Down Expand Up @@ -3330,10 +3310,6 @@ entries:
url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-inventory-management-feature.html
- title: Inventory Management + Alternative Products
url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-inventory-management-alternative-products-feature.html
- title: Order Management + Inventory Management
url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-order-management-inventory-management-feature.html
include_versions:
- "202304.0"
- title: Availability Notification Glue API
url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-availability-notification-glue-api.html
- title: Inventory Management Glue API
Expand Down
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@


This document describes how to ingrate the [Inventory Management](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/inventory-management-feature-overview.html) feature into a Spryker project.
This document describes how to ingrate the [Inventory Management](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/inventory-management-feature-overview.html) feature into a Spryker project.

{% info_block errorBox %}

The following feature integration guide expects the basic feature to be in place.

The current feature integration guide adds the following functionality:
* [Warehouse Management](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/inventory-management-feature-overview.html#warehouse-management)
* [Add to cart from catalog page](/docs/scos/user/features/{{site.version}}/cart-feature-overview/quick-order-from-the-catalog-page-overview.html)
* [Warehouse address](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/inventory-management-feature-overview.html#defining-a-warehouse-address)
* [Warehouse Management](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/inventory-management-feature-overview.html#warehouse-management)
* [Add to cart from catalog page](/docs/scos/user/features/{{page.version}}/cart-feature-overview/quick-order-from-the-catalog-page-overview.html)
* [Warehouse address](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/inventory-management-feature-overview.html#defining-a-warehouse-address)

{% endinfo_block %}

Expand All @@ -23,12 +23,12 @@ To start feature integration, integrate the required features:

| NAME | VERSION | INTEGRATION GUIDE |
|--------------|------------------|------------------|
| Spryker Core | {{site.version}} | [Spryker core feature integration](/docs/pbc/all/miscellaneous/{{site.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html)
| Spryker Core | {{page.version}} | [Spryker core feature integration](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html)

### 1) Install the required modules using Composer

```bash
composer require spryker-feature/inventory-management:"{{site.version}}" --update-with-dependencies
composer require spryker-feature/inventory-management:"{{page.version}}" --update-with-dependencies
```

{% info_block warningBox "Verification" %}
Expand Down Expand Up @@ -632,7 +632,7 @@ To start integration, integrate the required features:

| NAME | VERSION | INTEGRATION GUIDE |
|--------------|------------------|------------------|
| Inventory Management | {{site.version}} |[Inventory Mamagement feature integration](#install-feature-core) |
| Inventory Management | {{page.version}} |[Inventory Mamagement feature integration](#install-feature-core) |

### 1) Install the required modules using Composer

Expand Down Expand Up @@ -721,6 +721,6 @@ Make sure that after the order is created, the new row in the `warehouse_allocat

| FEATURE | REQUIRED FOR THE CURRENT FEATURE | INTEGRATION GUIDE |
|--------------------------|----------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Inventory Management API | | [Install the Inventory Management Glue API](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-inventory-management-glue-api.html) |
| Alternative Products | | [Alternative Products + Inventory Management feature integration - ongoing](/docs/scos/dev/feature-integration-guides/{{site.version}}/alternative-products-inventory-management-feature-integration.html) |
| Order Management | | [Order Management + Inventory Management feature integration](/docs/scos/dev/feature-integration-guides/{{site.version}}/order-management-inventory-management-feature-integration.html) |
| Inventory Management API | | [Install the Inventory Management Glue API](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-inventory-management-glue-api.html) |
| Alternative Products | | [Alternative Products + Inventory Management feature integration - ongoing](/docs/scos/dev/feature-integration-guides/{{page.version}}/alternative-products-inventory-management-feature-integration.html) |
| Order Management | | [Order Management + Inventory Management feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/order-management-inventory-management-feature-integration.html) |
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@



This document describes how to ingrate the [Order Management](/docs/scos/user/features/{{page.version}}/order-management-feature-overview/order-management-feature-overview.html) + [Inventory Management](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/inventory-management-feature-overview.html) feature into a Spryker project.
This document describes how to ingrate the [Order Management](/docs/scos/user/features/{{page.version}}/order-management-feature-overview/order-management-feature-overview.html) + [Inventory Management](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/inventory-management-feature-overview.html) feature into a Spryker project.

{% info_block errorBox %}

Expand All @@ -10,7 +10,7 @@ The following features integration guide expects the basic feature to be in plac
The current feature integration guide adds the following functionality:

* [Order Management](/docs/scos/user/features/{{page.version}}/order-management-feature-overview/order-management-feature-overview.html)
* [Inventory Management](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/inventory-management-feature-overview.html)
* [Inventory Management](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/inventory-management-feature-overview.html)

{% endinfo_block %}

Expand All @@ -24,8 +24,8 @@ To start feature integration, integrate the required features:

| NAME | VERSION | INTEGRATION GUIDE |
|--------------|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|
| Order Management | {{site.version}} | [Order Management feature integration](/docs/scos/dev/feature-integration-guides/{{site.version}}/order-management-feature-integration.html)
| Inventory Management | {{site.version}} | [Inventory Management feature integration](docs/scos/dev/feature-integration-guides/{{site.version}}/install-the-inventory-management-feature.md) |
| Order Management | {{page.version}} | [Order Management feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/order-management-feature-integration.html)
| Inventory Management | {{page.version}} | [Inventory Management feature integration](docs/scos/dev/feature-integration-guides/{{page.version}}/install-the-inventory-management-feature.md) |


### 1) Set up behavior
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ To start feature integration, integrate the required features:

| NAME | VERSION | INTEGRATION GUIDE |
|-----------------------------------------|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Warehouse User Management | {{site.version}} | [Install the Warehouse User Management feature](/docs/scos/dev/feature-integration-guides/{{site.version}}/install-the-warehouse-user-management-feature.html) |
| Order Management + Inventory Management | {{site.version}} | [Order Management and Inventory Management feature](/docs/scos/dev/feature-integration-guides/{{site.version}}/install-the-order-management-and-inventory-management-feature.html) |
| Warehouse User Management | {{page.version}} | [Install the Warehouse User Management feature](/docs/pbc/all/warehouse-management-system/{{page.version}}/unified-commerce/fulfillment-app/install-and-upgrade/install-features/install-the-warehouse-user-management-feature.html) |
| Order Management + Inventory Management | {{page.version}} | [Order Management + Inventory Management feature](/docs/pbc/all/warehouse-management-system/{{page.version}}/unified-commerce/fulfillment-app/install-and-upgrade/install-features/install-the-order-management-inventory-management-feature.html) |

### 1) Set up configuration

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ To start feature integration, integrate the required features:
| NAME | VERSION | INTEGRATION GUIDE |
|----------------|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Product Offer | {{page.version}} | [Product Offer feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) |
| Service Points | {{page.version}} | [Service Points feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/install-the-service-points-feature.html) |
| Service Points | {{page.version}} | [Service Points feature integration](/docs/pbc/all/servcie-points/{{page.version}}/install-and-upgrade/install-the-service-points-feature.html) |

### 1) Install the required modules using Composer

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ To start feature integration, integrate the following required features:

| NAME | VERSION | INTEGRATION GUIDE |
|---------------|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|
| Product Offer | {{site.version}} | [Product Offer feature integration](/docs/pbc/all/offer-management/{{site.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) |
| Shipment | {{site.version}} | [Shipment feature integration](/docs/pbc/all/carrier-management/{{page.version}}/install-and-upgrade/install-the-shipment-feature.html) |
| Product Offer | {{page.version}} | [Product Offer feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) |
| Shipment | {{page.version}} | [Shipment feature integration](/docs/pbc/all/carrier-management/{{page.version}}/unified-commerce/enhanced-click-and-collect/install-and-upgrade/install-the-shipment-feature.html) |

## 1) Install the required modules using Composer

```bash
composer require spryker-feature/product-offer-shipment:"{{site.version}}" --update-with-dependencies
composer require spryker-feature/product-offer-shipment:"{{page.version}}" --update-with-dependencies
```

{% info_block warningBox "Verification" %}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@



This document describes how to integrate the [Push Notification feature](/docs/scos/user/features/202304.0/push-notification-feature-overview.html) into a Spryker project.
This document describes how to integrate the [Push Notification feature](/docs/pbc/all/push-notification/{{page.version}}/unified-commerce/push-notification-feature-overview.html) into a Spryker project.

## Install feature core

Expand Down
Loading

0 comments on commit 2ff3330

Please sign in to comment.