[DOCS] Changes to the docs API page (#9613)

great-expectations · Mar 19, 2024 · 6b3b470 · 6b3b470
1 parent 5211222
commit 6b3b470
Show file tree

Hide file tree

Showing 10 changed files with 48 additions and 18 deletions.
diff --git a/docs/docusaurus/docs/gx_welcome.md b/docs/docusaurus/docs/gx_welcome.md
@@ -25,6 +25,6 @@ import GXCard from '@site/src/components/GXCard';
 <LinkCardGrid>
   <LinkCard topIcon label="Get started with GX Cloud" description="Our fully-managed SaaS solution that simplifies deployment, scaling, and collaboration." to="/cloud/" icon="/img/gx_cloud_storage.svg" />
   <LinkCard topIcon label="Get started with GX 1.0" description="Get started with the Great Expectations Python library." to="/core/introduction/about_gx" icon="/img/oss_icon.svg" />
-  <LinkCard topIcon label="View GX APIs" description="View our available APIs." to="/reference/api" icon="/img/api_icon.svg" />
+  <LinkCard topIcon label="View GX APIs" description="View our available APIs." to="/reference" icon="/img/api_icon.svg" />
   <LinkCard topIcon label="Learn more about GX 1.0 features" description="Use tutorials and conceptual topics to learn everything you need to know about GX 1.0 features and functionality." to="/reference/learn" icon="/img/overview_icon.svg" />
 </LinkCardGrid>
diff --git a/docs/docusaurus/docs/reference/index.md b/docs/docusaurus/docs/reference/index.md
@@ -0,0 +1,15 @@
+---
+title: 'GX API'
+hide_title: true
+hide_table_of_contents: true
+pagination_next: null
+pagination_prev: null
+hide_feedback_survey: true
+---
+import OverviewCard from '@site/src/components/OverviewCard';
+import DocCardList from '@theme/DocCardList';
+
+<OverviewCard title={frontMatter.title}>
+  GX API reference content is generated from classes and methods docstrings.
+</OverviewCard>
+<DocCardList/>
diff --git a/docs/docusaurus/docusaurus.config.js b/docs/docusaurus/docusaurus.config.js
@@ -146,8 +146,8 @@ module.exports = {
         },
         {
           type: 'doc',
-          label: 'API',
-          docId: 'reference/api_reference',
+          label: 'GX API',
+          docId: 'reference/index',
           position: 'right',
         },
         {

diff --git a/docs/docusaurus/sidebars.js b/docs/docusaurus/sidebars.js
@@ -600,10 +600,8 @@ module.exports = {
       type: 'category',
       label: 'GX API',
       link: {
-        type: 'generated-index',
-        title: 'GX API',
-        description: 'GX API reference content is generated from classes and methods docstrings.',
-        slug: '/reference/api/'
+        type: 'doc',
+        id: 'reference/index'
       },
       items: [
         {

diff --git a/docs/docusaurus/src/css/breadcrumbs.scss b/docs/docusaurus/src/css/breadcrumbs.scss
@@ -12,3 +12,7 @@
     color: var(--link-hover-color);
   }
 }
+
+.breadcrumbs:has(li:only-child) {
+  display: none;
+}
diff --git a/docs/docusaurus/src/css/overview_pages.scss b/docs/docusaurus/src/css/overview_pages.scss
@@ -39,10 +39,6 @@
 }
 
 .generated-index-page {
-  .theme-doc-breadcrumbs {
-    display: none;
-  }
-
   & > div {
     max-width: unset !important;
   }

diff --git a/docs/docusaurus/src/theme/DocCard/styles.module.css b/docs/docusaurus/src/theme/DocCard/styles.module.css
@@ -1,4 +1,4 @@
-.cardContainer {
+a.cardContainer {
     --ifm-link-color: var(--ifm-color-emphasis-800);
     --ifm-link-hover-color: var(--ifm-color-emphasis-700);
     --ifm-link-hover-decoration: none;
@@ -7,9 +7,13 @@
     border: 1px solid var(--ifm-color-emphasis-200);
     transition: all var(--ifm-transition-fast) ease;
     transition-property: border, box-shadow;
+
+    color: var(--ifm-font-color-base);
+    text-decoration: none;
   }
 
-  .cardContainer:hover {
+  a.cardContainer:hover {
+    color: var(--ifm-font-color-base);
     border-color: var(--ifm-color-primary);
     box-shadow: 0 3px 6px 0 rgb(0 0 0 / 20%);
   }

diff --git a/docs/docusaurus/versioned_docs/version-0.18/gx_welcome.md b/docs/docusaurus/versioned_docs/version-0.18/gx_welcome.md
@@ -25,6 +25,6 @@ import GXCard from '@site/src/components/GXCard';
 <LinkCardGrid>
   <LinkCard topIcon label="Get started with GX Cloud" description="Our fully-managed SaaS solution that simplifies deployment, scaling, and collaboration." to="/cloud/" icon="/img/gx_cloud_storage.svg" />
   <LinkCard topIcon label="Get started with GX OSS" description="Get started with our original offering." to="/oss" icon="/img/oss_icon.svg" />
-  <LinkCard topIcon label="View GX APIs" description="View our available APIs." to="/reference/api" icon="/img/api_icon.svg" />
+  <LinkCard topIcon label="View GX APIs" description="View our available APIs." to="/reference" icon="/img/api_icon.svg" />
   <LinkCard topIcon label="Learn more about GX OSS features" description="Use tutorials and conceptual topics to learn everything you need to know about GX OSS features and functionality." to="/reference/learn" icon="/img/overview_icon.svg" />
 </LinkCardGrid>
diff --git a/docs/docusaurus/versioned_docs/version-0.18/reference/index.md b/docs/docusaurus/versioned_docs/version-0.18/reference/index.md
@@ -0,0 +1,15 @@
+---
+title: 'GX API'
+hide_title: true
+hide_table_of_contents: true
+pagination_next: null
+pagination_prev: null
+hide_feedback_survey: true
+---
+import OverviewCard from '@site/src/components/OverviewCard';
+import DocCardList from '@theme/DocCardList';
+
+<OverviewCard title={frontMatter.title}>
+  GX API reference content is generated from classes and methods docstrings.
+</OverviewCard>
+<DocCardList/>
diff --git a/docs/docusaurus/versioned_sidebars/version-0.18-sidebars.json b/docs/docusaurus/versioned_sidebars/version-0.18-sidebars.json
@@ -524,10 +524,8 @@
       "type": "category",
       "label": "GX API",
       "link": {
-        "type": "generated-index",
-        "title": "GX API",
-        "description": "GX API reference content is generated from classes and methods docstrings.",
-        "slug": "/reference/api/"
+        "type": "doc",
+        "id": "version-0.18/reference/index"
       },
       "items": [
         {