Skip to content

Commit 2877320

Browse files
JKHeadleyJKHeadley
authored
Upgrade docusaurus (#304)
* chore: initial migration * chore: delete v2 website * chore: update docs for v3.0.x * test ci * test ci * test ci * test ci * test ci * test ci * test ci * test ci * test ci * test ci * test ci * test ci * chore: revert manual ci
1 parent 31cfefd commit 2877320

File tree

9 files changed

+91
-10
lines changed

9 files changed

+91
-10
lines changed

‎docs/quick-start.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ sidebar_label: Quick Start
66

77
## Requirements
88

9-
You need [Node.js](https://nodejs.org/en/) ^12.14.1 installed and you'll need [MongoDB](https://docs.mongodb.com/manual/installation/) installed and running.
9+
You need [Node.js](https://nodejs.org/en/) >= 14 installed and you'll need [MongoDB](https://docs.mongodb.com/manual/installation/) installed and running.
1010

1111
## Demo
1212

‎website/i18n/en.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -248,6 +248,10 @@
248248
"version-2.3.x/version-2.3.x-configuration": {
249249
"title": "Configuration",
250250
"sidebar_label": "Configuration"
251+
},
252+
"version-3.0.x/version-3.0.x-quick-start": {
253+
"title": "Quick Start",
254+
"sidebar_label": "Quick Start"
251255
}
252256
},
253257
"links": {

‎website/package-lock.json

Lines changed: 3 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎website/package.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
"rename-version": "docusaurus-rename-version"
1010
},
1111
"devDependencies": {
12-
"docusaurus": "^1.13.0"
13-
}
12+
"docusaurus": "^1.14.7"
13+
},
14+
"version": "3.0.0"
1415
}

‎website/pages/en/versions.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ class Versions extends React.Component {
7272
</tr>
7373
</tbody>
7474
</table>
75-
<p>Other text describing this section.</p>
75+
<p>These are the docs for upcoming versions.</p>
7676
<h3 id="archive">Past Versions</h3>
7777
<table className="versions">
7878
<tbody>
@@ -96,7 +96,7 @@ class Versions extends React.Component {
9696
</tbody>
9797
</table>
9898
<p>
99-
You can find past versions of this project <a href="https://github.com/">
99+
You can find past versions of this project <a href="https://github.com/JKHeadley/rest-hapi">
100100
{' '}
101101
on GitHub{' '}
102102
</a>.

‎website/sidebars.json

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,5 @@
2828
"questions",
2929
"support"
3030
]
31-
},
32-
"docs-other": {
33-
"First Category": ["doc4", "doc5"]
3431
}
3532
}

‎website/versioned_docs/version-3.0.x/quick-start.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
id: version-3.0.x-quick-start
3+
title: Quick Start
4+
sidebar_label: Quick Start
5+
original_id: quick-start
6+
---
7+
8+
## Requirements
9+
10+
You need [Node.js](https://nodejs.org/en/) >= 14 installed and you'll need [MongoDB](https://docs.mongodb.com/manual/installation/) installed and running.
11+
12+
## Demo
13+
14+
![rest-hapi-demo-alt](https://user-images.githubusercontent.com/12631935/41813206-0d2298a0-76e6-11e8-95d4-9b1e521c179e.gif)
15+
16+
The quickest way to get rest-hapi running on your machine is with the [rest-hapi-demo](https://github.com/JKHeadley/rest-hapi-demo) project:
17+
18+
(**NOTE:** For an alternative quick start, check out his [awesome yeoman generator](https://github.com/vinaybedre/generator-resthapi) for rest-hapi.)
19+
20+
1) Clone the repo
21+
```sh
22+
$ git clone https://github.com/JKHeadley/rest-hapi-demo.git
23+
$ cd rest-hapi-demo
24+
```
25+
26+
2) Install the dependencies
27+
```sh
28+
$ npm install
29+
```
30+
31+
3) Seed the models
32+
```sh
33+
$ ./node_modules/.bin/rest-hapi-cli seed
34+
```
35+
36+
4) Start the server
37+
```sh
38+
$ npm start
39+
```
40+
41+
5) View the [API docs](swagger-documentation.md) at
42+
43+
[http://localhost:8080/](http://localhost:8080/)
44+
45+
...have fun!

‎website/versioned_sidebars/version-3.0.x-sidebars.json

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
{
2+
"version-3.0.x-docs": {
3+
"Getting Started": [
4+
"version-3.0.x-quick-start",
5+
"version-3.0.x-introduction",
6+
"version-3.0.x-swagger-documentation"
7+
],
8+
"Usage": [
9+
"version-3.0.x-configuration",
10+
"version-3.0.x-creating-endpoints",
11+
"version-3.0.x-associations",
12+
"version-3.0.x-route-customization",
13+
"version-3.0.x-querying",
14+
"version-3.0.x-duplicate-fields",
15+
"version-3.0.x-validation",
16+
"version-3.0.x-middleware",
17+
"version-3.0.x-authentication",
18+
"version-3.0.x-authorization",
19+
"version-3.0.x-audit-logs",
20+
"version-3.0.x-policies",
21+
"version-3.0.x-mongoose-wrapper-methods",
22+
"version-3.0.x-soft-delete",
23+
"version-3.0.x-metadata",
24+
"version-3.0.x-model-generation"
25+
],
26+
"Other": [
27+
"version-3.0.x-testing",
28+
"version-3.0.x-questions",
29+
"version-3.0.x-support"
30+
]
31+
}
32+
}

‎website/yarn.lock

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2499,7 +2499,7 @@
24992499
"resolved" "https://registry.npmjs.org/discontinuous-range/-/discontinuous-range-1.0.0.tgz"
25002500
"version" "1.0.0"
25012501

2502-
"docusaurus@^1.13.0":
2502+
"docusaurus@^1.14.7":
25032503
"integrity" "sha512-UWqar4ZX0lEcpLc5Tg+MwZ2jhF/1n1toCQRSeoxDON/D+E9ToLr+vTRFVMP/Tk84NXSVjZFRlrjWwM2pXzvLsQ=="
25042504
"resolved" "https://registry.npmjs.org/docusaurus/-/docusaurus-1.14.7.tgz"
25052505
"version" "1.14.7"

0 commit comments

Comments
 (0)