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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] - Add examples page for Schedules (DOC-191) #21735

Merged
merged 8 commits into from May 10, 2024

Conversation

erinkcochran87
Copy link
Contributor

Summary & Motivation

This PR experiments with adding an Examples page for Schedules. It pulls some examples from the current Schedules concept page and simplifies the explanations to make it easier to skim. The focus of this reference is not to teach users how to do X, but to quickly demonstrate, provide relevant links to jump to, and let them get back to work.

I've added a summary table to each example that contains:

  • Any notes, tips, etc. about the example
  • Links to related documentation. For example, where the code is used and has a more learning-focused explanation
  • A list of APIs used in each example

Screenshot 2024-05-08 at 5 27 36 PM

How I Tested These Changes

馃憖

@erinkcochran87 erinkcochran87 added the area: docs Related to documentation in general label May 8, 2024
@erinkcochran87 erinkcochran87 changed the title [docs] - Add examples page for Schedules [docs] - Add examples page for Schedules (DOC-191) May 8, 2024
Copy link
Contributor

@tacastillo tacastillo left a comment

Choose a reason for hiding this comment

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

Rhetorical/food-for-thought question but I'm loving this new layout and structure. LGTM!

width: "20%",
}}
>
<strong>Notes</strong>
Copy link
Contributor

Choose a reason for hiding this comment

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

What happens if there are multiple long-form things that would be worthy of note?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

My intent is to keep these as short as possible since this content's goal isn't to teach. But if that were to be unavoidable, probably a bulleted list where each item starts with a bolded summary. Ex:

  • Thing number one. One fish, two fish, red fish, blue fish. Fish, fish, fish.
  • Thing number two. I will not eat fish on a box, I will not eat them with a fox. I will not eat fish here or there, I will not eat them anywhere. Ew, ew, ew.

@erinkcochran87 erinkcochran87 merged commit aa6786b into master May 10, 2024
2 checks passed
@erinkcochran87 erinkcochran87 deleted the erin/doc-191-schedule-examples branch May 10, 2024 16:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: docs Related to documentation in general
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants