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

Rename tutorials to examples #27717

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

dehume
Copy link
Contributor

@dehume dehume commented Feb 10, 2025

Summary & Motivation

Update tutorials section to examples in the documentation and organize and group those code examples into their own section in examples/examples_section.

How I Tested These Changes

Changelog

Insert changelog entry or delete this section.

@dehume dehume requested a review from neverett as a code owner February 10, 2025 17:55
@dehume dehume requested a review from cmpadden February 10, 2025 17:55
Copy link

github-actions bot commented Feb 10, 2025

Deploy preview for dagster-docs ready!

Preview available at https://dagster-docs-jl7dsrpl9-elementl.vercel.app

Direct link to changed pages:

@neverett
Copy link
Contributor

@dehume can you also add redirects for the existing tutorials in vercel.json? Otherwise this looks great, thanks!

@dehume
Copy link
Contributor Author

dehume commented Feb 10, 2025

@dehume can you also add redirects for the existing tutorials in vercel.json? Otherwise this looks great, thanks!

Updated the vercel.json though not entirely sure if it's done correctly

@@ -148,5 +148,7 @@ fastapi>=0.115.6 # producing a bizarrely early version of fastapi without this
-e examples/airlift-migration-tutorial
-e examples/use_case_repository[dev]
-e examples/project_atproto_dashboard
-e examples/project_dagster_modal_pipes
-e examples/project_prompt_eng
-e examples/docs_projects/project_ask_ai_dagster
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@cmpadden do I need to manually run updating a lock file or something after I update these requirement paths?

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes, I believe you will need to run the make rebuild_pyright_pins command.

docs/vercel.json Outdated
Comment on lines 484 to 485
"source": "/tutorials",
"destination": "/examples",
Copy link
Contributor

Choose a reason for hiding this comment

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

To redirect everything that was in /tutorials/... to /examples/... you will want to do:

    {
      "source": "/tutorials/:path*",
      "destination": "/examples/:path*",
      "permanent": false
    },
    ```

Copy link
Contributor

@neverett neverett left a comment

Choose a reason for hiding this comment

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

One suggestion for redirects, otherwise LGTM. Since these are Vercel redirects, you can test them in the preview deployment in your browser.

docs/vercel.json Outdated
@@ -480,6 +480,31 @@
"destination": "/etl-pipeline-tutorial/",
"permanent": false
},
{
"source": "/tutorials",
Copy link
Contributor

Choose a reason for hiding this comment

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

I think you will also need to include an entry for "source": "/tutorials/" (same for all the individual tutorials below).

@neverett
Copy link
Contributor

@dehume sorry, one more suggestion -- can you update the language in each example to change "tutorial" to "example"?

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.

3 participants