EDU-8562: Update VTEX IO CLI install guide #1691
Conversation
Preview LinksOpen this URL to set up the portal with this branch changes. You can now access the edited pages with the following URLs: |
Navigation Preview LinkNo changes detected in the navigation.json file |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit
markdownlint
[markdownlint] reported by reviewdog 🐶
MD033/no-inline-html Inline HTML [Element: span]
[markdownlint] reported by reviewdog 🐶
MD033/no-inline-html Inline HTML [Element: summary]
[markdownlint] reported by reviewdog 🐶
MD033/no-inline-html Inline HTML [Element: br]
[markdownlint] reported by reviewdog 🐶
MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 2; Style: 1/2/3]
[markdownlint] reported by reviewdog 🐶
MD029/ol-prefix Ordered list item prefix [Expected: 2; Actual: 3; Style: 1/2/3]
[markdownlint] reported by reviewdog 🐶
MD033/no-inline-html Inline HTML [Element: br]
[markdownlint] reported by reviewdog 🐶
MD033/no-inline-html Inline HTML [Element: details]
[markdownlint] reported by reviewdog 🐶
MD033/no-inline-html Inline HTML [Element: span]
[markdownlint] reported by reviewdog 🐶
MD033/no-inline-html Inline HTML [Element: summary]
[markdownlint] reported by reviewdog 🐶
MD033/no-inline-html Inline HTML [Element: br]
[markdownlint] reported by reviewdog 🐶
MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 5; Style: 1/1/1]
[markdownlint] reported by reviewdog 🐶
MD033/no-inline-html Inline HTML [Element: br]
| @@ -0,0 +1,164 @@ | |||
| --- | |||
| title: "Installing VTEX IO CLI" | |||
| slug: "vtex-io-documentation-vtex-io-cli-install" | |||
There was a problem hiding this comment.
[style-check] reported by reviewdog 🐶
❌ Found "cli"
Incorrect use of abbreviation.
💡 Suggestion - Replace with "CLI".
✍ Check the Education Styleguide for more information.
|
|
||
| ## Verifying the installation | ||
|
|
||
| To confirm that the installation went as expected, run the following command to check all default commands available in VTEX IO CLI. |
There was a problem hiding this comment.
[style-check] reported by reviewdog 🐶
❌ Found "in VTEX"
When referring to VTEX as a platform or system, use 'on VTEX'. When referring to VTEX as a company, use 'at VTEX'.
💡 Suggestion - Replace with "on VTEX, at VTEX".
✍ Check the Education Styleguide for more information.
There was a problem hiding this comment.
Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit
|
|
||
| > ❗️ We highly recommend using an alternative installation method. If you opt to use npm to install the VTEX IO CLI, remember that CLI won't be automatically updated, and the Node version on your computer might conflict with the one used by CLI developers. If you opt for any other installation method, VTEX IO CLI will always be up-to-date, and you will avoid installation issues. | ||
|
|
||
| <details> |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD033/no-inline-html Inline HTML [Element: details]
| > ❗️ We highly recommend using an alternative installation method. If you opt to use npm to install the VTEX IO CLI, remember that CLI won't be automatically updated, and the Node version on your computer might conflict with the one used by CLI developers. If you opt for any other installation method, VTEX IO CLI will always be up-to-date, and you will avoid installation issues. | ||
|
|
||
| <details> | ||
| <summary><span class="fa fa-apple"> </span>MacOS</summary> |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD033/no-inline-html Inline HTML [Element: span]
| > ❗️ We highly recommend using an alternative installation method. If you opt to use npm to install the VTEX IO CLI, remember that CLI won't be automatically updated, and the Node version on your computer might conflict with the one used by CLI developers. If you opt for any other installation method, VTEX IO CLI will always be up-to-date, and you will avoid installation issues. | ||
|
|
||
| <details> | ||
| <summary><span class="fa fa-apple"> </span>MacOS</summary> |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD033/no-inline-html Inline HTML [Element: summary]
| <details> | ||
| <summary><span class="fa fa-apple"> </span>MacOS</summary> | ||
|
|
||
| <br> |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD033/no-inline-html Inline HTML [Element: br]
|
|
||
|  | ||
|
|
||
| 2. Install **Node.js** via Homebrew by running the following command. |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 2; Style: 1/1/1]
| </details> | ||
|
|
||
| <details> | ||
| <summary><span class="fa fa-windows"> </span>Windows</summary> |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD033/no-inline-html Inline HTML [Element: span]
| </details> | ||
|
|
||
| <details> | ||
| <summary><span class="fa fa-windows"> </span>Windows</summary> |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD033/no-inline-html Inline HTML [Element: summary]
| <details> | ||
| <summary><span class="fa fa-windows"> </span>Windows</summary> | ||
|
|
||
| <br> |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD033/no-inline-html Inline HTML [Element: br]
| yarn global add vtex | ||
| ``` | ||
|
|
||
| 5. Run the following command to finish the installation. |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 5; Style: 1/1/1]
|
|
||
| You don't have to be in your admin role for the next step. | ||
|
|
||
| <br> |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD033/no-inline-html Inline HTML [Element: br]
…h, United States)
…roubleshooting LOC-18432 - VTEX IO CLI install guide documentation improvement
| xcode-select --install | ||
| ``` | ||
|
|
||
| 2. Install **Homebrew** by following the instructions on the [**Homebrew website**](https://brew.sh/index). |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 2; Style: 1/1/1]
|
|
||
|  | ||
|
|
||
| 3. Install **VTEX IO CLI** by running the following command: |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 3; Style: 1/1/1]
| sudo apt install nodejs | ||
| ``` | ||
|
|
||
| 2. Install **Yarn** by following the [Yarn installation](https://classic.yarnpkg.com/en/docs/install#gentoo-stable) for Linux. |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 2; Style: 1/2/3]
| ``` | ||
|
|
||
| 2. Install **Yarn** by following the [Yarn installation](https://classic.yarnpkg.com/en/docs/install#gentoo-stable) for Linux. | ||
| 3. Install **VTEX IO CLI** by running the following command: |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD029/ol-prefix Ordered list item prefix [Expected: 2; Actual: 3; Style: 1/2/3]
|
|
||
| > ❗️ We highly recommend using an alternative installation method. If you opt to use npm to install the VTEX IO CLI, remember that CLI won't be automatically updated, and the Node version on your computer might conflict with the one used by CLI developers. If you opt for any other installation method, VTEX IO CLI will always be up-to-date, and you will avoid installation issues. | ||
| > ❗️ We highly recommend using an alternative installation method. If you choose to install VTEX IO CLI via npm, remember that CLI won't update automatically, and the Node version on your computer might conflict with the one used by CLI developers. If you opt for any other installation method, VTEX IO CLI will always be up-to-date, preventing installation issues. | ||
|
|
||
| <details> |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD033/no-inline-html Inline HTML [Element: details]
|
|
||
| > ❗️ We highly recommend using an alternative installation method. If you opt to use npm to install the VTEX IO CLI, remember that CLI won't be automatically updated, and the Node version on your computer might conflict with the one used by CLI developers. If you opt for any other installation method, VTEX IO CLI will always be up-to-date, and you will avoid installation issues. | ||
| > ❗️ We highly recommend using an alternative installation method. If you choose to install VTEX IO CLI via npm, remember that CLI won't update automatically, and the Node version on your computer might conflict with the one used by CLI developers. If you opt for any other installation method, VTEX IO CLI will always be up-to-date, preventing installation issues. | ||
|
|
||
| <details> | ||
| <summary><span class="fa fa-apple"> </span>MacOS</summary> |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD033/no-inline-html Inline HTML [Element: span]
|
|
||
| > ❗️ We highly recommend using an alternative installation method. If you opt to use npm to install the VTEX IO CLI, remember that CLI won't be automatically updated, and the Node version on your computer might conflict with the one used by CLI developers. If you opt for any other installation method, VTEX IO CLI will always be up-to-date, and you will avoid installation issues. | ||
| > ❗️ We highly recommend using an alternative installation method. If you choose to install VTEX IO CLI via npm, remember that CLI won't update automatically, and the Node version on your computer might conflict with the one used by CLI developers. If you opt for any other installation method, VTEX IO CLI will always be up-to-date, preventing installation issues. | ||
|
|
||
| <details> | ||
| <summary><span class="fa fa-apple"> </span>MacOS</summary> |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD033/no-inline-html Inline HTML [Element: summary]
|
|
||
| > ❗️ We highly recommend using an alternative installation method. If you opt to use npm to install the VTEX IO CLI, remember that CLI won't be automatically updated, and the Node version on your computer might conflict with the one used by CLI developers. If you opt for any other installation method, VTEX IO CLI will always be up-to-date, and you will avoid installation issues. | ||
| > ❗️ We highly recommend using an alternative installation method. If you choose to install VTEX IO CLI via npm, remember that CLI won't update automatically, and the Node version on your computer might conflict with the one used by CLI developers. If you opt for any other installation method, VTEX IO CLI will always be up-to-date, preventing installation issues. | ||
|
|
||
| <details> | ||
| <summary><span class="fa fa-apple"> </span>MacOS</summary> | ||
|
|
||
| <br> |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD033/no-inline-html Inline HTML [Element: br]
| ``` | ||
| ```sh | ||
| yarn global add vtex | ||
| ``` | ||
|
|
||
| <br> |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD033/no-inline-html Inline HTML [Element: br]
| @@ -104,18 +103,18 @@ | |||
|
|
|||
| <br> | |||
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD033/no-inline-html Inline HTML [Element: br]
| ``` | ||
| ```sh | ||
| sudo yarn global add vtex | ||
| ``` | ||
|
|
||
| <br> |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD033/no-inline-html Inline HTML [Element: br]
| @@ -125,24 +124,24 @@ | |||
|
|
|||
| <br> | |||
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD033/no-inline-html Inline HTML [Element: br]
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD033/no-inline-html Inline HTML [Element: details]
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD033/no-inline-html Inline HTML [Element: span]
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD033/no-inline-html Inline HTML [Element: summary]
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD033/no-inline-html Inline HTML [Element: details]
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD033/no-inline-html Inline HTML [Element: span]
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD033/no-inline-html Inline HTML [Element: summary]
| ```sh | ||
| xcode-select --install | ||
| ``` | ||
|
|
||
| 2. Install **Homebrew** by following the instructions on the [**Homebrew website**](https://brew.sh/index). |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 2; Style: 1/1/1]
|
|
||
| 2. Install **Node.js** via Homebrew by running the following command. | ||
| 2. Install **Node.js** via Homebrew by running the following command. |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 2; Style: 1/1/1]
|
|
||
| 3. Then, install **Yarn**. | ||
| 3. Then, install **Yarn**. |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 3; Style: 1/1/1]
| ``` | ||
| ```sh | ||
| brew install yarn | ||
| ``` | ||
|
|
||
| 4. Finally, install **VTEX IO CLI**. |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 4; Style: 1/1/1]
|
|
||
| 2. Install **Yarn** by following the [Yarn installation](https://classic.yarnpkg.com/en/docs/install#gentoo-stable) for Linux. | ||
| 3. Install **VTEX IO CLI** by running the following command. | ||
| 2. Install **Yarn** by following the [Yarn installation](https://classic.yarnpkg.com/en/docs/install#gentoo-stable) for Linux. |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 2; Style: 1/2/3]
| 2. Install **Yarn** by following the [Yarn installation](https://classic.yarnpkg.com/en/docs/install#gentoo-stable) for Linux. | ||
| 3. Install **VTEX IO CLI** by running the following command. | ||
| 2. Install **Yarn** by following the [Yarn installation](https://classic.yarnpkg.com/en/docs/install#gentoo-stable) for Linux. | ||
| 3. Install **VTEX IO CLI** by running the following command: |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD029/ol-prefix Ordered list item prefix [Expected: 2; Actual: 3; Style: 1/2/3]
|
|
||
| 5. Run the following command to finish the installation. | ||
| 5. Run the following command to finish the installation. |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 5; Style: 1/1/1]
|
|
||
| You don't have to be in your admin role for the next step. | ||
| You don't have to be in your admin role for the next step. | ||
|
|
||
| <br> |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD033/no-inline-html Inline HTML [Element: br]
Types of changes