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: update tutorial according to review #471

Merged
merged 2 commits into from
Aug 7, 2024

Conversation

IronCore864
Copy link
Contributor

Minor changes to the tutorial according to Anne's suggestion.

Closes #464.

This PR makes sure:

  • It starts with a clear description of what the learner can expect to achieve from the tutorial
  • The language of the tutorial assures the user that the instructor is on the same journey (“we”, not just “you”)
  • The tutorial is reproducible with a mock setup which can easily be duplicated for the target user (a mock HTTP server instead of unknown services)
  • It focuses on a single installation method and does not provide alternatives to users
  • Tutorial is broken down into multiple smaller, logical steps and (where necessary) guides the user to observe the expected outcome at each step
  • The amount of explanation is minimal and generally limited to necessary topics for the learner; links are used to connect the user to further reading on related topics
  • Listing Python as a prerequisite to spell out early on so that users don't fail halfway through the tutorial because they can't run http.serve

@IronCore864 IronCore864 marked this pull request as ready for review August 5, 2024 09:08
Copy link
Contributor

@benhoyt benhoyt left a comment

Choose a reason for hiding this comment

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

Looks good. One minor comment.

docs/tutorial/getting-started.md Outdated Show resolved Hide resolved
Co-authored-by: Ben Hoyt <benhoyt@gmail.com>
@IronCore864 IronCore864 merged commit aa71819 into canonical:master Aug 7, 2024
16 checks passed
@IronCore864 IronCore864 deleted the tutorial-doc-improvement branch August 7, 2024 02:18
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.

Improve the tutorial doc
2 participants