Deploy and preview this documentation

[bjohansebas]

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.

[styfle]

Sounds good. We already have Vercel setup for https://github.com/nodejs/nodejs.org so it should be easy to add a new project and point a subdomain to it.

However, what specifically would you want to deploy since this repo is just markdown? Are you looking to render the markdown with some additional CSS?

[bjohansebas]

Render what Honkit already renders, nothing more than that.

package-examples/guide/package.json

Line 12 in 97b3d69

"honkit": "^6.0.2"

Now that I realize it, it’s listed as a devDependency.

[styfle]

I'm not sure who has the correct Vercel permissions so I'll ask in the #nodejs-website channel.

Should be as simple as visiting https://vercel.com/new and selecting this repo, then the domain.

[avivkeller]

Hey y'all! If I recall correctly, you'll need @nodejs/TSC @nodejs/build's approval to add a new subdomain.

[joyeecheung]

With HonKit it should be fairly straightforward to just host it statically as GitHub pages. We could also configure it to be under nodejs.org via the GitHub pages customization.

[styfle]

Does GitHub Pages support preview deployments per PR?

I think thats what @bjohansebas is asking for.

[MattIPv4]

Does GitHub Pages support preview deployments per PR?

In alpha per https://github.com/actions/deploy-pages#inputs-, not that I've ever seen it in the wild anywhere. So, no.

[joyeecheung]

There are a few community-maintained GH actions for PR previews with GH pages, e.g. https://github.com/marketplace/actions/deploy-pr-preview

[joyeecheung]

Also, posting in case we forgot: since there are still a few WIP chapters, we probably want to remove them from SUMMARY.md for now to hide them instead of rendering the half-baked pages.

[joyeecheung]

Opened #18 - I have a test deployment in https://joyeecheung.github.io/package-examples/ , once #18 is merged a similar site will be deployed to https://nodejs.github.io/package-examples/ .

Although, I think we should hold off landing until chapter 5 is merged.

I can work on a follow up with PR previews using https://github.com/marketplace/actions/deploy-pr-preview (either using this repo for preview, or we can consider creating a repository dedicated to deploy pr previews, so that it does not interfere with the gh-pages branches here)

[styfle]

We should use this repo for preview deployments so that we can view PRs automatically