[FSTORE-1346][CLEAN APPEND] Revert emergency fix and make a clean upgrade of the doc (#370)

vatj · web-flow · commit 8bc043ecf76a · 2024-04-11T10:26:17.000+02:00
* Reverting messy fixes

* Minimal changes

* Minor cosmetic improvement

* Add support for latest redirect
diff --git a/README.md b/README.md
@@ -2,7 +2,6 @@
 
 This is the source of the landing page for https://docs.hopsworks.ai
 
-
 ## Build instructions
 
 ### Step 1: Setup python environment
@@ -64,4 +63,4 @@ linkchecker http://127.0.0.1:8000/
 
 # If ok just kill the server
 kill -9 $SERVER_PID
-```
+```
diff --git a/docs/css/custom.css b/docs/css/custom.css
@@ -9,7 +9,6 @@
 .md-footer__inner:not([hidden]) {
   display: none;
 }
-
 /* Lex did stuff here */
 .svg_topnav {
   width: 12px;
@@ -24,15 +23,15 @@
   box-shadow: 0 0 0 0;
 }
 
+.md-tabs__item {
+  min-width: 2.5rem;
+}
+
 .md-tabs__item:hover {
   background-color: var(--md-tertiary-fg-color);
   transition: background-color 450ms;
 }
 
-.md-tabs__item {
-  min-width: 2.5rem;
-}
-
 .md-sidebar__scrollwrap {
   background-color: var(--md-quaternary-fg-color);
   padding: 15px 5px 5px 5px;
diff --git a/docs/css/dropdown.css b/docs/css/dropdown.css
@@ -18,7 +18,7 @@ overflow: inherit;
 /* The container <div> - needed to position the dropdown content */
 .dropdown {
   position: absolute;
-  display: flex;
+  display: inline-block;
 }
 
 /* Dropdown Content (Hidden by Default) */
@@ -31,7 +31,6 @@ overflow: inherit;
   box-shadow: 0px 8px 16px 0px rgba(0,0,0,0.2);
   z-index: 1000;
   border-radius: 2px;
-  top:32px;
   left:-15px;
 }
 
diff --git a/docs/css/marctech.css b/docs/css/marctech.css
diff --git a/docs/javascripts/inject-api-links.js b/docs/javascripts/inject-api-links.js
diff --git a/docs/js/dropdown.js b/docs/js/dropdown.js
@@ -1,2 +1,3 @@
 document.getElementsByClassName("md-tabs__link")[7].style.display = "none";
 document.getElementsByClassName("md-tabs__link")[9].style.display = "none";
+
diff --git a/docs/js/inject-api-links.js b/docs/js/inject-api-links.js
@@ -0,0 +1,33 @@
+window.addEventListener("DOMContentLoaded", function () {
+    var windowPathNameSplits = window.location.pathname.split("/");
+    var majorVersionRegex = new RegExp("(\\d+[.]\\d+)")
+    var latestRegex = new RegExp("latest")
+    if (majorVersionRegex.test(windowPathNameSplits[1])) { // On landing page docs.hopsworks.api/3.0 - URL contains major version
+        // Version API dropdown
+        document.getElementById("hopsworks_api_link").href = "https://docs.hopsworks.ai/hopsworks-api/" + windowPathNameSplits[1] + "/generated/api/login/";
+        document.getElementById("hsfs_api_link").href = "https://docs.hopsworks.ai/feature-store-api/" + windowPathNameSplits[1] + "/generated/api/connection_api/";
+        document.getElementById("hsfs_javadoc_link").href = "https://docs.hopsworks.ai/feature-store-api/" + windowPathNameSplits[1] + "/javadoc";
+        document.getElementById("hsml_api_link").href = "https://docs.hopsworks.ai/machine-learning-api/" + windowPathNameSplits[1] + "/generated/connection_api/";
+    } else { // on docs.hopsworks.api/feature-store-api/3.0 / docs.hopsworks.api/hopsworks-api/3.0 / docs.hopsworks.api/machine-learning-api/3.0
+        
+        if (latestRegex.test(windowPathNameSplits[2]) || latestRegex.test(windowPathNameSplits[1])) {
+            var majorVersion = "latest";
+        } else {
+            var apiVersion = windowPathNameSplits[2];
+            var majorVersion = apiVersion.match(majorVersionRegex)[0];
+        }
+        // Version main navigation
+        document.getElementsByClassName("md-tabs__link")[0].href = "https://docs.hopsworks.ai/" + majorVersion;
+        document.getElementsByClassName("md-tabs__link")[1].href = "https://colab.research.google.com/github/logicalclocks/hopsworks-tutorials/blob/master/quickstart.ipynb";
+        document.getElementsByClassName("md-tabs__link")[2].href = "https://docs.hopsworks.ai/" + majorVersion + "/tutorials/";
+        document.getElementsByClassName("md-tabs__link")[3].href = "https://docs.hopsworks.ai/" + majorVersion + "/concepts/hopsworks/";
+        document.getElementsByClassName("md-tabs__link")[4].href = "https://docs.hopsworks.ai/" + majorVersion + "/user_guides/";
+        document.getElementsByClassName("md-tabs__link")[5].href = "https://docs.hopsworks.ai/" + majorVersion + "/setup_installation/aws/getting_started/";
+        document.getElementsByClassName("md-tabs__link")[6].href = "https://docs.hopsworks.ai/" + majorVersion + "/admin/";
+        // Version API dropdown
+        document.getElementById("hopsworks_api_link").href = "https://docs.hopsworks.ai/hopsworks-api/" + majorVersion + "/generated/api/login/";
+        document.getElementById("hsfs_api_link").href = "https://docs.hopsworks.ai/feature-store-api/" + majorVersion + "/generated/api/connection_api/";
+        document.getElementById("hsfs_javadoc_link").href = "https://docs.hopsworks.ai/feature-store-api/" + majorVersion + "/javadoc";
+        document.getElementById("hsml_api_link").href = "https://docs.hopsworks.ai/machine-learning-api/" + majorVersion + "/generated/connection_api/";
+    }
+});
diff --git a/docs/js/quickstart-fullscreen.js b/docs/js/quickstart-fullscreen.js
@@ -3,9 +3,6 @@
 */
 
 //https://developer.mozilla.org/en-US/docs/Web/HTTP/Browser_detection_using_the_user_agent for recommended approach to test if device is mobile
-if (
-  window.location.pathname.endsWith("hopsworks-tutorials/quickstart/") &&
-  !/Mobi|Android/i.test(navigator.userAgent)
-) {
-  document.getElementsByClassName("md-sidebar--primary")[0].remove();
-}
+if(window.location.pathname.endsWith('hopsworks-tutorials/quickstart/') && !/Mobi|Android/i.test(navigator.userAgent)) {
+    document.getElementsByClassName("md-sidebar--primary")[0].remove()
+}
diff --git a/docs/overrides/main.html b/docs/overrides/main.html
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -276,12 +276,12 @@ nav:
       - Audit:
           - Access Audit Logs: admin/audit/audit-logs.md
           - Export Audit Logs: admin/audit/export-audit-logs.md
-  - API<div class="dropdown"><button class="dropbtn">API</button><div id="myDropdown" class="dropdown-content"> <a id="hopsworks_api_link" href="https://docs.hopsworks.ai/hopsworks-api/dev">Hopsworks API</a> <a id="hsfs_api_link" href="https://docs.hopsworks.ai/feature-store-api/dev">Feature Store API</a> <a id="hsfs_javadoc_link" href="https://docs.hopsworks.ai/feature-store-api/dev/javadoc">Feature Store JavaDoc</a> <a id="hsml_api_link" href="https://docs.hopsworks.ai/machine-learning-api/dev">MLOps API</a> </div></div>: https://docs.hopsworks.ai
+  - <div class="dropdown"><button class="dropbtn"> API </button> <div id="myDropdown" class="dropdown-content"> <a id="hopsworks_api_link" href="https://docs.hopsworks.ai/hopsworks-api/dev">Hopsworks API</a> <a id="hsfs_api_link" href="https://docs.hopsworks.ai/feature-store-api/dev">Feature Store API</a> <a id="hsfs_javadoc_link" href="https://docs.hopsworks.ai/feature-store-api/dev/javadoc">Feature Store JavaDoc</a> <a id="hsml_api_link" href="https://docs.hopsworks.ai/machine-learning-api/dev">MLOps API</a> </div></div>: https://docs.hopsworks.ai
   - Community ↗: https://community.hopsworks.ai/
 
 theme:
   name: material
-  custom_dir: overrides
+  custom_dir: docs/overrides
   favicon: assets/images/favicon.ico
   logo: assets/images/hops-logo.png
   icon:
@@ -320,14 +320,14 @@ extra:
     property: G-64FEEXPSDN
 
 extra_css:
-  - stylesheets/custom-bis.css
-  - stylesheets/marctech.css
-  - stylesheets/dropdown-bis.css
+  - css/custom.css
+  - css/marctech.css
+  - css/dropdown.css
 
 extra_javascript:
-  - javascripts/inject-api-links.js
-  - javascripts/hide-dropdown.js
-  - javascripts/quickstart-fullscreen.js
+  - js/inject-api-links.js
+  - js/dropdown.js
+  - js/quickstart-fullscreen.js
 
 plugins:
   - search

Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ overflow: inherit;`
`18`	`18`	`/* The container <div> - needed to position the dropdown content */`
`19`	`19`	`.dropdown {`
`20`	`20`	`position: absolute;`
`21`		`- display: flex;`
	`21`	`+ display: inline-block;`
`22`	`22`	`}`
`23`	`23`
`24`	`24`	`/* Dropdown Content (Hidden by Default) */`
`@@ -31,7 +31,6 @@ overflow: inherit;`
`31`	`31`	`box-shadow: 0px 8px 16px 0px rgba(0,0,0,0.2);`
`32`	`32`	`z-index: 1000;`
`33`	`33`	`border-radius: 2px;`
`34`		`- top:32px;`
`35`	`34`	`left:-15px;`
`36`	`35`	`}`
`37`	`36`
Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,3 @@`
`1`	`1`	`document.getElementsByClassName("md-tabs__link")[7].style.display = "none";`
`2`	`2`	`document.getElementsByClassName("md-tabs__link")[9].style.display = "none";`
	`3`	`+`