Skip to content

Standardize (and require?) a "What you'll need" section on all Tutorials #7

Description

@asg017

Examples:

What you'll need:
- A web browser
- A Github account
- A Glitch account
What you'll need:
- A Glitch account
- Some Python knowledge
- Knowledge of using the command line
What you'll need:
- Knowledge of Node.js
- A Facebook Developer Account
- An account on Heroku

A lot of these could probably be repeatable. For example, github, glitch, web browser are all common pre-reqs that many tutorials will have. So maybe we can add it to the metadata of each post, like so:

export const meta = {
    authors: [{name:"Alex Garcia", github: "asg017"}],
    title: "How to make your own Time Travel Machine",
    prereqs: ["github", "glitch", "browser", "python", "raspberry_pi"]

}

If we do this, we'd need a mapping of legal "prereqs" and what to render. In React, this may look like:

const map = {
    github: () => <span> A Github account (signup <a href="https://github.com/join">here</a>)</span>,
    glitch: () => <span> A Glitch account (signup <a href="https://glitch.com/signup">here</a>)</span>,

}
export default function PrereqItem(props) {
    const {key} = props;
   const Item = map[key];
    return <Item/>;
}

What "Pre-Reqs" have

  • A link to complete or get the prereq (signup links, small tutorials maybe?)
  • An icon or emoji, e.g. Github logo, glitch logo, computer logo, etc.
  • Accompanying tutorial?

What "Pre-Reqs" shouldnt be

We want all these tutorials to be inclusive, so anything overly complicated or with many requirements should be limited. Unless there is enough documentation/other tutorials people could follow to "catch" up. This is a list of potential "pre-reqs" that aren't banned, but should be limited (and may be an indicator that a tutorial is too complex):

What you'll need:

  • Knowledge of Python, Go, Ruby, and Rust # too many languages
  • AWS EC2 instance, 50GB from DigitalOcean # Paid services
  • Web development experience # very vague - html? js? react? servers?

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions