From 02e365bac36985efaf85fb11bc57912ad7e72313 Mon Sep 17 00:00:00 2001 From: Sayan Mondal Date: Wed, 10 Mar 2021 11:59:46 +0530 Subject: [PATCH] Initial Sidebar Setup (#10) * Updated Directory Structure + Initial Sidebar Setup Signed-off-by: Sayan Mondal * Reverted Folder Structure Signed-off-by: Sayan Mondal * Fixed default page to old-vs-new Signed-off-by: Sayan Mondal * Fixed embedmd. Signed-off-by: Jonsy13 Co-authored-by: Jonsy13 --- website/docs/agent-installation.md | 5 ++++ website/docs/create.md | 5 ++++ website/docs/diagram.md | 5 ++++ website/docs/litmus-installation.md | 5 ++++ website/docs/observe.md | 5 ++++ .../docs/{introduction.md => old-vs-new.md} | 13 +++-------- website/docs/schedule.md | 5 ++++ website/docs/uninstall.md | 5 ++++ website/docusaurus.config.js | 2 +- website/sidebars.js | 23 ++++++++++++++----- 10 files changed, 56 insertions(+), 17 deletions(-) create mode 100644 website/docs/agent-installation.md create mode 100644 website/docs/create.md create mode 100644 website/docs/diagram.md create mode 100644 website/docs/litmus-installation.md create mode 100644 website/docs/observe.md rename website/docs/{introduction.md => old-vs-new.md} (98%) create mode 100644 website/docs/schedule.md create mode 100644 website/docs/uninstall.md diff --git a/website/docs/agent-installation.md b/website/docs/agent-installation.md new file mode 100644 index 0000000..df261b6 --- /dev/null +++ b/website/docs/agent-installation.md @@ -0,0 +1,5 @@ +--- +id: agent-install +title: Agent Install +sidebar_label: Agent +--- diff --git a/website/docs/create.md b/website/docs/create.md new file mode 100644 index 0000000..fbe26e4 --- /dev/null +++ b/website/docs/create.md @@ -0,0 +1,5 @@ +--- +id: create +title: How to Create a Workflow +sidebar_label: Create +--- diff --git a/website/docs/diagram.md b/website/docs/diagram.md new file mode 100644 index 0000000..e28af0f --- /dev/null +++ b/website/docs/diagram.md @@ -0,0 +1,5 @@ +--- +id: diagram +title: Litmus Arch Diagram +sidebar_label: Diagram +--- diff --git a/website/docs/litmus-installation.md b/website/docs/litmus-installation.md new file mode 100644 index 0000000..59550b4 --- /dev/null +++ b/website/docs/litmus-installation.md @@ -0,0 +1,5 @@ +--- +id: litmus-install +title: Litmus Installation +sidebar_label: Litmus +--- diff --git a/website/docs/observe.md b/website/docs/observe.md new file mode 100644 index 0000000..1983e18 --- /dev/null +++ b/website/docs/observe.md @@ -0,0 +1,5 @@ +--- +id: observe +title: How to Observe/Track a Workflow +sidebar_label: Observe +--- diff --git a/website/docs/introduction.md b/website/docs/old-vs-new.md similarity index 98% rename from website/docs/introduction.md rename to website/docs/old-vs-new.md index c94df83..abea7d1 100644 --- a/website/docs/introduction.md +++ b/website/docs/old-vs-new.md @@ -1,7 +1,7 @@ --- -id: introduction -title: LitmusChaos Documentation -sidebar_label: Introduction +id: old-vs-new +title: 1.x with 2.0 Comparison +sidebar_label: 1.x VS 2.0 --- --- @@ -51,10 +51,3 @@ A high level comparison between Litmus 1.x and Litmus 2.0 providing a holistic v ### Litmus features ### Access Litmus API [here](https://litmuschaos.github.io/litmus/api.html) - - - - - - - diff --git a/website/docs/schedule.md b/website/docs/schedule.md new file mode 100644 index 0000000..3aed5e4 --- /dev/null +++ b/website/docs/schedule.md @@ -0,0 +1,5 @@ +--- +id: schedule +title: How to Schedule a Workflow +sidebar_label: Schedule +--- diff --git a/website/docs/uninstall.md b/website/docs/uninstall.md new file mode 100644 index 0000000..0a98147 --- /dev/null +++ b/website/docs/uninstall.md @@ -0,0 +1,5 @@ +--- +id: uninstall +title: How to Uninstall Litmus from your Cluster +sidebar_label: Uninstall +--- diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js index 8f9b3a0..ed748db 100644 --- a/website/docusaurus.config.js +++ b/website/docusaurus.config.js @@ -76,7 +76,7 @@ module.exports = { })), { label: "Master/Unreleased", - to: "docs/next/introduction", + to: "docs/next/old-vs-new", }, ], }, diff --git a/website/sidebars.js b/website/sidebars.js index 561895d..0b51bd9 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -1,15 +1,26 @@ module.exports = { docs: { Introduction: [ - "introduction", - // "diagram", + "old-vs-new", + "diagram", // "feature-definition" ], "Getting Started": [ - "prerequisite", - // "installation", - // "how-to", - // "unistallation", + "prerequisite", + { + "Installation": [ + "litmus-install", + "agent-install" + ], + }, + { + "How To": [ + "create", + "schedule", + "observe", + ], + }, + "uninstall", ], Features: [ "gitops",