Skip to content

Commit

Permalink
Merge branch 'retrieve-docs-from-contentful' of https://github.com/vt…
Browse files Browse the repository at this point in the history
…exdocs/help-center-content into retrieve-docs-from-contentful
  • Loading branch information
julia-rabello committed Aug 27, 2024
2 parents db15806 + 7de5d8c commit fd74012
Show file tree
Hide file tree
Showing 816 changed files with 1,620 additions and 4,233 deletions.
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
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,7 @@ We have implemented the following improvements to the promotion management exper

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

<div class = "alert alert-info">
To view the promotions that have been automatically archived, go to VTEX Admin <b>Promotions > Promotions</b>, or type <b>Promotions</b> 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.
</div>
>ℹ️ 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?

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,7 @@ Besides the native storefront functionality of the VTEX platform, stores impleme

Now, the Checkout API also supports score-based reCAPTCHA reCAPTCHA validation (equivalent to v3), which is suitable for native mobile apps.

<div class = "alert alert-info">
VTEX is integrated with reCAPTCHA enterprise, which offers two validation approaches: checkbox (equivalent to reCAPTCHA v2) and score-based (equivalent to reCATPCHA v3). See this article on <a href="https://help.vtex.com/en/tutorial/recaptcha-no-checkout--18Te3oDd7f4qcjKu9jhNzP#recaptcha-versions">reCAPTCHA at VTEX Checkout</a> to learn what version you should use depending on your storefront characteristics. You can also learn more each method: <a href="https://developers.google.com/recaptcha/docs/display">reCAPTCHA v2</a> or <a href="https://developers.google.com/recaptcha/docs/v3">reCAPTCHA v3</a> with the documentation provided by Google.
</div>
>ℹ️ VTEX is integrated with reCAPTCHA enterprise, which offers two validation approaches: checkbox (equivalent to reCAPTCHA v2) and score-based (equivalent to reCATPCHA v3). See this article on [reCAPTCHA at VTEX Checkout](https://help.vtex.com/en/tutorial/recaptcha-no-checkout--18Te3oDd7f4qcjKu9jhNzP#recaptcha-versions) to learn what version you should use depending on your storefront characteristics. You can also learn more each method: [reCAPTCHA v2](https://developers.google.com/recaptcha/docs/display) or [reCAPTCHA v3](https://developers.google.com/recaptcha/docs/v3) with the documentation provided by Google.
However, the reCAPTCHA checkbox (equivalent to v2) integration option is still available and is the recommended option if you want to implement a [reCAPTCHA integration](https://developers.vtex.com/docs/guides/recaptcha) other than in a native mobile app.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,7 @@ Previously, when selecting a credit or debit card as a payment method on the Che

Now, if the anti-fraud solution thinks that the **Cardholder Document** field is not necessary for their anti-fraud analysis, the retailer can go to the VTEX Admin and configure whether or not the field should be displayed at Checkout.

<div class = "alert alert-info">
The <b>Cardholder Document</b> field must be filled out with information that is specific to each country, such as CPF (Brazil) and Social Security Number (United States). The field name will be displayed differently at Checkout, depending on the country where the purchase is taking place.
</div>
>ℹ️ The **Cardholder Document** field must be filled out with information that is specific to each country, such as CPF (Brazil) and Social Security Number (United States). The field name will be displayed differently at Checkout, depending on the country where the purchase is taking place.
## Why did we make this change?

Expand All @@ -47,9 +45,7 @@ To check if the anti-fraud solutions configured in your store allow changing the

![cardholder document field](https://images.ctfassets.net/alneenqid6w5/23Hyo1jo4hkC3nXPmOa7NW/350f0aaab8c88555c89a9ca3f2304f6c/cardholder_document_field.png)

<div class = "alert alert-warning">
If the <b>Cardholder document field</b> option is not available on the configuration screen of your anti-fraud solution provider, the <b>Cardholder document</b> field will still be displayed at Checkout in your store, and the customer will be required to fill it out.
</div>
>⚠️ If the **Cardholder document field** option is not available on the configuration screen of your anti-fraud solution provider, the **Cardholder document** field will still be displayed at Checkout in your store, and the customer will be required to fill it out.
For more information about how to configure the visibility of this field on your store’s Checkout, see [Cardholder Document Configuration (Help Center)](https://help.vtex.com/en/tutorial/antifraud-provider--4aZtmdpgFikcsQomWyqAOq#cardholder-document-configuration).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,7 @@ With Extensions Hub, the entire navigation and app purchasing experience happens

The **App Store** displays prices in US dollars (USD) for stores all over the world, and in Brazilian reais (BRL) for stores in Brazil. Payments for app purchases, subscriptions, and usage are processed automatically, and the corresponding amounts are added to your [VTEX invoice](https://help.vtex.com/en/tutorial/billing-overview--6UxfCl4fw4GmyQwoUuIcQs) in your local currency, eliminating the need for credit card payment. If your operation is located outside Brazil and your invoice is in a currency other than USD, we will convert the USD amount to your local currency.

<div class = "alert alert-info">
The <a href="http://apps.vtex.com/">App Store website</a> will still exist for viewing apps in a public way, but it will no longer support app purchases. Purchases can only be made through the VTEX Admin.
</div>
>ℹ️ The [App Store website](http://apps.vtex.com/) will still exist for viewing apps in a public way, but it will no longer support app purchases. Purchases can only be made through the VTEX Admin.
### Partners

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,7 @@ Previously, merchants could see the **Consider discount for boleto payment in th
- __Submit base price (for discount prices):__ Only displays products with a [list price](https://help.vtex.com/en/tracks/precos-101--6f8pwCns3PJHqMvQSugNfP/3XcXp0r5WrJvogB8KIX4Kx#list-price).
- __Apply discount to submitted price:__ Google Shopping will display the VTEX store's products with the associated discount and payment method.

<div class = "alert alert-warning">
The <b>Apply discount to submitted price</b> setting is only available for VTEX stores in Brazil.
</div>
>⚠️ The **Apply discount to submitted price** setting is only available for VTEX stores in Brazil.
![envio-de-precos-google-en](https://images.ctfassets.net/alneenqid6w5/5ZZihnxaawRM55WkmZ8YJA/419f9830910ef18e14deec1eef56f5aa/envio-de-precos-google-en.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,4 @@ We have improved the integration with Amazon to allow VTEX sellers to:

Every seller using the [native](https://help.vtex.com/pt/tutorial/integrando-com-marketplace/) VTEX–Amazon [integration](https://help.vtex.com/pt/tutorial/integrando-com-marketplace/) can benefit from this improvement with no additional cost associated with VTEX. To enable the VTEX Admin feature, you have to register and configure one of the options in Amazon [Seller Central](https://sellercentral.amazon.com/). Then follow the instructions on the [FBA Classic or DBA Order Import](https://help.vtex.com/pt/tutorial/importacao-de-pedidos-amazon-fba-dba) page.

<div class = "alert alert-info">
The DBA order import feature is available for VTEX stores in Brazil.
</div>
>ℹ️ The DBA order import feature is available for VTEX stores in Brazil.
4 changes: 1 addition & 3 deletions docs/announcements/en/marketplace-seller-network.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,7 @@ announcementImageID: ''
announcementSynopsisEN: 'Expand your sales channels and connect with leading marketplaces and sellers through the Marketplace Seller Network.'
---

<div class = "alert alert-info">
<p>This app is exclusively available for Brazil and will soon be released in other regions. If you want to have early access, just download the app and sign up — we will notify you when new partners join your region.</p>
</div>
>ℹ️ This app is exclusively available for Brazil and will soon be released in other regions. If you want to have early access, just download the app and sign up — we will notify you when new partners join your region.
Picture expanding your revenue streams with less investment and way more velocity. One of the main challenges for marketplaces and sellers from our ecosystem is to connect with new partners to expand their offers and reach. With that in mind, we've developed the new Marketplace Seller Network.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,11 @@ Some of the advantages of using a CDN are:

And with HTTP/2 support you have access to a series of other improvements.

<div class = "alert alert-warning">
<strong>All VTEX stores have to migrate</strong> to the new CDN.<br><br>Check out <a href="http://help.vtex.com/en/tutorial/activating-new-vtex-cdn">in this article </a> how to perform this migration.
</div>
>⚠️ **All VTEX stores have to migrate** to the new CDN.
>
>
>
> Check out [in this article ](http://help.vtex.com/en/tutorial/activating-new-vtex-cdn) how to perform this migration.
There are no risks or contraindications to joining the new model.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -228,9 +228,7 @@ VTEX has added the following events to the [list of events available in Audit](h
</tr>
</table>

<div class = "alert alert-info">
See the <a href="https://help.vtex.com/pt/tutorial/eventos-disponiveis-no-audit--6r1Mzcu5NmkmmDLJlz9CCZ">full list of events available in Audit</a>.
</div>
>ℹ️ See the [full list of events available in Audit](https://help.vtex.com/pt/tutorial/eventos-disponiveis-no-audit--6r1Mzcu5NmkmmDLJlz9CCZ).
## What needs to be done?

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,7 @@ These fields were removed from the connector registers and the following message

> Note: Orders with price divergence between the marketplace and VTEX will only be integrated after [configuring a Price Divergence rule](https://help.vtex.com/en/tutorial/configuracao-da-regra-de-divergencia-de-valores--awAKP0sS5J8jgLs2g7pPe).
<div class = "alert alert-info">
When first integrating with a native connector, it is recommended that the seller create the Price Divergence rule before configuring the integration. Not following the recommendation does not prevent the integration from being completed.
</div>
>ℹ️ When first integrating with a native connector, it is recommended that the seller create the Price Divergence rule before configuring the integration. Not following the recommendation does not prevent the integration from being completed.
For the seller that integrates with a native connector for the first time and does not create the Price Divergence rule, orders with price divergence error will be pending in the VTEX Admin, in **MARKETPLACE > Integrations > Orders**. The error message on the interface is as follows:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,4 @@ The new payment and anti-fraud provider management page is now automatically ava

Learn more about the new interface features in [Register payment and anti-fraud providers](https://help.vtex.com/en/tutorial/registering-gateway-affiliations--tutorials_444).

<div class = "alert alert-warning">
The previous version of the affiliations management interface, available at <b>Store Settings > Payment > Settings > Gateway Affiliations</b>, will still be accessible until January 14, 2024.
</div>
>⚠️ The previous version of the affiliations management interface, available at **Store Settings > Payment > Settings > Gateway Affiliations**, will still be accessible until January 14, 2024.
4 changes: 1 addition & 3 deletions docs/announcements/en/partial-invoice-settlements-in-oms.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,7 @@ When managing orders in OMS, the VTEX order management system, adding the invoic

We improved the OMS so that partial invoices added to orders also trigger partial settlements in the transaction. The total order amount will be updated after adding the invoice, and it corresponds to the amount settled in the VTEX payment gateway.

<div class = "alert alert-info">
The partial invoices feature is available to all VTEX stores, but the partial settlement in the gateway is in beta. Besides, for partial invoices to trigger partial settlements in the transaction, it is necessary to use a connector with the <a href="https://help.vtex.com/en/tutorial/payment-provider-protocol--RdsT2spdq80MMwwOeEq0m">Payment Provider Protocol</a>. Legacy connectors do not support the functionality.
</div>
>ℹ️ The partial invoices feature is available to all VTEX stores, but the partial settlement in the gateway is in beta. Besides, for partial invoices to trigger partial settlements in the transaction, it is necessary to use a connector with the [Payment Provider Protocol](https://help.vtex.com/en/tutorial/payment-provider-protocol--RdsT2spdq80MMwwOeEq0m). Legacy connectors do not support the functionality.
## What has changed?

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,7 @@ announcementImageID: ''
announcementSynopsisEN: 'Starting march 31st, the request header resources for pagination will be deprecated.'
---

<div class = "alert alert-warning">
<strong>Warning</strong>: VTEX has two search options - VTEX search and VTEX Intelligent Search. This article refers to the VTEX search. To learn more about the VTEX Intelligent Search application, see <a href = "https://help.vtex.com/en/tracks/vtex-intelligent-search--19wrbB7nEQcmwzDPl1l4Cb">this track</a>.
</div>
>⚠️ **Warning**: VTEX has two search options - VTEX search and VTEX Intelligent Search. This article refers to the VTEX search. To learn more about the VTEX Intelligent Search application, see <a href = "https://help.vtex.com/en/tracks/vtex-intelligent-search--19wrbB7nEQcmwzDPl1l4Cb">this track</a>.
Starting __march 31st__, the request header `resources` for pagination will be deprecated. As a result, you will have to use the parameters `_from` and `_to` in the URL in order to make a request. For example:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,7 @@ To do this, click the search bar, select the `Orders` option, and search for wha

By clicking a result, you will be redirected to the [Order Details page](https://help.vtex.com/en/tutorial/pagina-de-detalhes-do-pedido--2Y75n54Cc9VizrlG1N6ZNl). The last 10 orders you searched for will be recorded in your recent search history, making access more convenient. The search record is stored at the [user](https://help.vtex.com/en/tutorial/gerenciando-usuarios--tutorials_512) level and not shared among users.

<div class = "alert alert-info">
To access orders via the VTEX Admin global search, the user <a href="https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc">role</a> must be associated with the <b>View Order</b> resource (OMSViewer key) of the Order Management System (OMS).
</div>
>ℹ️ To access orders via the VTEX Admin global search, the user [role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc) must be associated with the **View Order** resource (OMSViewer key) of the Order Management System (OMS).
## Why did we make this change?

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,11 @@ As of __27 April 2020__, the VTEX Checkout UI will receive an important change:

This change aims to comply with data protection laws, keeping your store in line with recent changes in legislation.

<div class = "alert alert-warning">
<strong>Attention:</strong> if your store currently performs any customization of the VTEX Checkout that changes the behavior of the newsletter flag (for example, clearing the flag via script), the change we are announcing may affect the expected behavior. In cases where currently the customization via script unchecks the flag, for example, it may be that now it will start doing just the opposite, i.e., checking the flag.<br><br>So, if your store has implemented any customization that changes the standard behavior of the newsletter flag, it's important to ensure that your development team is aware of the change and makes adjustments if necessary.
</div>
>⚠️ **Attention:** if your store currently performs any customization of the VTEX Checkout that changes the behavior of the newsletter flag (for example, clearing the flag via script), the change we are announcing may affect the expected behavior. In cases where currently the customization via script unchecks the flag, for example, it may be that now it will start doing just the opposite, i.e., checking the flag.
>
>
>
> So, if your store has implemented any customization that changes the standard behavior of the newsletter flag, it's important to ensure that your development team is aware of the change and makes adjustments if necessary.
- __Date and time of change__: April 27, 2020, at 11am (Brazil Time).
- __What you need to do__: if your store customizes the Checkout newsletter flag (and only in this case), your development team should check if the change will impact the flag's behavior.
2 changes: 1 addition & 1 deletion docs/announcements/en/vtex-insurance-discontinuity.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,5 +27,5 @@ There will be no contractual or commercial changes since the contract was betwee

No action is required, as the update will be applied automatically to all VTEX stores. Any technical questions or issues related to the product should be addressed directly with [Assurant](https://www.assurant.com.br/).

<div class = "alert alert-warning">VTEX will not provide technical support to customers.</div>
>⚠️ VTEX will not provide technical support to customers.
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,7 @@ Aplicamos las siguientes optimizaciones en la experiencia de gestión de promoci

**Optimización de recursos:** hemos optimizado el tiempo de carga y el desempeño de la lista de promociones.

<div class = "alert alert-info">
Para ver a las promociones que se archivaron automáticamente, accede al Admin VTEX <b>Promociones > Promociones</b>, o <b>ingresa Promociones</b> en la barra de búsqueda de la parte superior de la página. En la esquina superior derecha haz clic en <i class="fas fa-ellipsis-v" aria-hidden="true"></i>, y después en Promociones aplicadas.
</div>
>ℹ️ Para ver a las promociones que se archivaron automáticamente, accede al Admin VTEX **Promociones > Promociones**, o **ingresa Promociones** en la barra de búsqueda de la parte superior de la página. En la esquina superior derecha haz clic en <i class="fas fa-ellipsis-v" aria-hidden="true"></i>, y después en Promociones aplicadas.
## ¿Qué se necesita hacer?

Expand Down
Loading

0 comments on commit fd74012

Please sign in to comment.