TheOdinProject / curriculum

The open curriculum for learning web development
https://www.theodinproject.com/
Other
9.15k stars 12.68k forks source link

Installation Lessons: Bring format inline with lesson format #27160

Open JoshDevHub opened 5 months ago

JoshDevHub commented 5 months ago

Description

The installation guides currently disobey the LAYOUT_STYLE_GUIDE, and this results in them failing against the new Markdown linter that runs on pull request to this repo.

These lessons should be converted over to a format where they can fit the lesson layout. One idea for how to do this:

I feel like all of these lessons could probably be restructured to follow the typical lesson structure. The installation sections could be restructured as the "assignment" of the lesson, the lesson overview might just end up being "Installing some Cool Thing', and the knowledge check we might be able to throw in some easy things that could be added as an assignment item, like a resource on basics of whatevers being installed.

See also: #27146

This will probably take a bit of discussion and feeling things out for what's the best idea (feel free to leave comments on this). When we have a good idea in place, I'll begin assigning contributors to work on updating the affected lessons listed below.

Affected Lessons

There are other lessons listed in the installations guides, but the other ones fail the lesson layout style in different ways. So they're not going to fit cleanly with the approach/solution we settle on here.

Churtified commented 5 months ago

I can update a lesson once we decide how to proceed :)

github-actions[bot] commented 4 months ago

This issue is stale because it has had no activity for the last 30 days.