feat: Initial guides work

[lancemccluskey]

Description

This PR creates the initial guides directory along with a commit-messages page. My idea is this directory would contain articles related to best practices with Node.js development. We could have pages containing best practices for writing tests, general project structures for front/back end dev work, etc.

Related Issues

Addresses #1048

Note

I havent done the boilerplate code needed to add a new page for the commit-messages page yet. I wanted to get feedback on this idea first.

The alternative would be to keep the guides directory github centric at the repo level like the CONTRIBUTING guide we have now.

Thoughts?

[codecov-commenter]

Codecov Report

Merging #1675 (14b227d) into main (748799a) will decrease coverage by 0.90%. The diff coverage is 0.00%.

@@            Coverage Diff             @@
##             main    #1675      +/-   ##
==========================================
- Coverage   89.84%   88.94%   -0.91%     
==========================================
  Files          73       74       +1     
  Lines         788      796       +8     
  Branches      225      227       +2     
==========================================
  Hits          708      708              
- Misses         79       87       +8     
  Partials        1        1              

Impacted Files	Coverage Δ
src/components/NavigationSection/index.tsx	100.00% <ø> (ø)
src/containers/Navigation/index.tsx	69.76% <ø> (ø)
src/templates/guides.tsx	0.00% <0.00%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 748799a...14b227d. Read the comment docs.

[github-actions[bot]]

Please find a preview at: https://staging.nodejs.dev/1675/

[lancemccluskey]

/preview

[github-actions[bot]]

Please find a preview at: https://staging.nodejs.dev/1675/

[lancemccluskey]

https://staging.nodejs.dev/1675/guides @manishprivet Link to guides section. Lemme know what you think when you have a moment!

[lancemccluskey]

I have general question about the content. Is it copied from somewhere? And in case yes is it allowed to have pages on this site with external content?

Yes, the writing tests page is copied from here. Im not sure what permissions it has tbh. My whole point of this PR was to showcase a /guides/ page where we could stick Node.js best practice docs. The writing tests page from the node repo seemed like a good place to start. I have no issues taking it out though.

[manishprivet]

If it was taken from node's repo, then it should be fine regarding permissions and all I think. @benhalverson

[rodion-arr]

Thanks, we've already copied multiple pages from nodejs.org so I think it's OK but it's better to double check :)

[lancemccluskey]

@joesepi Id like your take on this as well since you opened the issue. I took the writing-tests page from this directory, and wrote a rudimentary page on commit-messages. These pages branch off of /guides/, analogous to the /learn/ pages. As we get more contact, these pages would make up our "best practices" regarding Node.js. Thoughts? https://staging.nodejs.dev/1675/guides

[lancemccluskey]

/preview

[github-actions[bot]]

Please find a preview at: https://staging.nodejs.dev/1675/

[benhalverson]

I think the issue was more about guides / best practices on development for nodejs.dev site but I could be mistaken.

[lancemccluskey]

I think the issue was more about guides / best practices on development for nodejs.dev site but I could be mistaken.

I couldve misunderstood too. I thought it was best practices with Node.js in general. @joesepi What was the goal of this ticket? best practices specific to the Node.js side that would stay in the repo or generic Node.js best practices that could be hosted on the site

[rodion-arr]

kindly pinging @joesepi to review comment above

[ovflowd]

I'm closing this PR as guides is not something we're going to support here for now.