From bd60459a3cb012e2a0be40d15dbe798ff1c0231c Mon Sep 17 00:00:00 2001
From: kotte <kotte@noodl.net>
Date: Mon, 15 Jan 2024 13:15:50 +0100
Subject: [PATCH] Feat: Remove CLI docs (#57)

---
 cli/commands/build/README.md        | 30 --------------------
 cli/commands/new/README.md          | 41 ---------------------------
 cli/commands/parse/README.md        | 16 -----------
 cli/commands/project/clone.md       | 43 ----------------------------
 cli/commands/project/list.md        | 30 --------------------
 cli/commands/workspace/list.md      | 30 --------------------
 cli/guides/continuous-deployment.md | 33 ----------------------
 cli/guides/workspace-modules.md     | 24 ----------------
 cli/overview.mdx                    | 44 -----------------------------
 docusaurus.config.js                | 22 ++-------------
 sidebarsCli.js                      | 41 ---------------------------
 11 files changed, 3 insertions(+), 351 deletions(-)
 delete mode 100644 cli/commands/build/README.md
 delete mode 100644 cli/commands/new/README.md
 delete mode 100644 cli/commands/parse/README.md
 delete mode 100644 cli/commands/project/clone.md
 delete mode 100644 cli/commands/project/list.md
 delete mode 100644 cli/commands/workspace/list.md
 delete mode 100644 cli/guides/continuous-deployment.md
 delete mode 100644 cli/guides/workspace-modules.md
 delete mode 100644 cli/overview.mdx
 delete mode 100644 sidebarsCli.js

diff --git a/cli/commands/build/README.md b/cli/commands/build/README.md
deleted file mode 100644
index dcfeeda..0000000
--- a/cli/commands/build/README.md
+++ /dev/null
@@ -1,30 +0,0 @@
----
-title: CLI Command build
-hide_title: true
----
-
-# Command: build
-
-Build a Noodl app without having Noodl installed and with custom build settings.
-
-## Synopsis
-
-```
-noodl-cli build <projectDir> <outputDir> [--parseEndpoint <endpoint>] [--parseAppId <appId>]
-```
-
-### Configuration
-
-#### `parseEndpoint`
-
-- Default: undefined
-- Type: String
-
-The endpoint to the Parse Platform instance.
-
-#### `parseAppId`
-
-- Default: undefined
-- Type: String
-
-The App ID for the Parse Platform instance.
diff --git a/cli/commands/new/README.md b/cli/commands/new/README.md
deleted file mode 100644
index 355991f..0000000
--- a/cli/commands/new/README.md
+++ /dev/null
@@ -1,41 +0,0 @@
----
-title: CLI Command new
-hide_title: true
----
-
-# Command: new
-
-Create a new Noodl module template.
-
-### Example
-
-```bash
-# Create a React Module in the relative "./my-module" folder.
-noodl-cli new react-lib ./my-module
-```
-
-### Available Templates
-
-#### `react-lib`
-
-Create a module with React and Logic Component support.
-
-#### `lib`
-
-Create a module with Logic Component support.
-
-## Synopsis
-
-```
-noodl-cli new <template> <path> [--name <name>]
-```
-
-### Configuration
-
-#### `name`
-
-- Default: folder name
-- Type: String
-- Alias: `-n`
-
-The module name.
diff --git a/cli/commands/parse/README.md b/cli/commands/parse/README.md
deleted file mode 100644
index 052bd42..0000000
--- a/cli/commands/parse/README.md
+++ /dev/null
@@ -1,16 +0,0 @@
----
-title: CLI Command parse
-hide_title: true
----
-
-# Command: parse
-
-Interact with a Parse Platform instance.
-
-I would recommend looking at [noodl-parse-schema-sync (Github)](https://github.com/noodlapp/noodl-parse-schema-sync) since that is more up to date.
-
-## Synopsis
-
-```
-noodl-cli parse sync-schema
-```
diff --git a/cli/commands/project/clone.md b/cli/commands/project/clone.md
deleted file mode 100644
index cccd780..0000000
--- a/cli/commands/project/clone.md
+++ /dev/null
@@ -1,43 +0,0 @@
----
-title: CLI Command project list
-hide_title: true
----
-
-# Command: project list
-
-Clone a Noodl project via git.
-
-:::tip
-
-For this to work it is required that git is install on the machine.
-
-:::
-
-## Synopsis
-
-```
-noodl-cli project clone <project-id> <path> [--username <username>] [--password <password>] [--shell <shell>]
-```
-
-### Configuration
-
-#### `username`
-
-- Default: undefined
-- Type: String
-
-Noodl username.
-
-#### `password`
-
-- Default: undefined
-- Type: String
-
-Noodl password.
-
-#### `shell`
-
-- Default: undefined
-- Type: String
-
-Pass a different shell to git clone.
diff --git a/cli/commands/project/list.md b/cli/commands/project/list.md
deleted file mode 100644
index 80c8be2..0000000
--- a/cli/commands/project/list.md
+++ /dev/null
@@ -1,30 +0,0 @@
----
-title: CLI Command project list
-hide_title: true
----
-
-# Command: project list
-
-List all the projects in a workspace.
-
-## Synopsis
-
-```
-noodl-cli project list <workspace-id> [--username <username>] [--password <password>]
-```
-
-### Configuration
-
-#### `username`
-
-- Default: undefined
-- Type: String
-
-Noodl username.
-
-#### `password`
-
-- Default: undefined
-- Type: String
-
-Noodl password.
diff --git a/cli/commands/workspace/list.md b/cli/commands/workspace/list.md
deleted file mode 100644
index 9013879..0000000
--- a/cli/commands/workspace/list.md
+++ /dev/null
@@ -1,30 +0,0 @@
----
-title: CLI Command workspace
-hide_title: true
----
-
-# Command: workspace list
-
-List all the workspaces.
-
-## Synopsis
-
-```
-noodl-cli workspace list [--username <username>] [--password <password>]
-```
-
-### Configuration
-
-#### `username`
-
-- Default: undefined
-- Type: String
-
-Noodl username.
-
-#### `password`
-
-- Default: undefined
-- Type: String
-
-Noodl password.
diff --git a/cli/guides/continuous-deployment.md b/cli/guides/continuous-deployment.md
deleted file mode 100644
index f3c744d..0000000
--- a/cli/guides/continuous-deployment.md
+++ /dev/null
@@ -1,33 +0,0 @@
----
-title: Continuous Deployment
-hide_title: true
----
-
-# Continuous Deployment
-
-The Noodl CLI have commands that can be used to interact with your Noodl projects.
-
-:::note
-
-These commands require authentication.
-
-:::
-
-## Clone Noodl Project
-
-The project clone command `noodl-cli project clone` will call `git clone`, expecting that `git` is already installed on the machine.
-
-```bash
-$ noodl-cli project clone \
-    --workspace-id <workspace-id> \
-    --project-id <project-id> \
-    --path <path>
-```
-
-## Build Noodl Project
-
-```bash
-$ noodl-cli build \
-    --projectDir <project-path> \
-    --outFile <path/file.zip>
-```
diff --git a/cli/guides/workspace-modules.md b/cli/guides/workspace-modules.md
deleted file mode 100644
index d7ab231..0000000
--- a/cli/guides/workspace-modules.md
+++ /dev/null
@@ -1,24 +0,0 @@
----
-title: Workspace Modules
-hide_title: true
----
-
-# Workspace Modules
-
-:::danger
-
-Currently, the new Noodl CLI doesn't have support to upload to a workspace, it is supported in the older version of the Noodl CLI, for example, version `0.7.2`.
-
-:::
-
-## Using the old Noodl CLI
-
-To find the workspace id and access key.
-
-Open the [Noodl console](https://console.noodl.net/) and manage a workspace, if you are admin you will have access to the **Access Key**. The workspace id can be found in the URL on that page, for example `https://console.noodl.net/#/workspaces/g58p2h` have the **workspace id** `g58p2h`.
-
-Run this in the same folder where you have `module.json`.
-
-```bash
-$ noodl-cli push <workspace-id>/<access-key>
-```
diff --git a/cli/overview.mdx b/cli/overview.mdx
deleted file mode 100644
index 3bf97b2..0000000
--- a/cli/overview.mdx
+++ /dev/null
@@ -1,44 +0,0 @@
----
-title: CLI Overview
-hide_title: true
----
-
-# CLI Overview
-
-Noodl CLI, or `@noodl/noodl-cli`, is a command-line interface to Noodl for use in your terminal or your scripts.
-
-## Installation
-
-```bash
-$ npm install -g @noodl/noodl-cli
-```
-
-We have a few guides to help you get started with the Noodl CLI.
-To get more information about the Noodl CLI, you can call `noodl-cli help` to see the possible commands.
-
-## Authentication
-
-Some commands in `noodl-cli` require you to authenticate with Noodl.
-
-Set the credentials via environment variables:
-
-```bash
-$ export NOODL_USERNAME=<my-email>
-$ export NOODL_PASSWORD=<my-password>
-```
-
-You can also pass in the email and password via the command that requires it.
-
-```
-$ noodl-cli project clone <project-id> <path> --username <my-email> --password <my-password>
-```
-
-## Retrieving workspace id or project id
-
-```bash
-$ noodl-cli workspace list --username <my-email> --password <my-password>
-```
-
-```bash
-$ noodl-cli project list <workspace-id> --username <my-email> --password <my-password>
-```
diff --git a/docusaurus.config.js b/docusaurus.config.js
index 082c81f..d7dfceb 100644
--- a/docusaurus.config.js
+++ b/docusaurus.config.js
@@ -91,22 +91,6 @@ const config = {
         ],
       },
     ],
-    
-    // CLI
-    [
-      '@docusaurus/plugin-content-docs',
-      {
-        id: 'cli',
-        path: 'cli',
-        routeBasePath: 'cli',
-        breadcrumbs: false,
-        sidebarPath: require.resolve('./sidebarsCli.js'),
-        remarkPlugins: [
-          _parseNoodlMarkupPlugin,
-          require('./plugins/import-markdown'),
-        ],
-      },
-    ],
 
     // Whats new
     [
@@ -132,7 +116,7 @@ const config = {
       {
         paths: [
           { path: 'nodes/', folderName: true },
-          { path: 'library/modules/' }
+          { path: 'library/modules/' },
         ],
       },
     ],
@@ -155,8 +139,8 @@ const config = {
       },
       {
         name: 'google-site-verification',
-        content: 'KjANYZkN8ymGFD0SGnAVlRkD85p-fpNHCRAOKxurpWI'
-      }
+        content: 'KjANYZkN8ymGFD0SGnAVlRkD85p-fpNHCRAOKxurpWI',
+      },
     ],
     colorMode: {
       disableSwitch: true,
diff --git a/sidebarsCli.js b/sidebarsCli.js
deleted file mode 100644
index d65a9da..0000000
--- a/sidebarsCli.js
+++ /dev/null
@@ -1,41 +0,0 @@
-/**
- * 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.
- */
-
-// @ts-check
-
-/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
-const sidebars = {
-    apiSidebar: [
-        'overview',
-        {
-            type: 'category',
-            label: 'Guides',
-            items: [
-                { type: 'doc', label: 'Continuous Deployment', id: 'guides/continuous-deployment' },
-                { type: 'doc', label: 'Workspace Modules', id: 'guides/workspace-modules' },
-            ],
-        },
-        {
-            type: 'category',
-            label: 'Commands',
-            items: [
-                { type: 'doc', label: 'build', id: 'commands/build/README' },
-                { type: 'doc', label: 'new', id: 'commands/new/README' },
-                { type: 'doc', label: 'parse', id: 'commands/parse/README' },
-                { type: 'doc', label: 'project list', id: 'commands/project/list' },
-                { type: 'doc', label: 'project clone', id: 'commands/project/clone' },
-                { type: 'doc', label: 'workspace list', id: 'commands/workspace/list' },
-            ],
-        },
-    ],
-}
-
-module.exports = sidebars