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: products/docs-engine/src/content/contributing/development-setup.md
+13-20Lines changed: 13 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,34 +16,23 @@ The content below is here for completeness, and describes the theoretical way to
16
16
17
17
The basic steps for setting up a development are as follows.
18
18
19
-
1.Clone [@cloudflare/cloudflare-docs-engine](http://github.com/cloudflare/cloudflare-docs-engine) and your repo (`@example-username/my-docs-content` below):
19
+
1.Ensure you’re running node version `>=12.0.0`, as [specified by Docs Engine](https://github.com/cloudflare/cloudflare-docs-engine/blob/765bc30127b0e80b570aade7044036925928c3ea/package.json#L50).
3.`cd` into `my-docs-content` and run `npm install`:
35
29
36
30
```sh
37
31
~/ $ cd my-docs-content
32
+
~/my-docs-content $ npm install
38
33
```
39
34
40
-
5. Inside your project’s folder, link the engine:
41
-
42
-
```sh
43
-
~/my-docs-content $ npm link cloudfare-docs-engine
44
-
```
45
-
46
-
6. Run the engine’s [`bootstrap` command](https://github.com/cloudflare/cloudflare-docs-engine/blob/765bc30127b0e80b570aade7044036925928c3ea/bin/commands.sh#L19-L39):
35
+
4. Run the engine’s [`bootstrap` command](https://github.com/cloudflare/cloudflare-docs-engine/blob/765bc30127b0e80b570aade7044036925928c3ea/bin/commands.sh#L19-L39):
47
36
48
37
```sh
49
38
~/my-docs-content $ npm run bootstrap
@@ -59,8 +48,12 @@ The basic steps for setting up a development are as follows.
59
48
60
49
At this point, you can make changes to the Markdown files inside the contect directory (e.g. `my-docs-content/src/content`) to improve your docs site.
61
50
62
-
<Aside>
51
+
<Asideheader="Note">
52
+
53
+
Unfortunately, for now you’ll need to stop and restart `npm run develop` every time you make changes.
54
+
55
+
This is something we’d like to fix and can be tracked [in this Github issue](https://github.com/cloudflare/cloudflare-docs-engine/issues/279).
63
56
64
-
__Note:__ Unfortunately, for now you’ll need to stop and restart `npm run develop` every time you make changes. This is something we’re urgently looking to fix and can be tracked [in this Github issue](https://github.com/cloudflare/cloudflare-docs-engine/issues/279), which also includes a workaround which may help in the interim.
57
+
The workaround (noted in the issue) is to make your changes inside `.docs/src/content` instead. When you’re done you can run `npm run savechanges` (inside the project directory) and that will copy the contents of `.docs/src/content` into `src/content`.
Copy file name to clipboardExpand all lines: products/docs-engine/src/content/how-to-guides/migrate-a-product.md
+13-14Lines changed: 13 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -37,46 +37,45 @@ You can view its corresponding `Test` column link to see what your project looks
37
37
38
38
The next thing you’ll want to do is get a local development setup going.
39
39
40
-
1. Clone [@cloudflare/cloudflare-docs-engine](http://github.com/cloudflare/cloudflare-docs-engine) and [@cloudflare/cloudflare-docs](http://github.com/cloudflare/cloudflare-docs):
40
+
1. Ensure you’re running node version `>=12.0.0`, as [specified by Docs Engine](https://github.com/cloudflare/cloudflare-docs-engine/blob/765bc30127b0e80b570aade7044036925928c3ea/package.json#L50).
41
+
42
+
2. Fork [@cloudflare/cloudflare-docs](http://github.com/cloudflare/cloudflare-docs) on Github and clone your fork:
2.`cd` into `cloudflare-docs-engine`, run `npm link`, then return to the parent directory.
48
+
<Aside>
48
49
49
-
```sh
50
-
~/ $ cd cloudflare-docs-engine
51
-
~/cloudflare-docs-engine $ npm link
52
-
~/cloudflare-docs-engine $ cd ..
53
-
```
50
+
__Note:__ If you have write permissions on @cloudflare/cloudflare-docs you can clone that directly.
51
+
52
+
</Aside>
54
53
55
54
3.`cd` into your project’s folder (e.g. `spectrum`) inside `cloudflare-docs`:
56
55
57
56
```sh
58
57
~/ $ cd cloudflare-docs/products/spectrum
59
58
```
60
59
61
-
5. Inside your project’s folder, link the engine:
60
+
4. Run `npm install`:
62
61
63
62
```sh
64
-
~/cloudflare-docs/products/spectrum $ npm link cloudfare-docs-engine
63
+
~/cloudflare-docs/products/spectrum $ npm install
65
64
```
66
65
67
-
6. Run the engine’s [`bootstrap` command](https://github.com/cloudflare/cloudflare-docs-engine/blob/765bc30127b0e80b570aade7044036925928c3ea/bin/commands.sh#L19-L39):
66
+
5. Run the engine’s [`bootstrap` command](https://github.com/cloudflare/cloudflare-docs-engine/blob/765bc30127b0e80b570aade7044036925928c3ea/bin/commands.sh#L19-L39):
68
67
69
68
```sh
70
69
~/cloudflare-docs/products/spectrum $ npm run bootstrap
71
70
```
72
71
73
-
7. Run the local development server:
72
+
6. Run the local development server:
74
73
75
74
```sh
76
75
~/cloudflare-docs/products/spectrum $ npm run develop
77
76
```
78
77
79
-
8. Open up `localhost:8000` in your browser to see your docs site.
78
+
7. Open up `localhost:8000` in your browser to see your docs site.
0 commit comments