Skip to content

Commit 21b0e7c

Browse files
committed
chore: update README with bundler info
1 parent abbe502 commit 21b0e7c

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

README.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,10 @@ This section describes the best practices about what and how needs to be done to
3535
```bash
3636
git clone git@github.com:telerik/docs-seed.git
3737
```
38-
1. Install bundler if you don't have it, by executing `gem install bundler`.
38+
1. Install or update bundler. You need 2.4.22 or newer for the `.bundle/config` file to work when installing the build dependencies:
39+
```bash
40+
gem install bundler
41+
```
3942
> If you encounter SSL errors with Bundler, similar to the one described in [RubyGems SSL Certificate Update](https://guides.rubygems.org/ssl-certificate-update/), then follow the solution steps shared in [Bundler.io - Installing new RubyGems certificates](https://bundler.io/v2.0/guides/rubygems_tls_ssl_troubleshooting_guide.html#installing-new-rubygems-certificates).
4043

4144
### Copy Build Scripts
@@ -55,7 +58,10 @@ This section describes the best practices about what and how needs to be done to
5558
### Install Build Dependencies
5659

5760
1. Go to the **DOCS-PATH** directory.
58-
1. Install gems by executing `bundle install`.
61+
1. Install the required gems:
62+
```bash
63+
bundle install
64+
```
5965

6066
### Run the Documentation Site
6167

@@ -67,7 +73,7 @@ This section describes the best practices about what and how needs to be done to
6773
```
6874
1. Open the documentation site on the server address which is written in the terminal: `http://0.0.0.0:4000/`. If you can't open the URL, replace the `0.0.0.0` with `localhost`: `http://localhost:4000`. For example, for the WPF documentation, this will be `http://0.0.0.0:4000/devtools/wpf/`.
6975
70-
1. To change the host or port, pass the `--host` or `--port` arguments to the command above as an addition (for example, `bundle exec jekyll serve --host=0.0.0.0 --port=1234`).
76+
1. To change the host or port, pass the `--host` or `--port` arguments to the command above as an addition, for example:
7177
7278
### Update Build Scripts
7379
@@ -79,7 +85,10 @@ This section describes the best practices about what and how needs to be done to
7985
8086
### Get More Detailed Error Message
8187
82-
To get more information and a full stacktrace of the error, add `--trace` after your jekyll command. For example, `bundle exec jekyll build --trace`.
88+
To get more information and a full stacktrace of the error, add `--trace` after your jekyll command. For example:
89+
```bash
90+
bundle exec jekyll build --trace
91+
```
8392
8493
### Ctrl+C Does Not Work
8594

0 commit comments

Comments
 (0)