Nodejs.dev: Content structure

[fhemberger]

Current website structure

├── index
├── about
│   > short and very technical explanation (blocking vs. nonblocking, event model, threads)
│   ├── community
│   │   > explanation about CommComm, contributors/collaborators, membership, consensus seeking process
│   ├── governance
│   │   > TSC, collaborators, TSC membership/meetings, consensus seeking process
│   ├── privacy
│   │   > Privacy Policy (doesn't really belong here)
│   ├── releases
│   │   > Explanation of patch/minor/major versions
│   ├── resources
│   │   > The Node.js logo to download (@bnb)
│   ├── trademark
│   │   > Trademark Policy (doesn't really belong here)
│   └── working-groups
│       > List of working groups
├── blog
│   > Number of articles per category (including post from the old Node.js website)
│   ├── advisory-board (2)
│   ├── announcements (19)
│   ├── community (11)
│   ├── feature (1)
│   ├── module (2)
│   ├── nodejs-road-ahead
│   ├── npm (7)
│   ├── release (314)
│   ├── uncategorized (20)
│   ├── video (3)
│   ├── vulnerability (23)
│   ├── weekly-updates (72)
│   └── wg (1)
├── docs
│   > Links to various versions of the API docs 
│   ├── es6
│   │   > ES6 and beyond (probably not really relevant any longer)
│   ├── guides
│   │   ├── anatomy-of-an-http-transaction
│   │   ├── backpressuring-in-streams
│   │   ├── blocking-vs-non-blocking
│   │   ├── debugging-getting-started
│   │   ├── domain-postmortem
│   │   ├── dont-block-the-event-loop
│   │   ├── event-loop-timers-and-nexttick
│   │   ├── getting-started-guide
│   │   ├── nodejs-docker-webapp
│   │   ├── publishing-napi-modules
│   │   ├── simple-profiling
│   │   ├── timers-in-node
│   │   └── working-with-different-filesystems
│   ├── inspector
│   │   > Debugging Node.js Apps (= Inspector Tools & Clients)
│   └── meta
│       > NOT LINKED ON THE WEBSITE! (@fhemberger: Never noticed this document)
│       └── topics
│           └── dependencies
│               > Explanation of bundled dependencies (V8, libuv, npm, etc.)
├── download
│   > LTS download page
│   ├── current
│   │   > "Current" download page
│   ├── package-manager
│   │   > Installing via package manager
│   └── releases
│       > Release list
├── get-involved
│   > Links to discussion, learning, international community sites (all external)
│   ├── code-and-learn
│   │   > Code + Learn events
│   ├── collab-summit
│   │   > Collaborator's Summit (general description)
│   ├── contribute
│   │   > Reporting an issue, code contributions, becoming a collaborator
│   └── Code of Conduct (external link)
├── knowledge
│   > NOT YET LINKED ON THE WEBSITE! - https://github.com/nodejs/nodejs.org/pull/211
│   ├── HTTP
│   │   ├── clients
│   │   │   ├── how-to-access-query-string-parameters
│   │   │   └── how-to-create-a-HTTP-request
│   │   └── servers
│   │       ├── how-to-create-a-HTTP-server
│   │       ├── how-to-create-a-HTTPS-server
│   │       ├── how-to-handle-multipart-form-data
│   │       ├── how-to-read-POST-data
│   │       └── how-to-serve-static-files
│   ├── REPL
│   │   ├── how-to-create-a-custom-repl
│   │   └── how-to-use-nodejs-repl
│   ├── advanced
│   │   ├── buffers
│   │   │   └── how-to-use-buffers
│   │   └── streams
│   │       ├── how-to-use-fs-create-read-stream
│   │       ├── how-to-use-fs-create-write-stream
│   │       ├── how-to-use-stream-pipe
│   │       └── what-are-streams
│   ├── child-processes
│   │   └── how-to-spawn-a-child-process
│   ├── command-line
│   │   ├── how-to-get-colors-on-the-command-line
│   │   ├── how-to-parse-command-line-arguments
│   │   └── how-to-prompt-for-command-line-input
│   ├── cryptography
│   │   ├── how-to-use-crypto-module
│   │   └── how-to-use-the-tls-module
│   ├── errors
│   │   ├── what-are-the-error-conventions
│   │   ├── what-is-the-error-object
│   │   └── what-is-try-catch
│   ├── file-system
│   │   ├── how-to-read-files-in-nodejs
│   │   ├── how-to-search-files-and-directories-in-nodejs
│   │   ├── how-to-store-local-config-data
│   │   ├── how-to-use-the-path-module
│   │   ├── how-to-write-files-in-nodejs
│   │   └── security
│   │       └── introduction
│   ├── getting-started
│   │   ├── control-flow
│   │   │   ├── how-to-write-asynchronous-code
│   │   │   ├── what-are-callbacks
│   │   │   └── what-are-event-emitters
│   │   ├── globals-in-node-js
│   │   ├── how-to-debug-nodejs-applications
│   │   ├── how-to-use-util-inspect
│   │   ├── npm
│   │   │   ├── how-to-access-module-package-info
│   │   │   ├── what-is-npm
│   │   │   └── what-is-the-file-package-json
│   │   ├── the-console-module
│   │   ├── the-process-module
│   │   ├── what-is-node-core-verus-userland
│   │   └── what-is-require
│   ├── intermediate
│   │   └── how-to-log
│   ├── javascript-conventions
│   │   ├── how-to-create-default-parameters-for-functions
│   │   ├── using-ECMA5-in-nodejs
│   │   ├── what-are-the-built-in-timer-functions
│   │   ├── what-are-truthy-and-falsy-values
│   │   ├── what-is-json
│   │   └── what-is-the-arguments-object
│   └── other-resources
│       └── tutorials-and-how-tos
└── security
    > Report security issues

[fhemberger]

Based on what we talked in the meeting, I'd suggest a (very basic) structure like this:

• Releases¹
  
  
  
  • Download LTS
  
  
  • Download Current
  
  
  • Clarification: What is LTS? Release schedule? Major/minor/patch releases?
  
  
  • Release Notes²
  
  
  • Installation via package manager
  
  
  • Links to Previous releases, nightly builds, etc.
  
  
• Information
  
  
  
  • What is Node.js?
  
  
  • What is the Node.js Foundation/TSC?
  
  
• Documentation
  
  
  
  • Getting started
  
  
  • Knowledge Base/Guides/Debugging/etc.
  
  
  • API docs
  
  
• Getting involved
  
  
  
  • Where can I get help?
  
  
  • How can I contribute?
  
  
  • Working Groups
  
  
  • External projects from the Node.js community
  
  

¹ because it's not just "Downloads"
² "News" of that category are just the parsed change logs. Do we need those "blog posts" or would it be enough to create an RSS feed for the change logs so they can be consumed by other parties?

[fhemberger]

Also linking Adam's great post again:
https://medium.com/the-node-js-collection/redesigning-nodejs-part-1-fac08a0e015a

[maddhruv]

How about adding Summits, Conferences, Meetups category in the _Getting Involved_

[fhemberger]

@maddhruv We actively removed Meetups (Meetup.com has a horrible API) and Conferences in the past. We only advertise the official Node.js Interactive conference and Collaborator's Summit.

[maddhruv]

But we can add some other way of posting the Meetups/Conferences, like how _jsconf_ and other do

[emilypmendez]

Happy to help with documentation on front end design if possible. @fhemberger Was there a next meeting discussed or scheduled?

[ghost]

@emilypmendez Yep, in two weeks at around the same time.

[emilypmendez]

@oe thanks, so are we confirmed for Feb 15th 3pm EST?

[franciscop]

While I agree that "Releases" is more accurate, I think users normally expect "Download" or "Install" for projects. They might even confuse "Releases" with "Changelog" when scanning the categories.

[amiller-gh]

@fhemberger, love the IA writeup and proposal! 🙂

Would only suggest that we split up the Information section and replace it with Learn. I think that "Documentation" is distinct and separate from "Getting Started" and general education resources would be better discovered under a dedicated top level item. It leaves room for us to add other tutorials, and even some advanced topic deep dives – like some of what is under "knowledge" on the current website.

Resources under Information can have happy homes elsewhere. I would be surprised if the homepage couldn't house "What is Node.js?", and details under "What is the Node.js Foundation/TSC?" can easily find a place in Getting Involved under dedicated sub-pages. (Suggestion: maybe call this section Community instead? This way it becomes the people-focused section of the website and we don't shoehorn pages under a too-restrictive menu item. "Getting Involved" can easily be a sub-section here!)

I like your idea of putting the release notes blog under the releases section! That way we can keep the more inclusive term Releases as nav link, but mitigate @franciscop's very valid concern about confusion. (Would heavily encourage us to have a dedicated changelog stream page and provide the RSS feed as a supplement though). I like Releases as the nav item because we can include information about our release cycle. There will presumably be a bit 'ol "Download" button on the homepage – that CTA should do fine for the majority of people!

So, that would make the IA:

---

Home

• Download CTA
• What is Node.js?
• "Hello World" example (links off to "Getting Started" under "Learn"
• Who uses Node.js? (aka: "Appeal to Authority Pitch". Link to Foundation Application Showcase?)
• Other Marketing stuffs

Learn

• Getting Started
• Tutorials
• Advanced Topic Deep-Dives (Select content from old "Knowledge Base"

Docs

• API Docs. This is meaty enough to be its own section all by itself!

Releases

• Download LTS
• Download Current
• Installation via package manager
• Release Notes
• Release Cycle Info: What is LTS? Release schedule? Major/minor/patch releases?
• Links to Previous releases, nightly builds, etc.

Community

• Governance, The Foundation, Committees, Working Groups etc.
• Conferences Info
• Where can I get help?
• How can I contribute?
• Getting involved
• External projects from the Node.js community

That only leaves leaf pages like "Trademark Policy", "Privacy Policy", "Code of Conduct" and "Security Reporting" without a home. However, I think they can easily find a place in the footer. They're not quite important enough to be in the nav, but still deserve to be on every page! The footer is a perfect place for that type of content.

[fhemberger]

@amiller-gh Awesome, this looks like a great structure to start with!

@oe What's the plan for our next meeting?

[bnb]

Some of our micro-sites that aren't currently linked anywhere:

• https://store.nodejs.org/
• https://nodejs.org/metrics/
• https://nodejs.org/calendar/
• https://coverage.nodejs.org/
• https://benchmarking.nodejs.org/

[fhemberger]

Linking this issue here regarding "Guides" and setting up a learning path: https://github.com/nodejs/help/issues/1122

[bnb]

@amiller-gh I'd also like to suggest that we have a Branding page in the Community section, in a similar vein to what Webpack does: https://webpack.js.org/branding/

[boneskull]

Branding guide seems like high value for little effort. That is, of course, if everyone agrees on its content. :wink:

[bnb]

Also wanted to add another domains to the microsite list:

https://ci.nodejs.org/

There's also one further one for the Certification, though I don't know the stage it's at nor if I can share it for documentation purposes here _yet_.