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
Copy file name to clipboardExpand all lines: README.md
+10-8
Original file line number
Diff line number
Diff line change
@@ -13,8 +13,10 @@ This section describes the best practices about what and how should be done in o
13
13
### Prerequisites
14
14
- 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.)
15
15
- 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"`.
18
20
19
21
> 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.
- Go to the directory in which you've pulled it (e.g. `D:\Work\docs-seed`)
28
30
- 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):
30
32
```bash
31
33
sh copy_local.sh "D:\Work\xaml-docs"
32
34
```
33
35
34
36
> 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`
35
37
36
-
- Go to the MY-REPO directory
38
+
- Go to the **DOCS-PATH** directory
37
39
- Open a terminal of your choice (e.g., gitBash)
38
40
- Execute the following bash command in the root folder (where the **Dockerfile** is located)
- 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`)
64
66
- 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):
66
68
```bash
67
69
sh copy_local.sh "D:\Work\xaml-docs"
68
70
```
69
71
70
-
- Go to the MY-REPO directory
72
+
- Go to the **DOCS-PATH** directory
71
73
- Open a terminal of your choice (e.g., gitBash)
72
74
- Install gems by executing `bundle install`
73
75
- 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`
104
106
105
107
### .gitignore is Always Modified
106
108
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.
0 commit comments