Deploy and preview this documentation

Open
#17 11 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
javascript
Domain
cloud, devops, documentation

Research direction

Start by reviewing the repository's existing documentation content and current pull-request workflow. Evaluate the proposed Vercel or Cloudflare Pages approach and the possibility of a nodejs.org subdomain. Done means the documentation is deployed and pull requests provide directly viewable previews.

Written by the indexing model from the issue text.

Description

There is already quite a bit of content done. How about we start deploying this content so it’s easier to review? Maybe also host it under a subdomain of nodejs.org.

Additionally, it would be good if the changes could be previewed directly in the PRs, without having to clone the repository and view the changes locally. We could possibly use Vercel or Cloudflare Pages for this, if that’s something we want.

Dominant language
JavaScript
Stars
87
Forks
11
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from nodejs/package-examples

All issues in nodejs/package-examples

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.