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] Add tutorials category to integrations and reorganize integrations categories and sidebar #26323

Merged
merged 15 commits into from
Dec 12, 2024

Conversation

neverett
Copy link
Contributor

@neverett neverett commented Dec 6, 2024

Summary & Motivation

  • Add "Tutorials" category to "Integrations"
  • Reorganize categories for integrations libraries -- we now have "Dagster supported" and "Community supported".

How I Tested These Changes

Tested locally

Changelog

Insert changelog entry or delete this section.

@neverett neverett self-assigned this Dec 6, 2024
@neverett neverett requested a review from cmpadden December 6, 2024 17:50
@cmpadden
Copy link
Contributor

cmpadden commented Dec 6, 2024

@neverett looks like we're getting a couple errors in Vercel:

        Error: Can't render static file for pathname "/integrations/"
            at generateStaticFile (/vercel/path0/docs/docs-beta/node_modules/@docusaurus/core/lib/ssg.js:119:15)
            at runNextTicks (node:internal/process/task_queues:65:5)
            at process.processImmediate (node:internal/timers:459:9)
            at async /vercel/path0/docs/docs-beta/node_modules/p-map/index.js:57:22 {
          [cause]: Error: Unexpected: cant find current sidebar in context
              at useCurrentSidebarCategory (server.bundle.js:123253:238)
              at DocCardListForCurrentSidebarCategory (server.bundle.js:123502:125)
              at Uc (server.bundle.js:130680:44)
              at Xc (server.bundle.js:130682:253)
              at Z (server.bundle.js:130688:89)
              at Xc (server.bundle.js:130682:481)
              at Z (server.bundle.js:130688:89)
              at Xc (server.bundle.js:130682:481)
              at Z (server.bundle.js:130688:89)
              at Xc (server.bundle.js:130686:231)
        },
        Error: Can't render static file for pathname "/integrations/aws/"
            at generateStaticFile (/vercel/path0/docs/docs-beta/node_modules/@docusaurus/core/lib/ssg.js:119:15)
            at runNextTicks (node:internal/process/task_queues:65:5)
            at process.processImmediate (node:internal/timers:459:9)
            at async /vercel/path0/docs/docs-beta/node_modules/p-map/index.js:57:22 {
          [cause]: Error: Unexpected: cant find current sidebar in context
              at useCurrentSidebarCategory (server.bundle.js:123253:238)
              at DocCardListForCurrentSidebarCategory (server.bundle.js:123502:125)
              at Uc (server.bundle.js:130680:44)
              at Xc (server.bundle.js:130682:253)
              at Z (server.bundle.js:130688:89)
              at Xc (server.bundle.js:130682:481)
              at Z (server.bundle.js:130688:89)
              at Xc (server.bundle.js:130682:481)
              at Z (server.bundle.js:130688:89)
              at Xc (server.bundle.js:130686:231)
        },

Copy link

github-actions bot commented Dec 10, 2024

Deploy preview for dagster-docs-beta ready!

Preview available at https://dagster-docs-beta-5fnkqcgtf-elementl.vercel.app

Direct link to changed pages:

@neverett
Copy link
Contributor Author

@cmpadden those errors should be fixed now, mind taking another look?

{
type: 'category',
label: 'Alerting',
label: 'Dagster-supported',
Copy link
Contributor

Choose a reason for hiding this comment

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

What do you think about making Dagster-supported the default, so it's at the top level, and then community supported being a sub folder? I think that might reduce the visual clutter slightly.

Copy link
Contributor

Choose a reason for hiding this comment

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

And then we can create some cool React components to have tags on the integration pages themselves with dagster verified or something along those lines.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think that's a great idea! Looks like Docusaurus has tagging built in, so I just used that. All integrations libraries now live in the "Libraries" section and have relevant tags (dagster-supported, community-supported, ETL, etc); tags are at the bottom of the page.

@neverett neverett added the area:docs-revamp Related to the revamp of the docs label Dec 12, 2024
Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
@cmpadden
Copy link
Contributor

cmpadden commented Dec 12, 2024

@neverett here are the Vercel errors for easier reference:

[ERROR] Error: Unable to build website for locale en.
    at tryToBuildLocale (/vercel/path0/docs/docs-beta/node_modules/@docusaurus/core/lib/commands/build.js:54:19)
    at async /vercel/path0/docs/docs-beta/node_modules/@docusaurus/core/lib/commands/build.js:65:9
    at async mapAsyncSequential (/vercel/path0/docs/docs-beta/node_modules/@docusaurus/utils/lib/jsUtils.js:21:24)
    at async Command.build (/vercel/path0/docs/docs-beta/node_modules/@docusaurus/core/lib/commands/build.js:63:5) {
  [cause]: Error: Docusaurus found broken links!
  
  Please check the pages of your site in the list below, and make sure you don't reference any path that does not exist.
  Note: it's possible to ignore broken links with the 'onBrokenLinks' Docusaurus configuration, and let the build pass.
  
  Exhaustive list of all broken links found:
  - Broken link on source page path = /dagster-plus/deployment/hybrid/agents/kubernetes:
     -> linking to /integrations/libraries/dagster-supported/kubernetes
  - Broken link on source page path = /guides/build/integrate/ingesting-data:
     -> linking to /integrations/libraries/dagster-supported/airbyte
     -> linking to /integrations/libraries/dagster-supported/dlt
     -> linking to /integrations/libraries/dagster-supported/fivetran
     -> linking to /integrations/libraries/dagster-supported/sling
  - Broken link on source page path = /guides/test/asset-checks:
     -> linking to /integrations/libraries/dagster-supported/dbt

Copy link
Contributor

@cmpadden cmpadden left a comment

Choose a reason for hiding this comment

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

I was able to confirm that things look good running locally.

There are a couple of broken links, but approving so that you're unblocked.

@neverett
Copy link
Contributor Author

I was able to confirm that things look good running locally.

There are a couple of broken links, but approving so that you're unblocked.

Ugh, sorry, I should've waited for the build to finish before commenting -- I'll fix those.

Also cc @dehume -- here's more docs revamp work, if you're curious

@neverett neverett merged commit d42712e into master Dec 12, 2024
2 of 3 checks passed
@neverett neverett deleted the nikki/docs/integrations-tutorials branch December 12, 2024 20:52
pskinnerthyme pushed a commit to pskinnerthyme/dagster that referenced this pull request Dec 16, 2024
…ions categories and sidebar (dagster-io#26323)

## Summary & Motivation

* Add "Tutorials" category to "Integrations"
* Reorganize categories for integrations libraries -- we now have
"Dagster supported" and "Community supported".

## How I Tested These Changes

Tested locally

## Changelog

> Insert changelog entry or delete this section.

---------

Signed-off-by: nikki everett <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:docs-revamp Related to the revamp of the docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants