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

Retrieve docs from contentful #18

Merged
merged 17 commits into from
Aug 30, 2024
Merged
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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
The diff you're trying to view is too large. We only load the first 3000 changed files.
6 changes: 3 additions & 3 deletions docs-utils/fix-callouts.js
Original file line number Diff line number Diff line change
Expand Up @@ -74,9 +74,9 @@ function processFile(filePath) {

// Replace HTML structures with corresponding markdown symbols
const newData = data
.replace(/<div class="alert alert-info">(.*?)<\/div>/gs, (match, p1) => `>ℹ️ ${convertCallout(p1)}`)
.replace(/<div class="alert alert-warning">(.*?)<\/div>/gs, (match, p1) => `>⚠️ ${convertCallout(p1)}`)
.replace(/<div class="alert alert-danger">(.*?)<\/div>/gs, (match, p1) => `>❗ ${convertCallout(p1)}`);
.replace(/<div\s+class\s*=\s*"alert alert-info">(.*?)<\/div>/gs, (match, p1) => `>ℹ️ ${convertCallout(p1)}`)
.replace(/<div\s+class\s*=\s*"alert alert-warning">(.*?)<\/div>/gs, (match, p1) => `>⚠️ ${convertCallout(p1)}`)
.replace(/<div\s+class\s*=\s*"alert alert-danger">(.*?)<\/div>/gs, (match, p1) => `>❗ ${convertCallout(p1)}`);

// Write the modified content back to the file
fs.writeFile(filePath, newData, 'utf8', (err) => {
Expand Down
82 changes: 82 additions & 0 deletions docs-utils/replace-quotes.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
const fs = require('fs');
const path = require('path');

// Path to the 'docs' directory
const docsDir = path.resolve(__dirname, '../docs');

// Function to process each Markdown file
const processFile = (filePath) => {
const data = fs.readFileSync(filePath, 'utf8');
const lines = data.split('\n');

if (lines[1] && lines[1].startsWith('title:')) {
let titleLine = lines[1].trim();
const titleContentMatch = titleLine.match(/^title:\s*(['"])(.*)\1$/);

if (titleContentMatch) {
const currentOuterQuote = titleContentMatch[1];
const originalTitleContent = titleContentMatch[2];
let updatedTitleContent;
let updatedTitleLine;

if (currentOuterQuote === `'`) {
// Outer quotes are single
if (originalTitleContent.includes('"')) {
// Inner double quotes present
updatedTitleContent = originalTitleContent.replace(/"/g, "'");
updatedTitleLine = `title: "${updatedTitleContent}"`;
} else {
// No inner double quotes
updatedTitleLine = titleLine;
}
} else if (currentOuterQuote === `"`) {
// Outer quotes are double
if (originalTitleContent.includes('"')) {
// Inner double quotes present
updatedTitleContent = originalTitleContent.replace(/"(?![^"]*")/g, "'");
updatedTitleLine = `title: "${updatedTitleContent}"`;
} else {
// No inner double quotes
updatedTitleLine = titleLine;
}
}

// Only update if necessary
if (updatedTitleLine && updatedTitleLine !== titleLine) {
lines[1] = updatedTitleLine;
const newData = lines.join('\n');
fs.writeFileSync(filePath, newData, 'utf8');
console.log(`Updated file: ${filePath}`);
}
}
}
};

// Function to recursively process files in directories
const processDirectory = (dirPath) => {
fs.readdir(dirPath, (err, files) => {
if (err) {
console.error('Unable to scan directory:', err);
return;
}

files.forEach((file) => {
const filePath = path.join(dirPath, file);
fs.stat(filePath, (err, stats) => {
if (err) {
console.error('Unable to stat file:', err);
return;
}

if (stats.isDirectory()) {
processDirectory(filePath);
} else if (path.extname(file) === '.md') {
processFile(filePath);
}
});
});
});
};

// Start processing from the docs directory
processDirectory(docsDir);
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,7 @@ announcementImageID: ''
announcementSynopsisEN: 'Now available detailed information about the calculation of shipping of the order'
---

<div class="alert alert-warning">
Due to technical reasons, the launch of this feature was postponed until further notice.
</div>
>⚠️ Due to technical reasons, the launch of this feature was postponed until further notice.

Starting April 1, 2019, the request JSON will return a new object called `alternativeTotals`. It will appear in the totalizers that are inside the array of `totals`, for queries made by the APIs Get Order.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 'New returned object in API Get Order "itemMetadata"'
title: "New returned object in API Get Order 'itemMetadata'"
id: 473vn32oLLH2qyep29rpi
status: PUBLISHED
createdAt: 2019-04-08T16:33:34.076Z
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ announcementSynopsisEN: 'VTEX will discontinue Master Data CORS support starting

With its main objective of providing clients with an increasingly efficient experience, VTEX will discontinue Master Data CORS support starting. In order for your store to avoid any operational and browsing failure, follow this article’s instructions.

<div class="alert alert-warning"> Aligning this with the partnership we have with our clients and ensuring the least amount of friction possible to your operations, we have extended this resource's discontinuation date to October 7th, 2019. </div>
>⚠️ Aligning this with the partnership we have with our clients and ensuring the least amount of friction possible to your operations, we have extended this resource's discontinuation date to October 7th, 2019.


### What is CORS?
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,7 @@ announcementSynopsisEN: 'Users will only see the sidebar menu items they’re al

[Roles](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc) allow stores to grant users access only to a selection of resources on our platform. While this was enough to protect your account's data integrity and security, users could still see the sidebar menu items for restricted sections of the admin. These sections are no longer visible, so that users will only be able to see the items they are allowed to access.

<div class="alert alert-info">
This action has a low impact on store’s operations, since it involves a reorganization of the left navigation, and not changes in individual user roles. Also, no predefined settings will be lost: if your users already had pre-defined roles and permissions, they will remain the same.
</div>
>ℹ️ This action has a low impact on store’s operations, since it involves a reorganization of the left navigation, and not changes in individual user roles. Also, no predefined settings will be lost: if your users already had pre-defined roles and permissions, they will remain the same.

## What has changed?

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,12 @@ Available for everyone since October 2017 the new CDN will be mandatory __starti
__Important:__ The main requirement to use the new CDN is __enabling HTTPS in your whole website__. You must pay special attention to HTTP requests, that should turn into the HTTPS protocol in order to work under the new CDN. See how to [enable HTTPS throughout your website](/en/tutorial/enable-https-throughout-the-site) and pay attention to the requirements for this migration.

So, remember:
<div class="alert alert-warning">
You have until <b>april 20th</b> to:<br>
- Enable HTTPS in your whole website.<br>
- Activate VTEX's new CDN.
</div>
>⚠️ You have until **april 20th** to:
>
>
> - Enable HTTPS in your whole website.
>
>
> - Activate VTEX's new CDN.

After this, __crashes may occur__ in the stores that haven't completed the process, from broken layouts to your store going completely *offline* . We recommend you to enable HTTPS and activate the new CDN in this period, so your customers will enjoy the best e-commerce experience.
35 changes: 35 additions & 0 deletions docs/announcements/en/amazon-integration-amazon-offer-matching.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
title: 'Amazon integration: Amazon Offer Matching'
id: 6cWiUoUTzVtOAVpF4XhOzm
status: PUBLISHED
createdAt: 2023-07-04T20:11:24.168Z
updatedAt: 2023-07-04T21:44:36.582Z
publishedAt: 2023-07-04T21:44:36.582Z
contentType: updates
productTeam: Channels
author: 2p7evLfTcDrhc5qtrzbLWD
slug: amazon-integration-amazon-offer-matching
locale: en
legacySlug: amazon-offer-matching
announcementImageID: ''
announcementSynopsisEN: 'Amazon offer matching is now manual. Learn more about the new page.'
---

The [integration](https://help.vtex.com/en/tracks/configurar-integracao-com-a-amazon) between VTEX stores and Amazon allows sellers to send their product catalog to the marketplace, which expands their sales channels. To increase the quality of offers shown on Amazon, we created a new page for VTEX sellers to do the product matching.

## What has changed?

Before, when a seller sent a product to the Amazon integration, it would go through an automatic matching process to link the seller SKU to the product ASIN (Amazon Standard Identification Number) on Amazon. However, this process occasionally resulted in compatibility errors between the sent product and the published offer on Amazon.

With the new matching flow, the sellers approve the matches between their products and Amazon offers. Despite matching now being a manual process, sellers can approve SKUs in bulk.

## Why did we make this change?

The process will now be completely manual. This change aims to reduce compatibility errors, so sellers show reliable and quality offers on the marketplace, giving sellers control over how the sent products and the published offers are matched.

## What needs to be done?

You can find the Amazon Offer Matching page in Marketplace > __Amazon Offer Matching__ or through the search bar. The page will be available for all VTEX accounts as of July 03, 2023. No action is required to activate it.

For more information about how the page works, check the [documentation Amazon Offer Matching](https://help.vtex.com/en/tutorial/match-de-anuncios-amazon--7fRfoP69kYgg8znImMhyQ0).

36 changes: 36 additions & 0 deletions docs/announcements/en/amazon-new-category-mapping-model.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
title: 'Amazon: New category mapping model'
id: 584nPLYkI8tnOGz1s4X5LE
status: PUBLISHED
createdAt: 2023-11-27T23:08:37.697Z
updatedAt: 2023-12-18T15:49:17.763Z
publishedAt: 2023-12-18T15:49:17.763Z
contentType: updates
productTeam: Channels
author: 2p7evLfTcDrhc5qtrzbLWD
slug: amazon-new-category-mapping-model
locale: en
legacySlug: amazon-new-category-mapping-model
announcementImageID: ''
announcementSynopsisEN: 'Check out the new category and attribute mapping model for the VTEX and Amazon integration.'
---

An important step in the [integration](https://help.vtex.com/en/tracks/configurar-integracao-com-a-amazon--6sgd4Pagy3wNsWKBvmIFrP/5sYA9MlRo92jJIxKF1MTXb) between VTEX stores and Amazon is mapping categories and attributes, which consists of matching the products in your catalog with the offers available on Amazon.

To make the mapping process easier and more intuitive, we have developed the **[category and attribute mapping via VTEX Admin](https://help.vtex.com/en/tracks/configurar-integracao-com-a-amazon--6sgd4Pagy3wNsWKBvmIFrP/5xklf2wSdeztQh4iy5kJvD?&utm_source=autocomplete#mapeamento-via-admin-vtex-beta),** which is available for VTEX stores in Brazil, Mexico, and the United States. To access the new mapping model, go to **Marketplace > Marketplaces and Integrations > Amazon > Perform Mapping.** The instructions are available in the [Mapping and sending product categories to Amazon](https://help.vtex.com/en/tracks/configurar-integracao-com-a-amazon--6sgd4Pagy3wNsWKBvmIFrP/5xklf2wSdeztQh4iy5kJvD) tutorial.

## What has changed?

Previously, the mapping process could only be carried out [via spreadsheet](https://help.vtex.com/en/tracks/configurar-integracao-com-a-amazon--6sgd4Pagy3wNsWKBvmIFrP/5xklf2wSdeztQh4iy5kJvD?&utm_source=autocomplete#mapeamento-via-planilha). Now, with the new mapping model, you can choose which type of mapping best meets your needs.

Here are some of the advantages of mapping categories and attributes using the VTEX Admin:

- Monitor the mapping status of each category.
- Search for the category on Amazon to match it with your catalog.
- Autofill the attributes that are already in your catalog.
- Customize the shipping rate template by SKU.

## What needs to be done?

The feature will be available to all [VTEX accounts that act as sellers](https://help.vtex.com/en/tutorial/estrategias-de-marketplace-na-vtex--tutorials_402#sendo-seller-vtex) from **December 18, 2023.** To use it, you need to have your VTEX account [integrated](https://help.vtex.com/en/tracks/configurar-integracao-com-a-amazon--6sgd4Pagy3wNsWKBvmIFrP/5sYA9MlRo92jJIxKF1MTXb) with Amazon and send the products by following the [Mapping and sending product categories to Amazon](https://help.vtex.com/en/tracks/configurar-integracao-com-a-amazon--6sgd4Pagy3wNsWKBvmIFrP/5xklf2wSdeztQh4iy5kJvD) tutorial.

Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,4 @@ This change is motivated by merchants’ demands to set manual prices for each i

To enable the Manual Price feature for Subscriptions, make sure you follow the steps described in the developer guide [Enabling Manual Price for Subscriptions v3](https://developers.vtex.com/vtex-rest-api/docs/enabling-manual-prices-for-subscriptions-v3).

<div class="alert alert-warning">
<p>Manual Price is only available for Subscriptions v3. If you are using a previous version of the Subscriptions system, check out the <a href="https://developers.vtex.com/vtex-rest-api/docs/subscriptions-v3-migration-guide">Subscriptions v3 migration guide</a>.</p>
</div>
>⚠️ Manual Price is only available for Subscriptions v3. If you are using a previous version of the Subscriptions system, check out the [Subscriptions v3 migration guide](https://developers.vtex.com/vtex-rest-api/docs/subscriptions-v3-migration-guide).
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Previously it was only possible to see, and export reports on search results and
<table width = "100%">
<tr>
<td>
<img src = "https:https://images.ctfassets.net/alneenqid6w5/34n3YHcet5J5gHNNLwLw3r/092ec32f2cc0c2f4fb8254b3327006fd/relatorios-filtros-EN.png" style = "display:block; margin-left: auto; margin-right: auto;" alt = "Opções de filtros do relatório" title = "Opções de filtros do relatório">
<img src = "https://images.ctfassets.net/alneenqid6w5/34n3YHcet5J5gHNNLwLw3r/092ec32f2cc0c2f4fb8254b3327006fd/relatorios-filtros-EN.png" style = "display:block; margin-left: auto; margin-right: auto;" alt = "Opções de filtros do relatório" title = "Opções de filtros do relatório">
</td>
</tr>
<tr>
Expand Down
39 changes: 39 additions & 0 deletions docs/announcements/en/automatic-archiving-inactive-promotions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
title: 'Automatic archiving inactive promotions'
id: 4LDQbli98aRSNJDus7mgqi
status: PUBLISHED
createdAt: 2024-05-13T11:40:27.337Z
updatedAt: 2024-05-20T12:14:24.232Z
publishedAt: 2024-05-20T12:14:24.232Z
contentType: updates
productTeam: Marketing & Merchandising
author: 2AhArvGNSPKwUAd8GOz0iU
slug: automatic-archiving-inactive-promotions
locale: en
legacySlug: automatic-archiving-inactive-promotions
announcementImageID: ''
announcementSynopsisEN: 'The new auto-archive feature for inactive promotions helps you manage promotions in your store.'
---

To enhance the promotion management experience, VTEX is introducing an automatic archiving feature for inactive promotions. This feature helps you organize and monitor the promotions available in your store.

## What has changed?

We have implemented the following improvements to the promotion management experience:

**Promotion auto-archiving rules:**

1. **Promotions with an end date (not activated):** These will be automatically archived 7 days after the last change, counting from the promotion end date.

2. **Promotions without an end date (not activated):** These will be automatically archived 30 days after the last change.

3. **Promotions with an end date (active):** These will be automatically archived 7 days after their end date.

**Feature optimization:** We've improved the loading time and performance of the promotions list.

>ℹ️ To view the promotions that have been automatically archived, go to VTEX Admin **Promotions > Promotions**, or type **Promotions** in the search bar at the top of the page. In the top right corner, click <i class="fas fa-ellipsis-v" aria-hidden="true"></i>, and then click Applied Promotions.

## What needs to be done?

No action is required. The feature to automatically archive inactive promotions is now available in all VTEX stores.

Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,7 @@ announcementImageID: ''
announcementSynopsisEN: "Take part in an intensive VTEX training day with the world's leading experts."
---

<div class="alert alert-info">
A full day of training in VTEX given by leading experts.
</div>
>ℹ️ A full day of training in VTEX given by leading experts.

For a long time, customers and partners have been asking for in-depth platform training. Now, finally, we have been able to fulfill that request.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,4 @@ Previously, benefits with payment system conditions were only applied to the mai

In the current scenario, benefits now consider the payment system condition by trade policy. That means that a benefit with payment system filter can be applied to more than one trade policy. With this improvement, the retailer has more flexibility to configure his benefits.

<div class="alert alert-danger">
It is important to note that this feature <strong>is not valid</strong> for third party trade policies.
</div>
>❗ It is important to note that this feature **is not valid** for third party trade policies.
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: 'Black Week: VTEX Dashboards Analysis Strategies'
id: 1MrvvWj1ziiqLWhM021PX7
status: PUBLISHED
createdAt: 2023-11-20T20:29:11.550Z
updatedAt: 2023-11-20T20:39:16.159Z
publishedAt: 2023-11-20T20:39:16.159Z
contentType: updates
productTeam: Others
author: 2p7evLfTcDrhc5qtrzbLWD
slug: black-week-vtex-dashboards-analysis-strategies
locale: en
legacySlug: black-week-vtex-dashboards-analysis-strategies
announcementImageID: ''
announcementSynopsisEN: 'Learn the best strategies for analyzing your sales metrics during Black Week with the VTEX Dashboards guide'
---

We have officially arrived at __Black Week,__ which takes place from __11/20/2023__ to __11/27/2023.__ The stores already have their campaigns online and their operations ready to attend shoppers.

Aiming to maximize opportunities for improving __Black Friday__ actions during this period, we have created a special guide focused on clarifying the most frequently asked questions related to the use of our dashboards in Admin VTEX during the most important event of the year.

See the [VTEX dashboard guide for Black Week: FAQ](https://help.vtex.com/en/tutorial/guia-de-los-dashboards-vtex-para-la-black-week-faq--6O3CiGiZctVIgIrpIcko9h) and you will find answers to the most frequently asked questions about how to use Dashboards during Black Week.
4 changes: 1 addition & 3 deletions docs/announcements/en/boost-your-marketplace-sales.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,4 @@ If your store has __an external marketplace integration__ (and you want to use t

If your store is integrated with __VTEX's certified marketplaces__ (using the Bridge module), the flag will be activated automatically. You'll only need to fulfill the instructions described on items `2` and `3`.

<div class="alert alert-info">
Remember that order integrations need to be done using the <a href="https://developers.vtex.com/reference/orders#getorder">Get Order</a> and <a href="https://developers.vtex.com/reference/feed-v2-deprecated#getfeedorderstatus">Get Feed Order Status</a> APIs.
</div>
>ℹ️ Remember that order integrations need to be done using the [Get Order](https://developers.vtex.com/reference/orders#getorder) and [Get Feed Order Status](https://developers.vtex.com/reference/feed-v2-deprecated#getfeedorderstatus) APIs.
Loading
Loading