Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Changes to the docs API page #9613

Merged
merged 4 commits into from
Mar 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/docusaurus/docs/gx_welcome.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>
15 changes: 15 additions & 0 deletions docs/docusaurus/docs/reference/index.md
Original file line number Diff line number Diff line change
@@ -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/>
4 changes: 2 additions & 2 deletions docs/docusaurus/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -145,8 +145,8 @@ module.exports = {
},
{
type: 'doc',
label: 'API',
docId: 'reference/api_reference',
label: 'GX API',
docId: 'reference/index',
position: 'right',
},
{
Expand Down
6 changes: 2 additions & 4 deletions docs/docusaurus/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -605,10 +605,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: [
{
Expand Down
4 changes: 4 additions & 0 deletions docs/docusaurus/src/css/breadcrumbs.scss
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,7 @@
color: var(--link-hover-color);
}
}

.breadcrumbs:has(li:only-child) {
display: none;
}
4 changes: 0 additions & 4 deletions docs/docusaurus/src/css/overview_pages.scss
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,6 @@
}

.generated-index-page {
.theme-doc-breadcrumbs {
display: none;
}

& > div {
max-width: unset !important;
}
Expand Down
8 changes: 6 additions & 2 deletions docs/docusaurus/src/theme/DocCard/styles.module.css
Original file line number Diff line number Diff line change
@@ -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;
Expand All @@ -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%);
}
Expand Down
2 changes: 1 addition & 1 deletion docs/docusaurus/versioned_docs/version-0.18/gx_welcome.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>
15 changes: 15 additions & 0 deletions docs/docusaurus/versioned_docs/version-0.18/reference/index.md
Original file line number Diff line number Diff line change
@@ -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/>
6 changes: 2 additions & 4 deletions docs/docusaurus/versioned_sidebars/version-0.18-sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": [
{
Expand Down