You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Nov 19, 2024. It is now read-only.
* <a href="https://devdocs.magento.com">Visit our documentation site</a>, built using [GitHub pages](https://pages.github.com/).
227
+
-<a href="https://devdocs.magento.com">Visit our documentation site</a>, built using [GitHub pages](https://pages.github.com/).
228
228
229
229
## Build DevDocs in Windows
230
230
@@ -239,41 +239,41 @@ Download software:
239
239
240
240
Only Administrators can use Chocolatey features. You can use the Administrator account, or you can use the "Run as Administrator" function on the shortcut menu.
241
241
242
-
1. Open the **Command Prompt** using **Run as Administrator** in the shortcut menu.
242
+
1. Open the **Command Prompt** using **Run as Administrator** in the shortcut menu.
1. Verify Chocolatey was added to the environment variables:
250
+
1. Verify Chocolatey was added to the environment variables:
251
251
252
-
- In the Windows UI, open search and type `path`.
253
-
- In the Windows CMD console, type `echo %path%`.
252
+
- In the Windows UI, open search and type `path`.
253
+
- In the Windows CMD console, type `echo %path%`.
254
254
255
-
You should see `C:\ProgramData\chocolatey\bin` in the path.
255
+
You should see `C:\ProgramData\chocolatey\bin` in the path.
256
256
257
-
1. Close and reopen the command prompt before using `choco` commands.
257
+
1. Close and reopen the command prompt before using `choco` commands.
258
258
259
259
After running the script at the command line, you can install any required extensions. Chocolately has many extensions available, similar to Homebrew for MacOS. As a best practice, only use extensions labeled as a "trusted package". You can install editors, such as Nano and Notepad++, using Chocolatey, as well.
260
260
261
261
#### Install Ruby extension
262
262
263
263
If you have Ruby installed on the workstation, then you can skip this installation.
264
264
265
-
1. Open the **Command Prompt** using **Run as Administrator** in the shortcut menu.
265
+
1. Open the **Command Prompt** using **Run as Administrator** in the shortcut menu.
266
266
267
-
1. Install the ruby extension:
267
+
1. Install the ruby extension:
268
268
269
-
```cmd
270
-
choco install ruby
271
-
```
269
+
```cmd
270
+
choco install ruby
271
+
```
272
272
273
-
1. Verify the environment variables were added properly:
273
+
1. Verify the environment variables were added properly:
274
274
275
-
- In the Windows UI, open search and type `path`.
276
-
- In the Windows CMD console, type `echo %path%`.
275
+
- In the Windows UI, open search and type `path`.
276
+
- In the Windows CMD console, type `echo %path%`.
277
277
278
278
> **NOTE**
279
279
> If you encounter problems with Ruby, or the `gem` command is not recognized, you can install the `rubyinstaller-devkit.exe` development kit located in the `c:\ProgramData\chocolatey\bin` folder.
@@ -293,59 +293,59 @@ Although you can install Git using Chocolatey, we chose to install _Git for Wind
293
293
294
294
#### Set up SSH key
295
295
296
-
1. Open Git Bash. The **Git Bash** executable is on the shortcut menu.
296
+
1. Open Git Bash. The **Git Bash** executable is on the shortcut menu.
297
297
298
-
1. Create a working directory for your Git repositories and change to the new directory.
298
+
1. Create a working directory for your Git repositories and change to the new directory.
299
299
300
-
```bash
301
-
mkdir <directory-name>
302
-
```
300
+
```bash
301
+
mkdir <directory-name>
302
+
```
303
303
304
-
1. Follow the [Generating a new SSH](https://help.github.com/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent/) instructions.
304
+
1. Follow the [Generating a new SSH](https://help.github.com/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent/) instructions.
305
305
306
306
### Clone and build the DevDocs repository
307
307
308
308
You may have to close and reopen the Git Bash application after the Choco installations.
309
309
310
-
1. Open Git Bash. The **Git Bash** executable is on the shortcut menu.
310
+
1. Open Git Bash. The **Git Bash** executable is on the shortcut menu.
311
311
312
-
1. Change to the directory you created for Git repositories and clone the DevDocs repository.
312
+
1. Change to the directory you created for Git repositories and clone the DevDocs repository.
313
313
314
-
```bash
315
-
git clone git@github.com:magento/devdocs.git
316
-
```
314
+
```bash
315
+
git clone git@github.com:magento/devdocs.git
316
+
```
317
317
318
-
1. Change to the `devdocs` directory.
318
+
1. Change to the `devdocs` directory.
319
319
320
-
1. Install [Bundler](https://bundler.io).
320
+
1. Install [Bundler](https://bundler.io).
321
321
322
-
```bash
323
-
gem install bundle
324
-
```
322
+
```bash
323
+
gem install bundle
324
+
```
325
325
326
-
1. Install gem executables required for building the site.
326
+
1. Install gem executables required for building the site.
Incremental build: disabled. Enable with --incremental
343
+
Generating...
344
+
done in 643.551 seconds.
345
+
Auto-regeneration: enabled for 'C:/Users/Administrator/mage/devdocs'
346
+
Server address: http://127.0.0.1:4000/
347
+
Server running... press ctrl-c to stop.
348
+
```
349
349
350
350
> **NOTE**
351
351
> The `.bash_profile` file CAN be created and managed using Git Bash, which is useful for aliases and other customizations, This file is in the `users/Administrator` folder.
0 commit comments