Skip to main content

Deployment and access

Prerequisites​

  1. Confirm the GitHub Actions Docs build workflow passes.
  2. Generate and commit package-lock.json with Node 22 and npm install. Then switch CI to npm ci.
  3. Import MR0808/sparelane-docs into a dedicated Vercel project. Use framework preset Docusaurus if offered, otherwise use Other, build command npm run build, output directory build, install command npm ci once the lockfile exists.
  4. Configure docs.sparelane.co as the custom domain and follow the DNS instructions provided by Vercel.
  5. Before sharing any URL, restrict production, preview and generated *.vercel.app deployment URLs using an access-control mechanism that protects every deployment. A private GitHub repository does not make a Vercel deployment private.
  6. Test access as an unauthenticated visitor, then as each approved reviewer.
  7. Invite Pete and John to the private GitHub repository only if they should be able to read and comment on GitHub Issues; GitHub Issues are not embedded website comments.

Security​

Do not rely on a client-side password prompt or obscured URL. Check Vercel Deployment Protection plan features and compatibility with your preferred login experience; if necessary, use a server-side authentication gateway with origin bypass prevention. Do not enable a public deployment as a temporary shortcut.

Feedback​

Use repository issues for suggestions and decision requests. Record accepted outcomes in the decision register.