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

Tutorial housekeeping #1286

Open
1 task
javabster opened this issue May 2, 2024 · 7 comments
Open
1 task

Tutorial housekeeping #1286

javabster opened this issue May 2, 2024 · 7 comments

Comments

@javabster
Copy link
Collaborator

javabster commented May 2, 2024

There are some small differences between all the existing tutorials that we should clean up.

All the tutorials currently on learning:

  • should use the same wording for each pattern step heading
  • should include a list of requirements at the start
  • should not include the author names at the top (there are some tutorials that were created from events that include the names)

This issue applies to both open and network tutorials

Tasks

  1. content 📄 tutorial 📒
    abbycross
@abbycross
Copy link
Collaborator

Related issue: #1189

@javabster
Copy link
Collaborator Author

I wasnt able to find a single tutorial that does everything we want, but here are a couple that have good stuff:

@javabster
Copy link
Collaborator Author

another thing that would be good to add to each tutorial (but not sure how feasible it is) is an estimate of how much QPU time it takes. e.g. could this tutorial be run within the 10min open plan, or is it many hours so recommended to use serverless

@javabster
Copy link
Collaborator Author

javabster commented May 9, 2024

example notice:
QPU time estimate: ~X QPU minutes on Y backend (NOTE: this is an estimate only, your runtimes may vary)

@abbycross
Copy link
Collaborator

@beckykd pointed out that the tutorials have a little clock icon and a time listed, which is the estimated time it takes to read that tutorial. When we start listing the QPU time too, it has the potential to be confusing, especially since the time-to-read is not labeled (only with the icon, and there's no hover text).

@javabster do we want both times listed on every tutorial? If so, we might want to get design help to make it clearer what the clock icon time means, so as not to confuse with the QPU time that we list in the tutorial itself.

@beckykd
Copy link
Collaborator

beckykd commented May 15, 2024

@abbycross noticed that we have a couple of tutorials that start with a small example, then "beef it up" to be utility-scale (or closer). Would that be a good pattern to follow everywhere? It might make open users able to run more of the tutorials.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants