Updated project website

weso · Mar 3, 2022 · cf51dd7 · cf51dd7
1 parent a49531f
commit cf51dd7
Show file tree

Hide file tree

Showing 7 changed files with 142 additions and 304 deletions.
diff --git a/build.sbt b/build.sbt
@@ -101,7 +101,8 @@ lazy val mdocSettings = Seq(
     "CLIENT_NAME"            -> "RDFShape Client",
     "CLIENT_REPO"            -> "https://github.com/weso/rdfshape-client/",
     "CLIENT_URL"             -> "https://rdfshape.weso.es/",
-    "WESOLOCAL_URL"          -> "https://github.com/weso/wesolocal/wiki/RDFShape"
+    "WESOLOCAL_URL"          -> "https://github.com/weso/wesolocal/wiki/RDFShape",
+    "API-DOCS_URL"           -> "https://app.swaggerhub.com/apis-docs/weso/RDFShape"
   ),
   mdocExtraArguments := Seq("--no-link-hygiene"),
   /* When creating/publishing the docusaurus site, update the dynamic mdoc and

diff --git a/docs/api-usage/usage_cli.md b/docs/api-usage/usage_cli.md
@@ -9,10 +9,10 @@ title: Command Line Interface
 
 @APP_NAME@'s CLI currently supports the following launch-arguments:
 
-- `--https` Attempt to serve the API via HTTPS (defaults to false), searching for certificates as specified in the
-  current environment.
-- `-p, --port`  Port in which the API will listen for requests. Values must be in range 1-65535 (defaults to 8080).
-- `-v, --verbose` Show additional logging information (use cumulative times for additional info, like: `-vvv`)
+- `--https` Attempt to serve the API via HTTPS (default is false), searching for certificates as specified in the current environment.
+- `-p, --port`  Port in which the API will listen for requests. Values must be in range 1-65535 (default is 8080).
+- `-s, --silent`  Enable silent mode in order not to log any output to console (default is false)
+- `-v, --verbose` Show additional logging information (use cumulative times for additional info, like: `-vvv`) 
 - `--version` Print the version of the program
 - `--help` Print the help menu
 

diff --git a/docs/api-usage/usage_examples.md b/docs/api-usage/usage_examples.md
diff --git a/docs/api-usage/usage_tutorial.md b/docs/api-usage/usage_tutorial.md
diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js
@@ -1,6 +1,7 @@
 const deployUrl = "https://weso.github.io"
 const baseUrl = "/rdfshape-api/"
-const docsUrl = `${deployUrl}${baseUrl}api/es/weso/rdfshape/`
+const scalaDocUrl = `${deployUrl}${baseUrl}api/es/weso/rdfshape/`
+const apiDocsUrl = "https://app.swaggerhub.com/apis-docs/weso/RDFShape/"
 
 /** @type {import('@docusaurus/types').DocusaurusConfig} */
 module.exports = {
@@ -15,12 +16,10 @@ module.exports = {
   favicon: "favicon.ico",
   trailingSlash: true,
   customFields: {
-    docsUrl,
+    scalaDocUrl, apiDocsUrl
   },
   themeConfig: {
-    image: "img/preview.png",
-    hideableSidebar: false,
-    colorMode: {
+    image: "img/preview.png", hideableSidebar: false, colorMode: {
       defaultMode: "light",
       disableSwitch: false,
       respectPrefersColorScheme: true,
@@ -30,99 +29,61 @@ module.exports = {
         darkIconStyle: {marginLeft: "2px"},
         lightIconStyle: {marginLeft: "1px"},
       },
-    },
-    navbar: {
-      title: "RDFShape API",
-      logo: {
-        alt: "RDFShape API - WESO",
-        src: "img/logo-weso.png",
-      },
-      items: [
-        // Web docs
+    }, navbar: {
+      title: "RDFShape API", logo: {
+        alt: "RDFShape API - WESO", src: "img/logo-weso.png",
+      }, items: [// Web docs
+        {
+          to: "/docs", label: "Web docs", position: "left",
+        }, // Scaladoc
         {
-          to: "/docs",
-          label: "Web docs",
-          position: "left",
-        },
-        // Scaladoc
+          to: scalaDocUrl, label: "Scaladoc", position: "left",
+        }, // API Docs in SwaggerHub
         {
-          to: docsUrl,
-          label: "Scaladoc",
-          position: "left",
-        },
-        // Link to repo
+          href: "https://github.com/weso/rdfshape-api",
+          label: "SwaggerHub",
+          position: "right",
+        }, // Link to repo
         {
           href: "https://github.com/weso/rdfshape-api",
           label: "GitHub",
           position: "right",
-        },
-      ],
-    },
-    footer: {
+        },],
+    }, footer: {
       style: "light",
       logo: {
         alt: "RDFShape API - WESO",
         src: "img/logo-weso-footer.png",
         href: "https://www.weso.es/",
       },
-      links: [
-        {
-          title: "About us",
-          items: [
-            {
-              label: "WESO Research Group",
-              to: "https://www.weso.es/",
-            },
-            {
-              label: "University of Oviedo",
-              to: "https://www.uniovi.es/",
-            },
-          ],
-        },
-        {
-          title: "Community",
-          items: [
-            {
-              label: "GitHub",
-              to: "https://github.com/weso",
-            },
-            {
-              label: "Twitter",
-              to: "https://twitter.com/wesoviedo",
-            },
-          ],
-        },
-        {
-          title: "Further work",
-          items: [
-            {
-              label: "RDFShape project",
-              to: "https://github.com/weso/rdfshape",
-            },
-            {
-              label: "More software by WESO",
-              to: "https://www.weso.es/#software",
-            },
-          ],
-        },
-      ],
+      links: [{
+        title: "About us", items: [{
+          label: "WESO Research Group", to: "https://www.weso.es/",
+        }, {
+          label: "University of Oviedo", to: "https://www.uniovi.es/",
+        },],
+      }, {
+        title: "Community", items: [{
+          label: "GitHub", to: "https://github.com/weso",
+        }, {
+          label: "Twitter", to: "https://twitter.com/wesoviedo",
+        },],
+      }, {
+        title: "Further work", items: [{
+          label: "RDFShape project", to: "https://github.com/weso/rdfshape",
+        }, {
+          label: "More software by WESO", to: "https://www.weso.es/#software",
+        },],
+      },],
       copyright: `Copyright © ${new Date().getFullYear()} WESO Research Group`,
     },
   },
-  presets: [
-    [
-      "@docusaurus/preset-classic",
-      {
-        docs: {
-          path: "../rdfshape-docs/target/mdoc",
-          sidebarPath: require.resolve("./sidebars.js"),
-        },
-        blog: false,
-        theme: {
-          customCss: require.resolve("./src/css/custom.css"),
-        },
-        sitemap: {},
-      },
-    ],
-  ],
+  presets: [["@docusaurus/preset-classic", {
+    docs: {
+      path: "../rdfshape-docs/target/mdoc",
+      sidebarPath: require.resolve("./sidebars.js"),
+    }, blog: false, theme: {
+      customCss: require.resolve("./src/css/custom.css"),
+    }, sitemap: {},
+  },],],
 };