Skip to content

Commit

Permalink
Make "login" the main page in API docs
Browse files Browse the repository at this point in the history
Plus, remove redundant code from inject-api-links.js.
  • Loading branch information
aversey committed Nov 1, 2024
1 parent 3b2b17f commit 543e7b2
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 5 deletions.
4 changes: 0 additions & 4 deletions docs/js/inject-api-links.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ window.addEventListener("DOMContentLoaded", function () {
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("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";
Expand All @@ -24,8 +22,6 @@ window.addEventListener("DOMContentLoaded", function () {
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/";
}
});
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ nav:
- Setup and Installation: https://docs.hopsworks.ai/
- Administration: https://docs.hopsworks.ai/
- 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/latest">Python API</a> <a id="hsfs_javadoc_link" href="https://docs.hopsworks.ai/hopsworks-api/latest/javadoc">Feature Store JavaDoc</a> </div></div>:
- Login: generated/api/login.md
- Platform API:
- Connection: generated/api/connection.md
- Datasets: generated/api/datasets.md
Expand All @@ -29,7 +30,6 @@ nav:
- Jobs: generated/api/jobs.md
- KafkaSchema: generated/api/kafka_schema.md
- KafkaTopic: generated/api/kafka_topic.md
- Login: generated/api/login.md
- OpenSearch: generated/api/opensearch.md
- Projects: generated/api/projects.md
- Secrets: generated/api/secrets.md
Expand Down

0 comments on commit 543e7b2

Please sign in to comment.