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

Improve the Let's Start with Podtato-head” tutorial #324

Open
davidekete opened this issue Feb 13, 2025 · 3 comments
Open

Improve the Let's Start with Podtato-head” tutorial #324

davidekete opened this issue Feb 13, 2025 · 3 comments

Comments

@davidekete
Copy link

Update Request: Improve the “Let's Start with Podtato-head” tutorial

The Let’s start with Podtato-head needs a few improvements:

  • Title: The tutorial’s current title doesn’t adequately describe its content, which is the primary job of a title. The name should be changed to accurately describe the page's contents.
  • Prerequisites: The prerequisites have no actionable steps. For example, the tutorial lists “Kubectl” as a prerequisite but doesn't mention how or why. Do you need to have experience using Kubectl? Do you need to have it installed in your local machine? it doesn't mention any of that. This section also lacks a key prerequisite: having ChaosCentre installed. It is referenced in the section “Install ChaosCentre” however, this section just points to the “getting started” guide. Moving this reference to the prerequisites section would be a better approach.
  • Tutorial Structure: The tutorial follows a step-by-step approach, but the steps aren't numbered. Numbering would help readers follow a structured process in the correct order and improve the content’s scanability.
  • The Whys: The tutorial does not explain why each step is necessary. The purpose of a tutorial is NOT to help the user get something done but to help them learn.
  • Images: The screenshots in the guide are related to content but generic in the value they provide. For example, the screenshot accompanying the “Set up Environment” section depicts an already set-up environment, while the point of the section is to explain how to set up the environment and many such cases.
@Denish3436
Copy link

@davidekete @namkyu1999 could you please assign to me

@davidekete
Copy link
Author

Hi @Denish3436, I'm currently working on this issue

@davidekete
Copy link
Author

Link to a PR that fixes this issue: #326

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

No branches or pull requests

2 participants