(Note: Although it works, this process is still a bit of a WIP.)
Clone the engine somewhere and set it up to be NPM linked:
git clone git@github.com:cloudflare/cloudflare-docs-engine.git
npm link(Note: This will soon be moved to the @cloudflare org.)
Clone this repo.
git clone git@github.com:cloudflare/cloudflare-docs.gitFor each product, cd into products/$productName and then run:
npm link cloudflare-docs-engine && npm run bootstrap && npm run developEach product’s docs are automatically deployed via @cloudflare/wrangler using Github Actions.
Test environment deploys to:
https://$pathPrefix.cloudflare-docs.workers.dev/$pathPrefix/Prod environment deploys to:
https://developers.cloudflare.com/$pathPrefix/| Product | pathPrefix |
Icon | Content | Test | Prod |
|---|---|---|---|---|---|
| 1.1.1.1 | 1-1-1-1 | ✕ | Test | ||
| Access | access | ✕ | Test | ||
| Analytics | analytics | ✕ | Test | ||
| Argo Tunnel | argo-tunnel | ✕ | Test | ||
| BYOIP | byoip | ✕ | Test | ||
| Distributed Web Gateway | distributed-web | ✕ | Test | ||
| Docs Engine¹ | docs-engine | ✕ | ✕ | Test | Prod |
| Firewall | firewall | ✕ | Test | ||
| Gateway | gateway | ✕ | Test | ||
| HTTP3 | http3 | Test | |||
| Image Resizing | images | ✕ | Test | ||
| Life of a Request | internet | ✕ | Test | ||
| Load Balancing | load-balancing | ✕ | Test | ||
| Logs | logs | ✕ | Test | ||
| Magic Transit | magic-transit | ✕ | Test | ||
| Mobile SDK | mobile-sdk | ✕ | Test | ||
| Network Interconnect | network-interconnect | ✕ | Test | ||
| Randomness Beacon | randomness-beacon | ✕ | Test | ||
| Registrar | registrar | ✕ | Test | ||
| Spectrum | spectrum | ✕ | Started | Test | |
| SSL | ssl | ✕ | Test | ||
| Stream | stream | ✕ | Started | Test | |
| Tenant | tenant | Test | |||
| Terraform | terraform | ✕ | ✕ | Test | Prod |
| Time Services | time-services | ✕ | Test | ||
| WAF | waf | ✕ | Test | ||
| Workers | workers | ✕ | ✕ | Test | Prod |
Notes:
- Not a Cloudflare “product”, the documentation for the Docs Engine itself.