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 folder: update README.md #24035

Closed
4 tasks
01zulfi opened this issue Apr 16, 2022 · 4 comments · Fixed by #24042
Closed
4 tasks

NodeJS folder: update README.md #24035

01zulfi opened this issue Apr 16, 2022 · 4 comments · Fixed by #24042
Assignees
Labels
Type: Documentation Involves an update to the documentation Type: Good First Issue Good for beginner contributors

Comments

@01zulfi
Copy link
Member

01zulfi commented Apr 16, 2022

1. Description:

READMEs need to be updated throughout the curriculum repository.

Related to:

Course README template:

# <course_name>

/* in case course belongs to multiple paths, make sure to link those paths */ 

This folder contains lesson markdown files that make up the <course_name> course. This course exists in the [<path_name>](<path_link>) path on the Odin Project Website.

## Course Outline

The following list represents how the lessons are divided into sections and presented on the website.

**Disclaimer:** Given the ever updating nature of the curriculum, the outline might be outdated. See the [<course_name> course on the website](<course_link>)
instead.

### <section_name>

/* make sure the lesson order corresponds to the order on the website */
/* make sure to use relative links with respect to this README to link the markdown file */

1. [<lesson_name>](<lesson_markdown_file_link>)
2. [**<project_name>**](<project_markdown_file_link>)

2. Acceptance Criteria:

  • Update NodeJS folder's README.md file to the template provided above
  • Remove comments from the template
  • Fill in the appropriate information in the angle (<>) brackets in the template
    • Make sure to the path/course/lesson names correspond to what is on the website
  • Use relative links to link the markdown files
    • For example use apis/api_basics.md as the link to the markdown file instead of https://github.com/TheOdinProject/curriculum/blob/main/nodeJS/apis/api_basics.md
    • Make sure the links work as intended

3. Additional Information:

If anyone wants to work on this, please comment to be assigned. In case of any questions, feel free to ask below.

@01zulfi 01zulfi added Type: Good First Issue Good for beginner contributors Status: Help Wanted This issue can be assigned to other contributors Type: Documentation Involves an update to the documentation labels Apr 16, 2022
@BlizZard-bot
Copy link
Member

I'd love to work on this @01zulfi . Is there a README I could use as a reference while doing this?

@01zulfi
Copy link
Member Author

01zulfi commented Apr 16, 2022

@BlizZard-bot Thanks, you've been assigned!

Is there a README I could use as a reference while doing this?

Unfortunately, none of the current READMEs follow the desired template, hence I don't have a reference.

@01zulfi 01zulfi added Status: In Progress and removed Status: Help Wanted This issue can be assigned to other contributors labels Apr 16, 2022
@BlizZard-bot
Copy link
Member

BlizZard-bot commented Apr 16, 2022

@01zulfi there'll be multiple "section name" headings right, one for each section?

@01zulfi
Copy link
Member Author

01zulfi commented Apr 18, 2022

@BlizZard-bot Correct.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Documentation Involves an update to the documentation Type: Good First Issue Good for beginner contributors
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants