EDU-17893: Update CMS integration instructions - #2570
Merged
Merged
Conversation
Contributor
🏷️ Frontmatter errors
|
| Field | Error |
|---|---|
updatedAt |
'updatedAt' must be in ISO 8601 format (YYYY-MM-DDThh:mm:ss.sssZ). |
Contributor
👁️🗨️ Preview changes on Developer PortalYou can use the link below to load the Developer Portal in preview mode with the changes from this branch: Below is the list of modified pages and their corresponding preview URLs:
|
Contributor
🔍 Documentation feedback for docs/faststore/docs/getting-started/1-setting-up-your-environment.mdx1. General Feedback: 2. Actionable Feedback:
3. Suggested Revision: Was this feedback useful?
|
Contributor
🔍 Documentation feedback for docs/faststore/docs/getting-started/3-running-the-project-locally.mdx1. General Feedback The tutorial effectively guides the user through setting up a local FastStore development environment and making a first customization. The structure is generally clear, with well-defined sections for prerequisites and instructions. However, the document deviates from the specified rules in several key areas, including frontmatter completeness, the "Summary and next steps" section, and adherence to style guide rules regarding tone, voice, and spelling (specifically contractions and acronym definitions). 2. Actionable Feedback
3. Suggested Revision Was this feedback useful?
|
Contributor
🔍 Documentation feedback for docs/faststore/docs/getting-started/2-starting-the-project.mdxHere's a review of the Tutorial based on the provided rules: 1. General FeedbackThe tutorial provides a clear, step-by-step guide for starting a new FastStore project, which aligns well with the purpose of a tutorial. The use of second-person pronouns and a generally professional tone is commendable. However, there are several deviations from the specified rules, primarily concerning the frontmatter, the completeness of the "Summary and next steps" section, the consistent use of active voice, and the proper expansion of acronyms and avoidance of contractions. Addressing these points will significantly improve adherence to the style guide and overall quality. 2. Actionable Feedback
3. Suggested RevisionWas this feedback useful?
|
Contributor
🏷️ Frontmatter errors
|
| Field | Error |
|---|---|
updatedAt |
'updatedAt' must be in ISO 8601 format (YYYY-MM-DDThh:mm:ss.sssZ). |
Contributor
🔍 Documentation feedback for docs/faststore/docs/getting-started/webops/dashboard.mdxHere's a review of the provided Explanation document against the specified rules: 1. General FeedbackThe document is well-structured with clear headings and makes good use of tables and images to explain complex information, adhering well to rules R1.1, R1.3, R1.4, R2.1, and R2.2. It also includes numerous relevant cross-references and links (R1.5). However, the primary area for improvement is the inclusion of step-by-step instructions within an explanation article, which violates rule R1.2. Explanation articles should focus on what a concept is and why it matters, not how to perform specific tasks. Procedural guidance should be moved to dedicated "How-to" guides and linked from the explanation. 2. Actionable FeedbackThe following specific changes are needed to align with rule R1.2:
3. Suggested Revision---
title: 'FastStore WebOps - Dashboard'
updatedAt: "22026-02-03T13:16:12.258Z"
---
Once you [create your FastStore project](https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project#step-2-deploying-the-project) or if you're already working on customizing it, you can use the WebOps dashboard to view website deployments and performance.
The WebOps dashboard provides an overview of website builds and deploy previews and offers suggestions to improve storefront performance based on [Lighthouse scores](https://developer.chrome.com/docs/lighthouse/performance/performance-scoring).
The WebOps dashboard is accessible via **Storefront > FastStore WebOps** in the VTEX Admin. The dashboard has four tabs: [Overview](#overview), [Deploys](#deploys), [Integrations](#integrations), and [Settings](#settings).
---
## Overview
The **Overview** tab shows key store details, including the live store URL, CMS information, and the latest deployment.
### Production overview
The **Production overview** section provides the following information about the latest live store deployment:
| Field | Description |
| :--------------- | :----------------------------------------------------------------------------------------------- |
| **Live store** | URL of your production environment accessible to shoppers. |
| **Repository** | GitHub repository associated with the project. |
| **Source** | Commit for the current deployment, including date, time, and author. |
| **CMS provider** | Link to [CMS](https://developers.vtex.com/docs/guides/cms-for-faststore-storefronts). |
| **CMS project** | Link to the FastStore project in CMS. |
#### Live deployment statuses
This section also displays the status of the live deployment:
* **Success:** The commit was deployed to the production environment and is live.
* **Queued:** The commit is waiting to be deployed.
* **In progress:** The commit is currently being deployed.
* **Failed:** The deployment failed. You can find more details by clicking the link below the `Deploy` button.
### Lighthouse scores
When your store goes live (in production), ensuring optimal performance and a good user experience is crucial. The Lighthouse scores section offers insights into four key areas, helping you understand their impact on store performance.
* **Performance:** Indicates how fast your pages load.
* **Accessibility:** Reflects how usable your pages are for people with disabilities.
* **Best practices:** Indicates how well your pages follow coding best practices.
* **SEO:** Reflects how well your pages are optimized for search engines.
These scores are based on the pages defined for testing in the [Integrations](#integrations) tab.
### Production deploys
This section lists recent deployments to your production store. Each item on the list is composed of the following:
For a complete list of store deployments and their details, check the [Deploys](#deploys) tab.
### Preview deploys
This section lists all the deploy previews created for GitHub branches in your project repository. These previews are automatically available for each pull request opened in its corresponding branch. You can [configure which branches generate preview deployments](https://developers.vtex.com/docs/guides/faststore/webops-configuring-production-and-preview-branches#configuring-preview-branch-filters) in the Integrations tab.
## Deploys
The **Deploys** tab provides insights into store deployments, including their status (success, failed, etc.). The table below summarizes the key features of the Deploys tab.
| **Feature** | Description |
| -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 1 - Search bar | Allows you to search by deploy ID, commit, message, or author. |
| 2 - Pagination | Allows you to navigate through pages of deployment data. |
| 3 - Environment | Filters deployments by environment: <ol><li>Production: The live store customers can interact with.</li><li>Preview: Test environment for new features, design changes, and code modifications before releasing them to production.</li></ol> |
| 4 - Branch | Filters deployments by GitHub branches. |
| 5 - Status | Filters deployments by status: <ol><li>Queued: The deployment is waiting to be executed.</li><li>In progress: The deployment is being executed.</li><li>Success: The deployment was completed successfully.</li><li>Failed: The deployment encountered an error and didn't complete as expected.</li></ol> |
| 6 - Sort by | Filters deployments by **Latest first** or **Oldest first**. |
| 7 - Deployment table | Lists all store deployments with the following information: <ol><li>Score: Lighthouse score for the deployment.</li><li>Source: Commit ID and branch.</li><li>Author: Deployment author and the date and time of the deployment.</li><li>Environment: The environment that was changed, Production or Preview.</li><li>Deploy ID: The ID of the specific deployment.</li><li>Status: The deployment status.</li></ol> |
### Deployment details
For more information, click any entry in the deployment table.
In the **Deploy steps** section, select a step (for example, **Build - Discovery**) to view logs. The logs, shown on the right, help diagnose failed deployments.
#### Rerunning a build
If a deployment fails due to issues unrelated to your code, such as environment variables or temporary network problems, you can rerun the build job directly in WebOps without pushing a new commit to the repository. For detailed instructions on how to perform this action, refer to [Rerunning a FastStore WebOps Build](https://developers.vtex.com/docs/guides/faststore/how-to-rerun-webops-build).
> ℹ️ If the logs indicate problems in your code (for example, syntax errors and failing tests), update the code in your local environment and push a new commit. WebOps will automatically trigger a new deployment for that commit.
## Integrations
The **Integrations** tab allows you to configure branch settings and store pages for Lighthouse tests. The tab contains the following sections:
1. **[Production branch](#production-branch):** Configures which Git branch generates production builds for your account.
2. **[Preview branches](#preview-branches):** Controls which branches generate preview deployments.
3. **[Lighthouse scores](#lighthouse-scores):** Configures store pages for Lighthouse testing.
### Production branch
The **Production branch** section allows you to configure which Git branch generates production builds for your account.
### Preview branches
The **Preview branches** section allows you to control which branches generate preview deployments by including or excluding patterns.
#### Rules
In the **Rules** subsection, you can manage your rules by editing or removing them.
> ℹ️ For detailed instructions on branch configuration, see the guide [Configuring production and preview branches in WebOps](https://developers.vtex.com/docs/guides/faststore/webops-configuring-production-and-preview-branches).
### Lighthouse scores
The **Lighthouse scores** section allows you to configure store pages for Lighthouse testing. You can specify the URLs for a product listing page (PLP) and a product details page (PDP) to undergo automatic Lighthouse score testing during deployments, ensuring a consistent testing experience. For detailed instructions on configuring these pages, refer to [Configuring Lighthouse Test Pages in WebOps](https://developers.vtex.com/docs/guides/faststore/how-to-configure-lighthouse-pages).
Once you've set the pages for testing and after a new deployment, go to the **Overview** tab and access the **Lighthouse scores** section to check the scores for those pages.
## Settings
The **Settings** tab is where you manage the following configurations:
* [**Production domain**](#production-domain): Sets the primary URL customers use to access the live store.
* [**Variables and secrets**](#variables-and-secrets): Stores and allows secure management of sensitive information, such as API keys and passwords, required during FastStore deployment.
### Production domain
As part of the [go-live](https://developers.vtex.com/docs/guides/faststore/go-live-overview) process, you must define the production domain of the store, the main URL customers will use to access your store.
> ⚠️ Before adding the domain, make sure the [external DNS settings](https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns) are correctly configured in your VTEX account settings.
The **Production domain** section allows you to set up the primary domain of your store by selecting it from the dropdown list in the **Host** field and adding it. For detailed instructions on this process, refer to [Setting up your Production Domain in WebOps](https://developers.vtex.com/docs/guides/faststore/how-to-set-production-domain).
#### Current domains
The **Current domains** section displays the default and primary domains configured for your store. This section serves as a reference to verify that your domains are correctly set up in WebOps. By checking this list, you can confirm whether your domains have been successfully added and are ready for use in the FastStore environment.
> ⚠️ If your domain isn't listed, there might be an issue with the configuration or DNS settings that you need to address before proceeding with the go-live. If you follow the [external DNS settings](https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns) guide correctly, and the problem persists, open a ticket with [VTEX Support](https://help.vtex.com/en/support).
### Variables and secrets
Variables and secrets are encrypted credentials, like API keys and passwords, that require secure management during FastStore deployment. Standardizing variables and secrets management via WebOps enhances security and consistency across deployment providers.
The **Variables and secrets** section allows you to add new variables and secrets by completing the `Type`, `Key`, and `Value` fields. For detailed instructions on managing variables and secrets, refer to [Managing variables and secrets](https://developers.vtex.com/docs/guides/faststore/webops-managing-variables-and-secrets).
> ℹ Learn more in [Managing variables and secrets](https://developers.vtex.com/docs/guides/faststore/webops-managing-variables-and-secrets).
#### Current keys
The **Current keys** section lists all variables and secrets configured for your store, along with their corresponding keys (identifiers). Variable values can be revealed or hidden using the visibility toggle, while secret values remain hidden for security. Existing variables and secrets can be updated or deleted from this section using the `⋮` menu. For detailed instructions on managing variables and secrets, refer to [Managing variables and secrets](https://developers.vtex.com/docs/guides/faststore/webops-managing-variables-and-secrets).
## Deleting the project
The FastStore project can be deleted by clicking **More actions** (`⋮`) and then **Delete project**. For detailed instructions on deleting a project, refer to [Deleting a FastStore WebOps Project](https://developers.vtex.com/docs/guides/faststore/how-to-delete-webops-project).
A modal to confirm your action will open.
> ⚠️ Proceed with caution. Deleting the project can't be undone. All deployments and associated domains will be permanently removed.Was this feedback useful?
|
Contributor
🏷️ Frontmatter errors
|
| Field | Error |
|---|---|
updatedAt |
'updatedAt' must be in ISO 8601 format (YYYY-MM-DDThh:mm:ss.sssZ). |
lucasfp13
requested changes
Mar 27, 2026
Co-authored-by: Lucas Feijó <lucasfjportela@gmail.com>
Contributor
🏷️ Frontmatter errors
|
| Field | Error |
|---|---|
updatedAt |
'updatedAt' must be in ISO 8601 format (YYYY-MM-DDThh:mm:ss.sssZ). |
Contributor
🔍 Documentation feedback for docs/faststore/docs/getting-started/overview.mdxThe provided document, titled "Getting started," deviates from the specified rules for Tutorial writing in several key areas, particularly concerning its structure and adherence to style guidelines. The document appears to function more as an overview or a learning track guide rather than a self-contained tutorial with actionable steps within the document itself. 1. General FeedbackThe document is well-intentioned as an introductory piece for FastStore, but it fundamentally misaligns with the "Tutorial" structure defined by the rules. It lacks mandatory frontmatter fields, its title is not compliant, and most critically, it does not contain an "Instructions" section with sequential steps as required for a tutorial. Instead, it presents a list of links to other guides, which is more characteristic of a learning path or module overview. Additionally, there are several instances of subjective language, passive voice, contractions, and undefined acronyms that need correction to meet the style guide. 2. Actionable FeedbackHere are the specific areas that require changes:
3. Suggested RevisionWas this feedback useful?
|
Contributor
🏷️ Frontmatter errors
|
| Field | Error |
|---|---|
updatedAt |
'updatedAt' must be in ISO 8601 format (YYYY-MM-DDThh:mm:ss.sssZ). |
lucasfp13
approved these changes
Mar 31, 2026
barbara-celi
reviewed
Apr 2, 2026
barbara-celi
reviewed
Apr 2, 2026
Contributor
🏷️ Frontmatter errors
|
| Field | Error |
|---|---|
updatedAt |
'updatedAt' must be in ISO 8601 format (YYYY-MM-DDThh:mm:ss.sssZ). |
barbara-celi
reviewed
Apr 2, 2026
barbara-celi
reviewed
Apr 2, 2026
barbara-celi
reviewed
Apr 2, 2026
barbara-celi
reviewed
Apr 2, 2026
barbara-celi
reviewed
Apr 2, 2026
barbara-celi
reviewed
Apr 2, 2026
barbara-celi
reviewed
Apr 2, 2026
barbara-celi
reviewed
Apr 2, 2026
barbara-celi
reviewed
Apr 2, 2026
barbara-celi
reviewed
Apr 2, 2026
barbara-celi
reviewed
Apr 2, 2026
barbara-celi
approved these changes
Apr 2, 2026
Co-authored-by: Bárbara Celi <112641072+barbara-celi@users.noreply.github.com>
mariana-caetano
commented
Apr 6, 2026
Co-authored-by: Mariana Caetano Pereira <67270558+mariana-caetano@users.noreply.github.com>
Contributor
🏷️ Frontmatter errors
|
| Field | Error |
|---|---|
updatedAt |
'updatedAt' must be in ISO 8601 format (YYYY-MM-DDThh:mm:ss.sssZ). |
mariana-caetano
commented
Apr 22, 2026
Co-authored-by: Mariana Caetano Pereira <67270558+mariana-caetano@users.noreply.github.com>
Contributor
🏷️ Frontmatter errors
|
| Field | Error |
|---|---|
updatedAt |
'updatedAt' must be in ISO 8601 format (YYYY-MM-DDThh:mm:ss.sssZ). |
mariana-caetano
commented
Apr 22, 2026
Contributor
🏷️ Frontmatter errors
|
| Field | Error |
|---|---|
updatedAt |
'updatedAt' must be in ISO 8601 format (YYYY-MM-DDThh:mm:ss.sssZ). |
mariana-caetano
commented
Apr 22, 2026
Co-authored-by: Mariana Caetano Pereira <67270558+mariana-caetano@users.noreply.github.com>
Contributor
🏷️ Frontmatter errors
|
| Field | Error |
|---|---|
updatedAt |
'updatedAt' must be in ISO 8601 format (YYYY-MM-DDThh:mm:ss.sssZ). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Provide a concise description of the change introduced by this PR.
Example: “Updates the Checkout overview to include new webhook behavior.”
Type of change
Checklist