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

NodeJS: Add descriptive link text #27896

Merged
merged 4 commits into from Apr 30, 2024
Merged

Conversation

guskirb
Copy link
Contributor

@guskirb guskirb commented Apr 29, 2024

Made changes to the links in the Express 102, 103, 104 and 105 lessons.

Because

Provide descriptive link text.

This PR

  • Add descriptive link text to Express 102 lesson.
  • Add descriptive link text to Express 103 lesson.
  • Add descriptive link text to Express 104 lesson.
  • Add descriptive link text to Express 105 lesson.

Issue

Related to #27819

Additional Information

Pull Request Requirements

  • I have thoroughly read and understand The Odin Project curriculum contributing guide
  • The title of this PR follows the location of change: brief description of change format, e.g. Intro to HTML and CSS lesson: Fix link text
  • The Because section summarizes the reason for this PR
  • The This PR section has a bullet point list describing the changes in this PR
  • If this PR addresses an open issue, it is linked in the Issue section
  • If any lesson files are included in this PR, they have been previewed with the Markdown preview tool to ensure it is formatted correctly
  • If any lesson files are included in this PR, they follow the Layout Style Guide

Made changes to the links in the Express 102, 103,
104 and 105 lessons.
@github-actions github-actions bot added the Content: NodeJS Involves the NodeJS course label Apr 29, 2024
Copy link
Contributor

@MaoShizhong MaoShizhong left a comment

Choose a reason for hiding this comment

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

Thanks for sorting out these links, @guskirb!

Would you be good to fix up the remaining lint errors? If you follow the curriculum repo contributing guide, it'll show you how to run lint checks and fixes locally.

Most of the lint errors should be fixable by running the correct script on a file (project_express_105 will need the project scripts, not the lesson scripts). There will be a couple that can't be auto-fixed so will need manually fixing (the error message should be somewhat self explanatory).

For the "Required heading structure" error in express_103_crud_and_mvc.md line 62, that should be fixed by removing the s from Knowledge checks to make Knowledge check.

You can ignore the "Required heading structure" error for express_104_view_templates.md.

Let me know if you run into any issues with this.

@MaoShizhong
Copy link
Contributor

Small side note - I suspect you may have a formatter like Prettier that runs on save, as the project 105 file had its * * emphasis (which is what we want) switched to _ _ (which is not what we want). I'd recommend finding the keybinding for Save without formatting and getting used to using that when working on any external projects, as you can't guarantee they will use the same style guide as the formatter you have running automatically. Alternatively, you can have it so your formatter does not run on save but instead is bound to a separate keybinding. Then you just only use that when working on projects you know are fine to use your formatter with.

@guskirb
Copy link
Contributor Author

guskirb commented Apr 29, 2024

Small side note - I suspect you may have a formatter like Prettier that runs on save, as the project 105 file had its * * emphasis (which is what we want) switched to _ _ (which is not what we want). I'd recommend finding the keybinding for Save without formatting and getting used to using that when working on any external projects, as you can't guarantee they will use the same style guide as the formatter you have running automatically. Alternatively, you can have it so your formatter does not run on save but instead is bound to a separate keybinding. Then you just only use that when working on projects you know are fine to use your formatter with.

I've fixed the lint errors.

I did have prettier set to reformat on save, which I've changed, thanks for letting me know.

@@ -19,58 +19,58 @@ This section contains a general overview of topics that you will learn in this l

CRUD is a concept that comes up a lot in web development, and it's the type of thing that might show up in interview questions so it's worth taking a little time to make sure you understand what it refers to.

CRUD stands for: <span id="crud">_Create, Read, Update_ and _Delete_</span>. These are the four basic functions that you will be building into your database driven apps. If you are designing a CRUD interface that means that users can expect to be able to do these 4 things to items in the database (providing they have the appropriate permissions of course).
CRUD stands for: <span id="crud">*Create, Read, Update* and *Delete*</span>. These are the four basic functions that you will be building into your database driven apps. If you are designing a CRUD interface that means that users can expect to be able to do these 4 things to items in the database (providing they have the appropriate permissions of course).
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
CRUD stands for: <span id="crud">*Create, Read, Update* and *Delete*</span>. These are the four basic functions that you will be building into your database driven apps. If you are designing a CRUD interface that means that users can expect to be able to do these 4 things to items in the database (providing they have the appropriate permissions of course).
CRUD stands for: *Create, Read, Update* and *Delete*. These are the four basic functions that you will be building into your database driven apps. If you are designing a CRUD interface that means that users can expect to be able to do these 4 things to items in the database (providing they have the appropriate permissions of course).

Not something you've made but I just noticed that we have a redundant span here, as the ### CRUD heading itself directly above already generates an h3#crud, so the span isn't actually needed for scroll either (since it's not like it's a long way away from the heading). Mind removing it while we're at it?

Everything else looks 👨‍🍳 🤌

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done!

Copy link
Contributor

@MaoShizhong MaoShizhong left a comment

Choose a reason for hiding this comment

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

🚀

@MaoShizhong MaoShizhong merged commit 084b5ab into TheOdinProject:main Apr 30, 2024
2 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content: NodeJS Involves the NodeJS course
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants