Merge pull request #66 from NYU-ITS/feature/setup-linting-formatting

Fix Code Quality Issues

.vscode/tasks.json

@@ -1,15 +1,13 @@
 {
-    // See https://go.microsoft.com/fwlink/?LinkId=733558
-    // for the documentation about the tasks.json format
-    "version": "2.0.0",
-    "tasks": [
-        {
-            "label": "pnpm-serve",
-            "type": "shell",
-            "command": "pixi run serve",
-            "problemMatcher": [
-                "$eslint-compact"
-            ]
-        }
-    ]
-}
+  // See https://go.microsoft.com/fwlink/?LinkId=733558
+  // for the documentation about the tasks.json format
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "pnpm-serve",
+      "type": "shell",
+      "command": "pixi run serve",
+      "problemMatcher": ["$eslint-compact"]
+    }
+  ]
+}

babel.config.mjs

@@ -0,0 +1,7 @@
+import preset from "@docusaurus/core/lib/babel/preset";
+
+const babelConfig = {
+  presets: [preset],
+};
+
+export default babelConfig;

blog/authors.yml

@@ -15,7 +15,7 @@ slorber:
   image_url: https://github.com/slorber.png
   page:
     # customize the url of the author page at /blog/authors/<permalink>
-    permalink: '/all-sebastien-lorber-articles'
+    permalink: "/all-sebastien-lorber-articles"
   socials:
     x: sebastienlorber
     linkedin: sebastienlorber

docs/hpc/01_getting_started/_category_.json

@@ -1,3 +1,3 @@
 {
-  "label": "Getting Started",
+  "label": "Getting Started"
 }

docs/hpc/02_connecting_to_hpc/_category_.json

@@ -1,3 +1,3 @@
 {
-  "label": "Setup",
+  "label": "Setup"
 }

docs/hpc/03_storage/_category_.json

@@ -1,3 +1,3 @@
 {
-  "label": "Storage & Data transfers",
+  "label": "Storage & Data transfers"
 }

docs/hpc/04_datasets/_category_.json

@@ -1,3 +1,3 @@
 {
-  "label": "Datasets",
+  "label": "Datasets"
 }

docs/hpc/05_submitting_jobs/_category_.json

@@ -1,3 +1,3 @@
 {
-  "label": "Submitting jobs",
+  "label": "Submitting jobs"
 }

docs/hpc/06_tools_and_software/_category_.json

@@ -1,3 +1,3 @@
 {
-  "label": "Tools & Software available",
+  "label": "Tools & Software available"
 }

docs/hpc/07_containers/_category_.json

@@ -1,3 +1,3 @@
 {
-  "label": "Containers",
+  "label": "Containers"
 }

docs/hpc/08_ml_ai_hpc/_category_.json

@@ -1,3 +1,3 @@
 {
-  "label": "ML/AI on HPC",
+  "label": "ML/AI on HPC"
 }

docs/hpc/09_ood/_category_.json

@@ -1,3 +1,3 @@
 {
-  "label": "Open OnDemand",
+  "label": "Open OnDemand"
 }

docs/hpc/10_tutorials/_category_.json

@@ -1,3 +1,3 @@
 {
-  "label": "Tutorials from old website",
+  "label": "Tutorials from old website"
 }

docs/hpc/11_training_and_support/_category_.json

@@ -1,3 +1,3 @@
 {
-  "label": "Training and Support",
+  "label": "Training and Support"
 }

docs/srde/01_getting_started/_category_.json

@@ -1,3 +1,3 @@
 {
-  "label": "Getting Started",
+  "label": "Getting Started"
 }

docs/srde/02_user_guide/_category_.json

@@ -1,3 +1,3 @@
 {
-  "label": "User Guide",
+  "label": "User Guide"
 }

docs/srde/03_dlp/_category_.json

@@ -1,3 +1,3 @@
 {
-  "label": "Data Loss Prevention",
+  "label": "Data Loss Prevention"
 }

docs/srde/05_support/_category_.json

@@ -1,3 +1,3 @@
 {
-  "label": "Support",
+  "label": "Support"
 }

docusaurus.config.ts

@@ -1,33 +1,33 @@
-import { themes as prismThemes } from 'prism-react-renderer';
-import type { Config } from '@docusaurus/types';
-import type * as Preset from '@docusaurus/preset-classic';
+import type * as Preset from "@docusaurus/preset-classic";
+import { type Config } from "@docusaurus/types";
+import { themes as prismThemes } from "prism-react-renderer";
 
 // Set the /<baseUrl>/ pathname under which your site is served
 // For GitHub pages deployment, it is often '/<projectName>/'
-let baseUrl = '/rts-docs-dev/';
+let baseUrl = "/rts-docs-dev/";
 if (process.env.PREVIEW_PATH) {
   baseUrl += process.env.PREVIEW_PATH;
 }
-  
+
 const config: Config = {
-  title: 'Research Technology Servcies',
-  tagline: 'NYU',
-  favicon: 'img/NYU.ico',
+  title: "Research Technology Servcies",
+  tagline: "NYU",
+  favicon: "img/NYU.ico",
 
   // Set the production url of your site here
-  url: 'https://your-docusaurus-site.example.com',
+  url: "https://your-docusaurus-site.example.com",
   // Set the /<baseUrl>/ pathname under which your site is served
   // For GitHub pages deployment, it is often '/<projectName>/'
   baseUrl: baseUrl,
 
   // GitHub pages deployment config.
   // If you aren't using GitHub pages, you don't need these.
-  organizationName: 'NYU-ITS', // Usually your GitHub org/user name.
-  projectName: 'rts-docs-dev', // Usually your repo name.
-  deploymentBranch: 'main',
+  organizationName: "NYU-ITS", // Usually your GitHub org/user name.
+  projectName: "rts-docs-dev", // Usually your repo name.
+  deploymentBranch: "main",
 
-  onBrokenLinks: 'throw',
-  onBrokenMarkdownLinks: 'warn',
+  onBrokenLinks: "throw",
+  onBrokenMarkdownLinks: "warn",
 
   //https://docusaurus.io/docs/deployment#docusaurusconfigjs-settings
   trailingSlash: true,
@@ -36,106 +36,104 @@ const config: Config = {
   // useful metadata like html lang. For example, if your site is Chinese, you
   // may want to replace "en" with "zh-Hans".
   i18n: {
-    defaultLocale: 'en',
-    locales: ['en'],
+    defaultLocale: "en",
+    locales: ["en"],
   },
 
   presets: [
     [
-      'classic',
+      "classic",
       {
         docs: {
-          sidebarPath: './sidebars.ts',
-          editUrl:
-            'https://github.com/NYU-ITS/rts-docs-dev/blob/main/',
+          sidebarPath: "./sidebars.ts",
+          editUrl: "https://github.com/NYU-ITS/rts-docs-dev/blob/main/",
         },
         blog: {
           showReadingTime: true,
           feedOptions: {
-            type: ['rss', 'atom'],
+            type: ["rss", "atom"],
             xslt: true,
           },
           // Remove this to remove the "edit this page" links.
-          editUrl:
-            'https://github.com/NYU-ITS/rts-docs-dev/blob/main/',
+          editUrl: "https://github.com/NYU-ITS/rts-docs-dev/blob/main/",
           // Useful options to enforce blogging best practices
-          onInlineTags: 'warn',
-          onInlineAuthors: 'warn',
-          onUntruncatedBlogPosts: 'warn',
+          onInlineTags: "warn",
+          onInlineAuthors: "warn",
+          onUntruncatedBlogPosts: "warn",
         },
         theme: {
-          customCss: './src/css/custom.css',
+          customCss: "./src/css/custom.css",
         },
       } satisfies Preset.Options,
     ],
   ],
 
   themeConfig: {
     // Replace with your project's social card
-    docs: { sidebar : { hideable: true } },
-    image: 'img/NYU.svg',
+    docs: { sidebar: { hideable: true } },
+    image: "img/NYU.svg",
     navbar: {
-      title: 'Research Technology Services',
+      title: "Research Technology Services",
       logo: {
-        alt: 'My Site Logo',
-        src: 'img/NYU.svg',
+        alt: "My Site Logo",
+        src: "img/NYU.svg",
       },
       items: [
         {
-          type: 'docSidebar',
-          sidebarId: 'genaiSidebar',
-          position: 'right',
-          label: 'Pythia',
+          type: "docSidebar",
+          sidebarId: "genaiSidebar",
+          position: "right",
+          label: "Pythia",
         },
         {
-          type: 'docSidebar',
-          sidebarId: 'hpcSidebar',
-          position: 'right',
-          label: 'HPC',
+          type: "docSidebar",
+          sidebarId: "hpcSidebar",
+          position: "right",
+          label: "HPC",
         },
         {
-          type: 'docSidebar',
-          sidebarId: 'hsrnSidebar',
-          position: 'right',
-          label: 'HSRN',
+          type: "docSidebar",
+          sidebarId: "hsrnSidebar",
+          position: "right",
+          label: "HSRN",
         },
         {
-          type: 'docSidebar',
-          sidebarId: 'rtcSidebar',
-          position: 'right',
-          label: 'RTC',
+          type: "docSidebar",
+          sidebarId: "rtcSidebar",
+          position: "right",
+          label: "RTC",
         },
         {
-          type: 'docSidebar',
-          sidebarId: 'srdeSidebar',
-          position: 'right',
-          label: 'SRDE',
+          type: "docSidebar",
+          sidebarId: "srdeSidebar",
+          position: "right",
+          label: "SRDE",
         },
-        { to: '/blog', label: 'Announcements', position: 'right' },
+        { to: "/blog", label: "Announcements", position: "right" },
       ],
     },
     footer: {
-      style: 'dark',
+      style: "dark",
       links: [
         {
-          title: 'Feedback',
+          title: "Feedback",
           items: [
             {
-              label: 'Email',
-              href: 'mailto:[email protected]',
+              label: "Email",
+              href: "mailto:[email protected]",
             },
           ],
         },
         {
-          title: 'More',
+          title: "More",
           items: [
             {
-              label: 'Blog',
-              to: '/blog',
+              label: "Blog",
+              to: "/blog",
             },
             {
-              label: 'GitHub',
-              href: 'https://github.com/NYU-ITS/rts-docs-dev',
+              label: "GitHub",
+              href: "https://github.com/NYU-ITS/rts-docs-dev",
             },
           ],
         },
@@ -145,7 +143,7 @@ const config: Config = {
     prism: {
       theme: prismThemes.oneLight,
       darkTheme: prismThemes.palenight,
-      additionalLanguages: ['bash', 'shell-session', 'lua', 'sql', 'julia'],
+      additionalLanguages: ["bash", "shell-session", "lua", "sql", "julia"],
     },
   } satisfies Preset.ThemeConfig,
 };

sidebars.ts

@@ -1,22 +1,23 @@
-import type {SidebarsConfig} from '@docusaurus/plugin-content-docs';
+import { type SidebarsConfig } from "@docusaurus/plugin-content-docs";
 
 /**
  * Creating a sidebar enables you to:
- - create an ordered group of docs
- - render a sidebar for each doc of that group
- - provide next/previous navigation
-
- The sidebars can be generated from the filesystem, or explicitly defined here.
-
- Create as many sidebars as you want.
+ *
+ * - Create an ordered group of docs
+ * - Render a sidebar for each doc of that group
+ * - Provide next/previous navigation
+ *
+ * The sidebars can be generated from the filesystem, or explicitly defined
+ * here.
+ *
+ * Create as many sidebars as you want.
  */
 const sidebars: SidebarsConfig = {
-  genaiSidebar: [{type: 'autogenerated', dirName: 'genai'}],
-  hpcSidebar: [{type: 'autogenerated', dirName: 'hpc'}],
-  hsrnSidebar: [{type: 'autogenerated', dirName: 'hsrn'}],
-  rtcSidebar: [{type: 'autogenerated', dirName: 'rtc'}],
-  srdeSidebar: [{type: 'autogenerated', dirName: 'srde'}],
-
+  genaiSidebar: [{ type: "autogenerated", dirName: "genai" }],
+  hpcSidebar: [{ type: "autogenerated", dirName: "hpc" }],
+  hsrnSidebar: [{ type: "autogenerated", dirName: "hsrn" }],
+  rtcSidebar: [{ type: "autogenerated", dirName: "rtc" }],
+  srdeSidebar: [{ type: "autogenerated", dirName: "srde" }],
 };
 
 export default sidebars;