-
Notifications
You must be signed in to change notification settings - Fork 1.6k
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
base: master
Are you sure you want to change the base?
Rename tutorials to examples #27717
Conversation
@dehume can you also add redirects for the existing tutorials in vercel.json? Otherwise this looks great, thanks! |
Updated the |
@@ -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 |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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
"source": "/tutorials", | ||
"destination": "/examples", |
There was a problem hiding this comment.
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
},
```
There was a problem hiding this 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", |
There was a problem hiding this comment.
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).
@dehume sorry, one more suggestion -- can you update the language in each example to change "tutorial" to "example"? |
Summary & Motivation
Update
tutorials
section toexamples
in the documentation and organize and group those code examples into their own section inexamples/examples_section
.How I Tested These Changes
Changelog