Skip to content

Commit e68830b

Browse files
authored
Merge pull request #107 from telerik/dimodi-readme-update
Update the setup instructions
2 parents eb33cd7 + 7c7774d commit e68830b

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

README.md

+10-8
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,10 @@ This section describes the best practices about what and how should be done in o
1313
### Prerequisites
1414
- Install Docker (Community Edititon(CE) is enough) - please use the [official Docker installation guide](https://docs.docker.com/install/). Accept the default installation instructions (use Linux containers, etc.)
1515
- From the Docker Settings window, share the drive where the documentation repos reside with Docker.
16-
- Choose a repo you want to contribute to (e.g. [https://github.com/telerik/xaml-docs.git](https://github.com/telerik/xaml-docs.git), we will refer to that repo later as 'MY-REPO')
17-
- Pull the repo onto your hard drive (e.g. `"D:\Work\xaml-docs"`)
16+
- Choose a repo you want to contribute to (e.g. [https://github.com/telerik/xaml-docs.git](https://github.com/telerik/xaml-docs.git), we will refer to that repo later as **'MY-REPO'**)
17+
- Pull the documentation repo onto your hard drive (e.g. `"D:\Work\xaml-docs"`). We will refer to the local path, where the documentation repo is cloned, as **'DOCS-PATH'**.
18+
19+
> IMPORTANT: For products such as Kendo UI for jQuery, UI for ASP.NET MVC and UI for ASP.NET Core, the documentation is part of source code repo. For these products, **'DOCS-PATH' is actually a nested folder** in the cloned repo, e.g. `"D:\Work\kendo-ui-core\docs"`.
1820
1921
> IMPORTANT: In case you are not able to install and use Docker, please go to [Instructions (without Docker)](#instructions-without-docker), otherwise continue to the next section.
2022
@@ -26,14 +28,14 @@ git clone [email protected]:telerik/docs-seed.git
2628

2729
- Go to the directory in which you've pulled it (e.g. `D:\Work\docs-seed`)
2830
- Open a terminal of your choice (e.g., gitBash)
29-
- Run the following command by passing the MY-REPO path (the **quotes** are mandatory):
31+
- Run the following command by passing the **DOCS-PATH** path (the **quotes** are mandatory):
3032
```bash
3133
sh copy_local.sh "D:\Work\xaml-docs"
3234
```
3335

3436
> If you are running the documentation on a MacOS or another OS where the *robocopy* command is unavailable, you have to pass a second parameter to the copy_local.sh script: `sh copy_local.sh "D:\Work\xaml-docs" true`
3537
36-
- Go to the MY-REPO directory
38+
- Go to the **DOCS-PATH** directory
3739
- Open a terminal of your choice (e.g., gitBash)
3840
- Execute the following bash command in the root folder (where the **Dockerfile** is located)
3941
```bash
@@ -60,14 +62,14 @@ sh start-docs.sh
6062
git clone [email protected]:telerik/docs-seed.git
6163
```
6264

63-
- Go to the directory in which you've pulled it (e.g. `D:\Work\docs-seed`)
65+
- Go to the directory in which you've pulled the current (seed) repo (e.g. `D:\Work\docs-seed`)
6466
- Open a terminal of your choice (e.g., gitBash)
65-
- Run the following command by passing the MY-REPO path (the **quotes** are mandatory):
67+
- Run the following command by passing the **DOCS-PATH** path (the **quotes** are mandatory):
6668
```bash
6769
sh copy_local.sh "D:\Work\xaml-docs"
6870
```
6971

70-
- Go to the MY-REPO directory
72+
- Go to the **DOCS-PATH** directory
7173
- Open a terminal of your choice (e.g., gitBash)
7274
- Install gems by executing `bundle install`
7375
- Execute the following bash command in the root folder
@@ -104,7 +106,7 @@ When you want to stop serving the docs, you may have to **repeat** the `Ctrl+C`
104106

105107
### .gitignore is Always Modified
106108

107-
The scripts that copy the seed repo to the content repo (MY-REPO), also update the `.gitignore` file so as to avoid creating unstanged changes with work files that must not be commited. If you keep getting the `.gitignore` checked out, see what the change is with the original and commit to your repo the version that matches what the tool generates.
109+
The scripts that copy the seed repo to the content repo (**MY-REPO**), also update the `.gitignore` file so as to avoid creating unstanged changes with work files that must not be commited. If you keep getting the `.gitignore` checked out, see what the change is with the original and commit to your repo the version that matches what the tool generates.
108110

109111
### Performance
110112

0 commit comments

Comments
 (0)