Skip to content

Commit 4e776b9

Browse files
committed
update docs engine development guides
1 parent 0dd348c commit 4e776b9

File tree

2 files changed

+26
-34
lines changed

2 files changed

+26
-34
lines changed

products/docs-engine/src/content/contributing/development-setup.md

Lines changed: 13 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -16,34 +16,23 @@ The content below is here for completeness, and describes the theoretical way to
1616

1717
The basic steps for setting up a development are as follows.
1818

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).
2020

21-
```sh
22-
~/ $ git clone [email protected]:cloudflare/cloudflare-docs-engine.git
23-
~/ $ git clone [email protected]:example-username/my-docs-content.git
24-
```
25-
26-
2. `cd` into `cloudflare-docs-engine`, run `npm link`, then return to the parent directory.
21+
2. Clone the docs content repo (`@username/my-docs-content` below):
2722

2823
```sh
29-
~/ $ cd cloudflare-docs-engine
30-
~/cloudflare-docs-engine $ npm link
31-
~/cloudflare-docs-engine $ cd ..
24+
~/ $ git clone [email protected]:cloudflare/cloudflare-docs-engine.git
25+
~/ $ git clone [email protected]:username/my-docs-content.git
3226
```
3327

34-
3. `cd` into `my-docs-content`:
28+
3. `cd` into `my-docs-content` and run `npm install`:
3529

3630
```sh
3731
~/ $ cd my-docs-content
32+
~/my-docs-content $ npm install
3833
```
3934

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):
4736

4837
```sh
4938
~/my-docs-content $ npm run bootstrap
@@ -59,8 +48,12 @@ The basic steps for setting up a development are as follows.
5948

6049
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.
6150

62-
<Aside>
51+
<Aside header="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).
6356

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`.
6558

6659
</Aside>

products/docs-engine/src/content/how-to-guides/migrate-a-product.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -37,46 +37,45 @@ You can view its corresponding `Test` column link to see what your project looks
3737

3838
The next thing you’ll want to do is get a local development setup going.
3939

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:
4143

4244
```sh
43-
~/ $ git clone [email protected]:cloudflare/cloudflare-docs-engine.git
44-
~/ $ git clone [email protected]:cloudflare/cloudflare-docs.git
45+
~/ $ git clone [email protected]:username/cloudflare-docs.git
4546
```
4647

47-
2. `cd` into `cloudflare-docs-engine`, run `npm link`, then return to the parent directory.
48+
<Aside>
4849

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>
5453

5554
3. `cd` into your project’s folder (e.g. `spectrum`) inside `cloudflare-docs`:
5655

5756
```sh
5857
~/ $ cd cloudflare-docs/products/spectrum
5958
```
6059

61-
5. Inside your project’s folder, link the engine:
60+
4. Run `npm install`:
6261

6362
```sh
64-
~/cloudflare-docs/products/spectrum $ npm link cloudfare-docs-engine
63+
~/cloudflare-docs/products/spectrum $ npm install
6564
```
6665

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):
6867

6968
```sh
7069
~/cloudflare-docs/products/spectrum $ npm run bootstrap
7170
```
7271

73-
7. Run the local development server:
72+
6. Run the local development server:
7473

7574
```sh
7675
~/cloudflare-docs/products/spectrum $ npm run develop
7776
```
7877

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.
8079

8180
## Step 3: Make changes
8281

0 commit comments

Comments
 (0)