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.

Sign up for GitHub

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

EDU-14184: Update on WebOps doc about the master environment #1729

Merged
merged 4 commits into from
Feb 19, 2025
Merged

EDU-14184: Update on WebOps doc about the master environment #1729

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
39a803b
Update requirements.mdx
mariana-caetano Feb 17, 2025
7705f84
Update WebOps overview
mariana-caetano Feb 17, 2025
14321dd
Fixed typos and callout position
mariana-caetano Feb 19, 2025
fdff64f
Fixed typos
mariana-caetano Feb 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion docs/faststore/docs/getting-started/1-onboarding/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,15 @@ This document provides an overview of the FastStore WebOps app, a tool designed

### Install the FastStore WebOps app

Make sure you have installed the FastStore WebOps app to your store account by following the instructions in [Install the FastStore WebOps app](https://developers.vtex.com/docs/guides/faststore/getting-started-requirements#install-the-faststore-webops-app).
To get started, make sure you have installed the FastStore WebOps app to your store account by following the instructions in [Install the FastStore WebOps app](https://developers.vtex.com/docs/guides/faststore/getting-started-requirements#install-the-faststore-webops-app).

The FastStore WebOps app follows a specific workflow for setup and development process. keep the following in mind:

- **Environment Requirement:** The FastStore WebOps app operates exclusively in the production environment. Therefore, it must be installed only in your account's master environment.
- **Development workflow:** Different than VTEX IO, which uses [workspaces](https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace), FastStore relies on [branches system](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches) for development and testing. Here's how it works:
1. The app is installed in the `master` environment of your account.
2. Development and testing occur on Git branches.
3. Once changes are approved, they are merged into your repository's `main` branch and will be available in the production environment for your customers.

### Create your store Catalog

Expand Down
4 changes: 2 additions & 2 deletions docs/faststore/docs/getting-started/requirements.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,13 +129,13 @@ Once you have changed the edition, follow the instructions on this [requirements

To install the app, follow these steps.

1. In a terminal, log into your VTEX account by running the following:
1. In a terminal, log into your VTEX account by running the following. Replace `{accountName}` with your store account name, for example `vtex login store`.

```bash
vtex login {accountName}
```

> ⚠️ Replace `{accountName}` with your store account name, for example `vtex login store`.
> ⚠️ The FastStore WebOps app only works in the production environment, so you must install it only in your account's master environment.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

De repente esse callout faz mais sentido no item 2 abaixo, que aborda mais diretamente a etapa da instalação do app.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Boa! Ajustado


2. Install the FastStore WebOps app by running the following command:

Expand Down
Loading