Merge pull request #200 from fossology/deps/docusaurus/3.1

deps(docu): upgrade to docusaurus 3.1

.github/workflows/deploy.yml

@@ -16,10 +16,13 @@ jobs:
     if: github.event_name != 'push'
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-node@v4
         with:
           node-version: 18
+          cache: yarn
       - name: Test Build
         run: |
           if [ -e yarn.lock ]; then
@@ -34,10 +37,13 @@ jobs:
     if: github.event_name != 'pull_request'
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-node@v4
         with:
           node-version: 18
+          cache: yarn
       - name: Build pages
         run: |
           # git config --global user.email "[email protected]"

docs/2021/buildsystem/build.md

@@ -40,12 +40,12 @@ Install CMake if you haven't already (minimum 3.10 required)
 
 | CMake Flags            | Description                  | Default     |
 | --- | --- | --- |
-| **-DCMAKE_INSTALL_PREFIX=<path\>** | Sets the install prefix. | `/usr/local` |
+| **-DCMAKE_INSTALL_PREFIX=\<path\>** | Sets the install prefix. | `/usr/local` |
 | **-DAGENTS="agent1;agent2..."** | Only configure these agents. | ALL AGENTS  |
-| **-DOFFLINE=<ON/OFF\>** | Controls vendor generation, ON=NO  | **OFF**     |
-| **-DCMAKE_BUILD_TYPE=<type\>** | -   `Debug`, `Release`, `RelWithDebInfo`,`MinSizeRel`     | `Debug` |
-| **-DTESTING=<ON/OFF\>** | Controls testing config generation    | **OFF**   |
-| **-DMONOPACK=<ON/OFF\>** | Package adj2nest and ununpack seperately        | **OFF**     |
+| **-DOFFLINE=\<ON/OFF\>** | Controls vendor generation, ON=NO  | **OFF**     |
+| **-DCMAKE_BUILD_TYPE=\<type\>** | -   `Debug`, `Release`, `RelWithDebInfo`,`MinSizeRel`     | `Debug` |
+| **-DTESTING=\<ON/OFF\>** | Controls testing config generation    | **OFF**   |
+| **-DMONOPACK=\<ON/OFF\>** | Package adj2nest and ununpack seperately        | **OFF**     |
 | **-GNinja**            | Use Ninja instead of Unix Makefiles   | *Unix MakeFiles*      |
 
 There are lots of inbuilt CMake command-line options you can see them in the official [documentation](https://cmake.org/cmake/help/v3.10/manual/cmake.1.html). Once you have chosen your flags we can now configure the project using the following commands.

docs/2021/buildsystem/final-evaluation.md

@@ -213,12 +213,12 @@ to use it as described below.
 
 | CMake Flags            | Description                  | Default     |
 | --- | --- | --- |
-| **-DCMAKE_INSTALL_PREFIX=<path\>** | Sets the install prefix. | `/usr/local` |
+| **-DCMAKE_INSTALL_PREFIX=\<path\>** | Sets the install prefix. | `/usr/local` |
 | **-DAGENTS="agent1;agent2..."** | Only configure these agents. | ALL AGENTS  |
-| **-DOFFLINE=<ON/OFF\>** | Controls vendor generation, ON=NO  | **OFF**     |
-| **-DCMAKE_BUILD_TYPE=<type\>** | -   `Debug`, `Release`, `RelWithDebInfo`,`MinSizeRel`     | `Debug` |
-| **-DTESTING=<ON/OFF\>** | Controls testing config generation    | **OFF**   |
-| **-DMONOPACK=<ON/OFF\>** | Package adj2nest and ununpack seperately        | **OFF**     |
+| **-DOFFLINE=\<ON/OFF\>** | Controls vendor generation, ON=NO  | **OFF**     |
+| **-DCMAKE_BUILD_TYPE=\<type\>** | -   `Debug`, `Release`, `RelWithDebInfo`,`MinSizeRel`     | `Debug` |
+| **-DTESTING=\<ON/OFF\>** | Controls testing config generation    | **OFF**   |
+| **-DMONOPACK=\<ON/OFF\>** | Package adj2nest and ununpack seperately        | **OFF**     |
 | **-GNinja**            | Use Ninja instead of Unix Makefiles   | *Unix MakeFiles*      |
 
 There are lots of inbuilt CMake command-line options you can see them in the official [documentation](https://cmake.org/cmake/help/v3.10/manual/cmake.1.html). Once you have chosen your flags we can now configure the project using the following commands.

docs/2021/copyrights/updates/2021-07-06.md

@@ -34,10 +34,10 @@ SPDX-FileCopyrightText: 2021 Kaushlendra Pratap <[email protected]
 * Solution was: (c) --> has been changed to "copyright" string and then it was fed to the algorithm, [Date] check has been implemented inside all the checks which individually helps as a final check before calling it a hit.
 * CSV provided by Michael contained 13lakh+ datasets that were not ideal to traverse through all of it once (Jupyter server crashed after continuous 10 hours running).
 * Divided the datasets into chunks of 10,000 and will traverse through it and check the ideal results on all over it.
-* Performance score was calculated {hitscore/No.of copyrights in list}*100, which came out as **82.65%**
+* Performance score was calculated \{hitscore/No.of copyrights in list\}*100, which came out as **82.65%**
 * Wiki has been Updated
 
 
 ### Conclusion and Further Plans
 
-Understanding the edge cases and calculating the accuracy score over True Positives.
+Understanding the edge cases and calculating the accuracy score over True Positives.

docs/2021/microservice/updates/2021-08-03.md

@@ -38,6 +38,6 @@ in [agent_disable](https://github.com/OmarAbdelSamea/fossology/blob/OmarAbdelSam
 ## End of the week results
 - modified UI to show only available agents during upload.
 - created fo_delete.sh to handle deployment deletion and scheduler config reload. 
-- finalized migrating fossology.conf and <agent_name>.conf to etcd and tested inside the cluster.
+- finalized migrating fossology.conf and \<agent_name\>.conf to etcd and tested inside the cluster.
 - started working on db conf to etcd.
 

docs/2021/minerva/updates/2021-06-15.md

@@ -22,7 +22,8 @@ SPDX-FileCopyrightText: 2021 Shreya Singh <[email protected]>
 
 ## Discussions
 1. To handle Regex expansion -  approaches were discussed. 
-2. The First approach was to generate random characters generated from .{0,30}. This was discarded because it won't provide semantic meaning to generated texts.
+2. The First approach was to generate random characters generated from .\{0,30\}. This was discarded because it won't 
+   provide semantic meaning to generated texts.
 3. Second, to skip the character generation portion but it will hamper similarity matching algorithms based on distances. So it was also discarded.
 4. Third approach to generate meaningful sentences using python library and licenses vocabulary.
 

docs/2022/GSoC-projects.md

@@ -21,7 +21,7 @@ We from the fossology project would like to apply for GSOC. Please see two main
 - https://www.fossology.org
 - https://fossology.github.io/gsoc/
 
-Meetings: Checkout the [Meetings table](/docs/2022/#meetings-table)
+Meetings: Checkout the [Meetings table](/docs/2022#meetings-table)
 
 ## Interested in Application? - Getting Grip
 

docs/2022/atarashi/updates/2022-06-20.md

@@ -45,24 +45,28 @@ GSOC 2022 weekly update
   Total files scanned = 100,
   Successfully matched = 55
 
-             ++++++++++++++++++ Result ++++++++++++++++++
-             ++++++++++++++++++++++++++++++++++++++++++++
-             ---> Total time elapsed: 6.29 Seconds  <---
-             ---> Accuracy: 55.0%                     <---
-             ++++++++++++++++++++++++++++++++++++++++++++
-             ++++++++++++++++++++++++++++++++++++++++++++
+    ```
+    ++++++++++++++++++ Result ++++++++++++++++++
+    ++++++++++++++++++++++++++++++++++++++++++++
+    ---> Total time elapsed: 6.29 Seconds  <---
+    ---> Accuracy: 55.0%                     <---
+    ++++++++++++++++++++++++++++++++++++++++++++
+    ++++++++++++++++++++++++++++++++++++++++++++
+    ```
 
 - Also the accuracy of previously implemented [LogisticRegression](https://scikit-learn.org/stable/modules/generated/sklearn.linear_model.LogisticRegression.html) is increased to **63 percent**.
 
   Total files scanned = 100,
   Successfully matched = 63
 
-             ++++++++++++++++++ Result ++++++++++++++++++
-             ++++++++++++++++++++++++++++++++++++++++++++
-             ---> Total time elapsed: 4.19 Seconds  <---
-             ---> Accuracy: 63.0%                     <---
-             ++++++++++++++++++++++++++++++++++++++++++++
-             ++++++++++++++++++++++++++++++++++++++++++++
+    ```
+    ++++++++++++++++++ Result ++++++++++++++++++
+    ++++++++++++++++++++++++++++++++++++++++++++
+    ---> Total time elapsed: 4.19 Seconds  <---
+    ---> Accuracy: 63.0%                     <---
+    ++++++++++++++++++++++++++++++++++++++++++++
+    ++++++++++++++++++++++++++++++++++++++++++++
+    ```
 
 - Raised one [PR](https://github.com/fossology/Minerva-Dataset-Generation/pull/4)
   on [Minerva](https://github.com/fossology/Minerva-Dataset-Generation) to add the

docs/2022/ui/updates/krishna/2022-07-17.md

@@ -32,7 +32,7 @@ SPDX-FileCopyrightText: 2022 Krishna Mahato <[email protected]>
   - Trying to re-use the methods that are already used in the static UI.
   - Testing the API via any API platform like **postman**.
 
-### PR Link : [feat(api): Added users/{id} PUT route to modify user details #2262](https://github.com/fossology/fossology/pull/2262)
+### PR Link : [feat(api): Added users/\{id\} PUT route to modify user details #2262](https://github.com/fossology/fossology/pull/2262)
 
 ## Testing the PR
 
@@ -54,7 +54,7 @@ SPDX-FileCopyrightText: 2022 Krishna Mahato <[email protected]>
   - Trying to re-use the methods that are already used in the static UI from the `user_edit` plugin.
   - Testing the API via any API platform like **postman**.
 
-### PR Link : [feat(api): added /users/tokens POST Route and /users/tokens/{type} GET Route #2266](https://github.com/fossology/fossology/pull/2266)
+### PR Link : [feat(api): added /users/tokens POST Route and /users/tokens/\{type\} GET Route #2266](https://github.com/fossology/fossology/pull/2266)
 
 ## Testing the PR
 

docs/2022/ui/updates/krishna/2022-08-14.md

@@ -79,7 +79,7 @@ I figured out the requirements of this API and designed the following :
 
 - Pull the changes from the above **PR**.
 - Use any API platform like **postman**.
-- Provide the `uploadId` in `params` ({id})
+- Provide the `uploadId` in `params` (`{id}`)
 
 - If your upload exists, you can expect a response like this.
   ![res-perm-groups](/img/reactUI/api/permGroupsRes.png)

docs/2022/ui/updates/krishna/2022-09-04.md

@@ -66,7 +66,7 @@ The API design is something like mentioned below
             $ref: '#/components/responses/defaultResponse'
 ```
 
-### API PR Link : [feat(API): /jobs/{id}/history GET route to get the history of all the jobs queued based on an upload #2307](https://github.com/fossology/fossology/pull/2307)
+### API PR Link : [feat(API): /jobs/\{id\}/history GET route to get the history of all the jobs queued based on an upload #2307](https://github.com/fossology/fossology/pull/2307)
 
 ## Testing `GET jobs/{id}/history`
 

docs/2023/GSoC-projects.md

@@ -22,7 +22,7 @@ resources for finding out more FOSSology in general:
 - https://www.fossology.org
 - https://fossology.github.io/gsoc/
 
-Meetings: Checkout the [Meetings table](/docs/2023/#meetings-table)
+Meetings: Checkout the [Meetings table](/docs/2023#meetings-table)
 
 ## Interested in Application? - Getting Grip
 

docs/2023/copyrights/updates/2023-09-13.md

@@ -33,10 +33,10 @@ SPDX-FileCopyrightText: 2023 Abdelrahman Jamal <[email protected]>
      * Below are some detection results using the dataset from the feature extraction paper to test on unseen examples (detected entities are highlighted):
        1. Copyright (C) 2017 `DENX Software Engineering`
        2. Copyright (C) `IBM Corporation` 2016
-       3. Copyright (c) 2000-2005 `Vojtech Pavlik` <[email protected]>
+       3. Copyright (c) 2000-2005 `Vojtech Pavlik` \<[email protected]\>
        4. Copyright (c) 2009, `Microsoft Corporation`.
        5. Copyright (C) ST-Ericsson 2010 - 2013 (Entity missed)
-       6. Copyright (c) 2012 `Steffen Trumtrar` <[email protected]>, `Pengutronix`
+       6. Copyright (c) 2012 `Steffen Trumtrar` \<[email protected]\>, `Pengutronix`
        7. Copyright 2008 `GE Intelligent Platforms Embedded Systems`, Inc.
      * The model detected the majority of entities, missing less than 5%.
      * Adopted semi-supervised training by using the preceding model to label the entire dataset and trained on it. This refined model, now in use, missed under 1% of the copyright holder entities in the same test set.

docs/2023/copyrights/updates/2023-10-18.md

@@ -34,13 +34,17 @@ SPDX-FileCopyrightText: 2023 Abdelrahman Jamal <[email protected]>
       2. `Copyright 2019 Ansible Project GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)`
       3. `(c) 2014, James Tanner <[email protected]>`
       4. `(c) 2017 Ansible Project GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) from __future__ import (absolute_import, division, print_function) metaclass__` = type
-      5. `(c) 2013, bleader Written by bleader <[email protected]> Based on` pkgin module written by Shaun Zinck  that was based on pacman module written by Afterburn <https://github.com/afterburn> that was based on apt module written by Matthew Williams <matthew@flowrout>
+      5. `(c) 2013, bleader Written by bleader <[email protected]> Based on` pkgin module written by Shaun Zinck 
+         that was based on pacman module written by Afterburn &lt;https://github.com/afterburn&gt; that was based on apt 
+         module written by Matthew Williams \<matthew@flowrout\>
    - **Cassandra**: Again, the model demonstrated varied performance. While it succeeded in some instances, it missed out on others, particularly the ones with repeated patterns:
       1. `(c) 2005, 2014 jQuery Foundation, Inc.` | jquery.org/license */
       2. `(c) Steven Levithan <stevenlevithan.com>` MIT License
       3. `Copyright 2005-2008 The Android Open Source Project This product includes software developed as part of The Android Open Source Project` (http://source.android.com).
       4. `Copyright © 2020 Jeff Carpenter, Eben Hewitt.` All rights reserved. Used with permission._ 
-      5. `Copyright &amp;copy; 2009- The Apache Software Foundation` " useexternalfile="yes" encoding="UTF-8" failonerror="false" maxmemory="256m" additionalparam="${jdk11plus-javadoc-exports}"> filesets/> javadoc> fail message="javadoc failed"> condition>
+      5. `Copyright &amp;copy; 2009- The Apache Software Foundation` " useexternalfile="yes" encoding="UTF-8" 
+         failonerror="false" maxmemory="256m" additionalparam="$\{jdk11plus-javadoc-exports\}"> filesets/> javadoc> 
+         fail message="javadoc failed"> condition>
       6. `© 2018 DataStax", "", "\n", "\0", "\0\0", "\001", "0", "0\0", "00", "1") forEach(stringConsumer)` 
       7. `copyright to Philip Koopman` , which he licenses under the Creative Commons Attribution 4.0 International License (https://creativecommons.org/licenses/by/4.0)
       8. `Copyright (c) 1998 Hewlett-Packard CompanydescsRGB IEC61966-2.1sRGB IEC61966-2.1XYZ óQ ÌXYZ XYZ o¢8õXYZ b·ÚXYZ $ ¶ÏdescIEC http://www.iec.chIEC`
@@ -61,4 +65,4 @@ SPDX-FileCopyrightText: 2023 Abdelrahman Jamal <[email protected]>
 
 ### 2. Documentation
 - Work on finilzating the weekly documentation as GSoC is coming to an end.
-- Start working on the GSoC final report.
+- Start working on the GSoC final report.

docusaurus.config.js

@@ -1,6 +1,3 @@
-const lightCodeTheme = require('prism-react-renderer/themes/github');
-const darkCodeTheme = require('prism-react-renderer/themes/dracula');
-
 /** @type {import('@docusaurus/types').DocusaurusConfig} */
 module.exports = {
   title: 'GSoC projects at FOSSology',
@@ -9,6 +6,7 @@ module.exports = {
   baseUrl: '/gsoc/',
   onBrokenLinks: 'throw',
   onBrokenMarkdownLinks: 'warn',
+  onBrokenAnchors: 'throw',
   favicon: 'img/favicon.ico',
   organizationName: 'fossology',
   projectName: 'gsoc',
@@ -149,7 +147,7 @@ module.exports = {
           items: [
             {
               label: 'YouTube',
-              href: 'https://www.youtube.com/channel/UCZGPJnQZVnEPQWxOuNamLpw',
+              href: 'https://www.youtube.com/@fossology',
             },
             {
               label: 'Installing FOSSology',
@@ -164,10 +162,12 @@ module.exports = {
       ],
       copyright: `Copyright © 2021 - ${new Date().getFullYear()} FOSSology project. Built with Docusaurus.`,
     },
-    prism: {
-      theme: lightCodeTheme,
-      darkTheme: darkCodeTheme,
+    colorMode: {
+      defaultMode: 'light',
+      disableSwitch: false,
+      respectPrefersColorScheme: false,
     },
+    image: 'img/logo.png',
   },
   presets: [
     [

package.json

@@ -1,6 +1,6 @@
 {
   "name": "gosc",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "private": true,
   "scripts": {
     "docusaurus": "docusaurus",
@@ -14,15 +14,15 @@
     "write-heading-ids": "docusaurus write-heading-ids"
   },
   "dependencies": {
-    "@docusaurus/core": "^2.4.0",
-    "@docusaurus/preset-classic": "^2.4.0",
-    "@mdx-js/react": "^1.6.21",
+    "@docusaurus/core": "^3.1.0",
+    "@docusaurus/preset-classic": "^3.1.0",
+    "@mdx-js/react": "^3.0.0",
     "@svgr/webpack": "^5.5.0",
     "clsx": "^1.1.1",
     "file-loader": "^6.2.0",
-    "prism-react-renderer": "^1.2.1",
-    "react": "^17.0.1",
-    "react-dom": "^17.0.1",
+    "prism-react-renderer": "^2.1.0",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
     "react-responsive-carousel": "^3.2.21",
     "url-loader": "^4.1.1"
   },
@@ -37,5 +37,8 @@
       "last 1 firefox version",
       "last 1 safari version"
     ]
+  },
+  "engines": {
+    "node": ">=18.0"
   }
 }