Switch to yarn-based Docusaurus (#98)

* Switch to yarn-based Docusaurus * Update CI/CD
QubitPi · Nov 28, 2023 · ff9854b · ff9854b
1 parent 473235d
commit ff9854b
Show file tree

Hide file tree

Showing 8 changed files with 12,068 additions and 14,924 deletions.
diff --git a/.github/workflows/ci-cd.yml b/.github/workflows/ci-cd.yml
@@ -74,8 +74,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
       - uses: actions/setup-node@v3
         with:
           node-version: 18
@@ -99,10 +97,10 @@ jobs:
           data-model-package-repo-url: N/A
       - name: Install dependencies
         working-directory: docs
-        run: npm install
+        run: yarn
       - name: Build documentations
         working-directory: docs
-        run: npm run build
+        run: yarn build
       - name: Generate Javadoc
         run: mvn -B clean javadoc:javadoc
       - name: Move Javadoc into documentation directory

diff --git a/docs/.gitignore b/docs/.gitignore
@@ -1,3 +1,17 @@
+# Copyright Jiaqi Liu
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 # Dependencies
 /node_modules
 
@@ -9,6 +23,7 @@
 .cache-loader
 
 # Misc
+.idea/
 .DS_Store
 .env.local
 .env.development.local
@@ -18,3 +33,11 @@
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
+
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions
diff --git a/docs/docs/development.md b/docs/docs/development.md
@@ -138,7 +138,7 @@ For JDK **17**, which is the version JWT runs on, it's been tested that Jetty _1
 ["11.0.15" release](https://repo1.maven.org/maven2/org/eclipse/jetty/jetty-home/11.0.15/jetty-home-11.0.15.tar.gz) as
 an example:
 
-![Error loading download-jetty.png](./img/download-jetty.png)
+![Error loading download-jetty.png](img/download-jetty.png)
 
 Put the `tar.gz` file into a location of your choice as the installation path and extract the Jetty binary using
 

diff --git a/docs/docs/elide.md b/docs/docs/elide.md
@@ -38,7 +38,7 @@ otherwise, dependency injection will flaky and not right.
 
 :::
 
-![Error loading resource-binding.png](./img/resource-binding.png)
+![Error loading resource-binding.png](img/resource-binding.png)
 
 Setup
 -----
@@ -158,7 +158,7 @@ with a corresponding `~/.m2/settings.xml`:
 Lastly, if IntelliJ IDE is used for development, please make sure to let IDE pick up the `~/.m2/settings.xml` by
 unchecking the _Use settings from .mvn/maven.config_:
 
-![Error loading load-m2-settings.png](./img/load-m2-settings.png)
+![Error loading load-m2-settings.png](img/load-m2-settings.png)
 
 ### Step 2: Spinning Up Docker Compose
 
@@ -174,7 +174,7 @@ to run this Docker Compose in production!_
 
 :::
 
-![Error Loading docker-compose.png](./img/docker-compose.png)
+![Error Loading docker-compose.png](img/docker-compose.png)
 
 Simply run:
 
@@ -273,7 +273,7 @@ mutation {
 }
 ```
 
-![Error loading graphiql-mutation-example.png](./img/graphiql-mutation-example.png)
+![Error loading graphiql-mutation-example.png](img/graphiql-mutation-example.png)
 
 We can create few more books, sort and paginate them with:
 
@@ -375,7 +375,7 @@ export class Client {
 }
 ```
 
-![Error loading graphiql-query-example.png](./img/graphiql-query-example.png)
+![Error loading graphiql-query-example.png](img/graphiql-query-example.png)
 
 [AWS EC2 min size]: https://img.shields.io/badge/EC2-%E2%89%A5t2.small-FF9902?style=for-the-badge&logo=amazonec2&logoColor=white
 

diff --git a/docs/docs/security.md b/docs/docs/security.md
@@ -64,7 +64,7 @@ like the following
 
 :::
 
-![Error loading oauth2-filtering.png](./img/oauth2-filtering.png)
+![Error loading oauth2-filtering.png](img/oauth2-filtering.png)
 
 To define a token validator, simply implement the **AccessTokenValidator** like so:
 

diff --git a/docs/docs/sentry.md b/docs/docs/sentry.md
@@ -32,9 +32,9 @@ matters, solve quicker, and learn continuously about their applications.
 The logging framework has to be <b>Logback</b>, which is the logging library used in
 [jersey-webservice-template][jersey-webservice-template]
 
-![Error loading setup-sentry-1.png](./img/setup-sentry-1.png)
-![Error loading setup-sentry-2.png](./img/setup-sentry-2.png)
-![Error loading setup-sentry-3.png](./img/setup-sentry-3.png)
+![Error loading setup-sentry-1.png](img/setup-sentry-1.png)
+![Error loading setup-sentry-2.png](img/setup-sentry-2.png)
+![Error loading setup-sentry-3.png](img/setup-sentry-3.png)
 
 :::
-Original file line number
+Diff line change
@@ Expand Up / @@ -64,7 +64,7 @@ like the following @@
     :::
-    ![Error loading oauth2-filtering.png](./img/oauth2-filtering.png)
+    ![Error loading oauth2-filtering.png](img/oauth2-filtering.png)
     To define a token validator, simply implement the **AccessTokenValidator** like so:
@@ Expand Down @@