type(docs): Updated API docs to v2.0.0 (#3105)

* Updated API docs to v2.0.0 Signed-off-by: Amit Kumar Das <[email protected]> * Updated auth API to v2.0.0 Signed-off-by: Amit Kumar Das <[email protected]> * Updated API urls Signed-off-by: Amit Kumar Das <[email protected]> Co-authored-by: Vedant Shrotria <[email protected]>
litmuschaos · Aug 9, 2021 · a28d2ea · a28d2ea
1 parent 09bb1cd
commit a28d2ea
Show file tree

Hide file tree

Showing 15 changed files with 21 additions and 21 deletions.
diff --git a/docs/auth/logo.png b/docs/auth/logo.png
diff --git a/docs/auth/api.html → docs/auth/v2.0.0/api.html b/docs/auth/api.html → docs/auth/v2.0.0/api.html
@@ -4,12 +4,12 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <title>Litmus Portal Authentication API | API Reference</title>
-    <link rel="stylesheet" href="public/stylesheets/foundation.min.css" />
-    <link rel="stylesheet" href="public/stylesheets/spectacle.min.css" />
+    <link rel="stylesheet" href="../public/stylesheets/foundation.min.css" />
+    <link rel="stylesheet" href="../public/stylesheets/spectacle.min.css" />
     <script src="https://code.jquery.com/jquery-2.1.4.min.js"></script>
     <!-- <script src="javascripts/foundation.js"></script> -->
-    <script src="javascripts/spectacle.min.js"></script>
-    <link rel="icon" type="image/png" href="../images/logo.png"/>
+    <script src="../javascripts/spectacle.min.js"></script>
+    <link rel="icon" type="image/png" href="../logo.png"/>
   </head>
   <body id="spectacle">
     <div id="page" class="drawer-layout drawer-slide-right-large">
@@ -18,11 +18,11 @@
           <span aria-hidden="true">×</span>
         </button>
         <div id="logo">
-          <img src="../images/logo.png" title="Litmus Portal API Documentation" /> </div>
+          <img src="../logo.png" title="Litmus Portal API Documentation" /> </div>
         <nav id="nav" role="navigation">
           <h5>Topics</h5>
           <a href="#introduction">Authentication</a>
-          <a href="https://litmuschaos.github.io/litmus/api.html" target="_blank">GraphQL APIs</a>
+          <a href="https://litmuschaos.github.io/litmus/graphql/v2.0.0/api.html" target="_blank">GraphQL APIs</a>
           <h5>Paths</h5>
           <!-- <section>
                 <a href="#path--status">/status</a>

diff --git a/docs/config.yml → docs/graphql/config.yml b/docs/config.yml → docs/graphql/config.yml
diff --git a/docs/javascripts/spectacle.js → docs/graphql/javascripts/spectacle.js b/docs/javascripts/spectacle.js → docs/graphql/javascripts/spectacle.js
diff --git a/docs/javascripts/spectacle.min.js → docs/graphql/javascripts/spectacle.min.js b/docs/javascripts/spectacle.min.js → docs/graphql/javascripts/spectacle.min.js
diff --git a/docs/graphql/logo.png b/docs/graphql/logo.png
diff --git a/docs/stylesheets/foundation.css → docs/graphql/stylesheets/foundation.css b/docs/stylesheets/foundation.css → docs/graphql/stylesheets/foundation.css
diff --git a/docs/stylesheets/foundation.min.css → docs/graphql/stylesheets/foundation.min.css b/docs/stylesheets/foundation.min.css → docs/graphql/stylesheets/foundation.min.css
diff --git a/docs/stylesheets/spectacle.css → docs/graphql/stylesheets/spectacle.css b/docs/stylesheets/spectacle.css → docs/graphql/stylesheets/spectacle.css
diff --git a/docs/stylesheets/spectacle.min.css → docs/graphql/stylesheets/spectacle.min.css b/docs/stylesheets/spectacle.min.css → docs/graphql/stylesheets/spectacle.min.css
diff --git a/docs/api.html → docs/graphql/v2.0.0/api.html b/docs/api.html → docs/graphql/v2.0.0/api.html
@@ -4,12 +4,12 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <title>Litmus Portal API Documentation | API Reference</title>
-    <link rel="stylesheet" href="stylesheets/foundation.min.css" />
-    <link rel="stylesheet" href="stylesheets/spectacle.min.css" />
+    <link rel="stylesheet" href="../stylesheets/foundation.min.css" />
+    <link rel="stylesheet" href="../stylesheets/spectacle.min.css" />
     <script src="https://code.jquery.com/jquery-2.1.4.min.js"></script>
     <!-- <script src="javascripts/foundation.js"></script> -->
-    <script src="javascripts/spectacle.min.js"></script>
-    <link rel="icon" type="image/png" href="images/logo.png"/>
+    <script src="../javascripts/spectacle.min.js"></script>
+    <link rel="icon" type="image/png" href="../logo.png"/>
   </head>
   <body id="spectacle">
     <div id="page" class="drawer-layout drawer-slide-right-large">
@@ -18,11 +18,10 @@
           <span aria-hidden="true">×</span>
         </button>
         <div id="logo">
-          <img src="images/logo.png" title="Litmus Portal API Documentation" /> </div>
+          <img src="../logo.png" title="Litmus Portal API Documentation" /> </div>
         <nav id="nav" role="navigation">
           <h5>Topics</h5>
           <a href="#introduction">Introduction</a>
-          <a href="https://litmuschaos.github.io/litmus/auth/api.html" target="_blank">Authentication</a>
           <h5>Operations</h5>
           <section>
             <a href="#tag-Cluster">Cluster</a>
@@ -237,6 +236,9 @@ <h5>Operations</h5>
               </li>
             </ul>
           </section>
+          <section>
+            <a href="https://litmuschaos.github.io/litmus/auth/v2.0.0/api.html" target="_blank">Authentication</a>
+          </section>
           <h5>Schema Definitions</h5>
           <a href="#definition-ActionPayload"> ActionPayload </a>
           <a href="#definition-AgentStat"> AgentStat </a>

diff --git a/litmus-portal/frontend/src/components/DeveloperGuide/index.tsx b/litmus-portal/frontend/src/components/DeveloperGuide/index.tsx
@@ -19,7 +19,7 @@ const DeveloperGuide: React.FC<DeveloperGuideProps> = ({
   const handleClose = () => {
     setDisplay(false);
   };
-  const docs = 'https://docs.litmuschaos.io/docs/getstarted/';
+  const docs = 'https://docs.litmuschaos.io/';
 
   const classes = useStyles();
   return (

diff --git a/litmus-portal/frontend/src/components/LocalQuickActionCard/index.tsx b/litmus-portal/frontend/src/components/LocalQuickActionCard/index.tsx
@@ -99,8 +99,7 @@ const LocalQuickActionCard: React.FC<LocalQuickActionCardProps> = ({
       ? {
           src: './icons/docs.svg',
           alt: 'docs',
-          onClick: () =>
-            window.open('https://docs.litmuschaos.io/docs/getstarted'),
+          onClick: () => window.open('https://docs.litmuschaos.io/'),
           text: t('quickActionCard.readDocs'),
         }
       : emptyData,

diff --git a/litmus-portal/frontend/src/components/SideBar/index.tsx b/litmus-portal/frontend/src/components/SideBar/index.tsx
@@ -178,7 +178,7 @@ const SideBar: React.FC = () => {
         <CustomisedListItem
           key="litmusDocs"
           handleClick={() => {
-            window.open('https://docs.litmuschaos.io/docs/getstarted');
+            window.open('https://docs.litmuschaos.io/');
           }}
           label="Litmus Docs"
           selected={pathName === 'docs'}
@@ -188,7 +188,9 @@ const SideBar: React.FC = () => {
         <CustomisedListItem
           key="litmusAPIDocs"
           handleClick={() => {
-            window.open('https://litmuschaos.github.io/litmus/api.html');
+            window.open(
+              'https://litmuschaos.github.io/litmus/graphql/v2.0.0/api.html'
+            );
           }}
           label="Litmus API Docs"
           selected={pathName === 'docs'}

diff --git a/litmus-portal/frontend/src/views/MyHub/MyHubExperiment/index.tsx b/litmus-portal/frontend/src/views/MyHub/MyHubExperiment/index.tsx
@@ -107,10 +107,7 @@ const MyHub = () => {
                   <div>
                     <div className={classes.note}>PRE-REQUISITE:</div>
                     <div className={classes.linkText}>
-                      <a
-                        href="https://docs.litmuschaos.io/docs/getstarted/"
-                        target="_"
-                      >
+                      <a href="https://docs.litmuschaos.io/" target="_">
                         Install Litmus Operator
                       </a>
                       : a tool for injecting Chaos Experiments