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

Conversation

deborahniesz
Copy link
Contributor

@deborahniesz deborahniesz commented Mar 12, 2024

Description

Deploy Preview

Changes consist of:

  • Rename API tab to GX API and change styles of default index page to match the styles of the auto-generated index page
  • Remove next button from navigation in API overview page (and the "was this helpful" component)
  • Fix link to API page so that you can access the API page directly after clicking GX API instead of having to double click.
  • Change in the breadcrumbs, from now on every breadcrumb that has only one element (therefore not clickable) will be hidden

Previous way to interact with the API index page

oldAPIpage.mp4

Current way to interact with the API index page

newAPIpage.mp4
  • Description of PR changes above includes a link to an existing GitHub issue
  • PR title is prefixed with one of: [BUGFIX], [FEATURE], [DOCS], [MAINTENANCE], [CONTRIB]
  • Code is linted - run invoke lint (uses ruff format + ruff check)
  • Appropriate tests and docs have been updated

For more information about contributing, see Contribute.

After you submit your PR, keep the page open and monitor the statuses of the various checks made by our continuous integration process at the bottom of the page. Please fix any issues that come up and reach out on Slack if you need help. Thanks for contributing!

Copy link

netlify bot commented Mar 12, 2024

Deploy Preview for niobium-lead-7998 ready!

Name Link
🔨 Latest commit b1e9305
🔍 Latest deploy log https://app.netlify.com/sites/niobium-lead-7998/deploys/65f1fe99425bd100086dc0e5
😎 Deploy Preview https://deploy-preview-9613.docs.greatexpectations.io
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@deborahniesz deborahniesz force-pushed the DSB-726_changes_to_docs_API_page branch from 90a191b to ab04304 Compare March 12, 2024 18:27
@deborahniesz deborahniesz force-pushed the DSB-726_changes_to_docs_API_page branch from ab04304 to 2f3d939 Compare March 13, 2024 15:22
Copy link
Member

@josectobar josectobar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great, thanks!

@deborahniesz deborahniesz added this pull request to the merge queue Mar 14, 2024
Merged via the queue into develop with commit 911b854 Mar 14, 2024
63 checks passed
@deborahniesz deborahniesz deleted the DSB-726_changes_to_docs_API_page branch March 14, 2024 17:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants