Skip to content
Snippets Groups Projects
Normal view Permalink
README.md 5.3 KiB
Newer Older
Adam Schwartz's avatar
basic readme
Adam Schwartz committed
1 2 
# Cloudflare Docs
Adam Schwartz's avatar
Update README.md  
Adam Schwartz committed
3 4 5 
## Developing

(Note: Although it works, this process is still a bit of a WIP.)
Adam Schwartz's avatar
basic readme
Adam Schwartz committed
6 7 8 9 10 11 12 13 

Clone the engine somewhere and set it up to be NPM linked:

```bash
git clone git@github.com:adamschwartz/cloudflare-docs-engine.git
npm link
```
Adam Schwartz's avatar
Update README.md  
Adam Schwartz committed
14 15 16 17 18 19 20 21 
(Note: This will soon be moved to the @cloudflare org.)

Clone this repo.

```bash
git clone git@github.com:cloudflare/cloudflare-docs.git
```
Adam Schwartz's avatar
basic readme
Adam Schwartz committed
22 23 24 
For each product, `cd` into `products/$productName` and then run:

```bash
Adam Schwartz's avatar
Update README.md  
Adam Schwartz committed
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 
npm link cloudflare-docs-engine && npm run bootstrap && npm run develop
```

## Publishing

Each [product](https://github.com/cloudflare/cloudflare-docs/tree/master/products)’s docs are automatically deployed via [@cloudflare/wrangler](https://github.com/cloudflare/wrangler) using Github Actions.

Test environment deploys to:

```txt
https://$pathPrefix.cloudflare-docs.workers.dev/$pathPrefix/
```

Prod environment deploys to:

```txt
https://developers.cloudflare.com/$pathPrefix/
Adam Schwartz's avatar
basic readme
Adam Schwartz committed
42 43 
```
Adam Schwartz's avatar
add migration progress to readme  
Adam Schwartz committed
44 45 
## Migration progress
Adam Schwartz's avatar
update test URLs in readme  
Adam Schwartz committed
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 
| Product                 | `pathPrefix`         | Icon | Content | Test                                                                                  | Prod |
| :---------------------- | :------------------- | :--- | :------ | :------------------------------------------------------------------------------------ | :--- |
| 1.1.1.1                 | 1-1-1-1              | ✕    |         | [Test](https://1-1-1-1.cloudflare-docs.workers.dev/1-1-1-1)                           |      |
| Access                  | access               | ✕    |         | [Test](https://access.cloudflare-docs.workers.dev/access)                             |      |
| Analytics               | analytics            | ✕    |         | [Test](https://analytics.cloudflare-docs.workers.dev/analytics)                       |      |
| Argo Tunnel             | argo-tunnel          | ✕    |         | [Test](https://argo-tunnel.cloudflare-docs.workers.dev/argo-tunnel)                   |      |
| BYOIP                   | byoip                | ✕    |         | [Test](https://byoip.cloudflare-docs.workers.dev/byoip)                               |      |
| Distributed Web Gateway | distributed-web      | ✕    |         | [Test](https://distributed-web.cloudflare-docs.workers.dev/distributed-web)           |      |
| Firewall                | firewall             | ✕    |         | [Test](https://firewall.cloudflare-docs.workers.dev/firewall)                         |      |
| Gateway                 | gateway              | ✕    |         | [Test](https://gateway.cloudflare-docs.workers.dev/gateway)                           |      |
| HTTP3                   | http3                |      |         | [Test](https://http3.cloudflare-docs.workers.dev/http3)                               |      |
| Image Resizing          | images               | ✕    |         | [Test](https://images.cloudflare-docs.workers.dev/images)                             |      |
| Life of a Request       | internet             | ✕    |         | [Test](https://internet.cloudflare-docs.workers.dev/internet)                         |      |
| Load Balancing          | load-balancing       | ✕    |         | [Test](https://load-balancing.cloudflare-docs.workers.dev/load-balancing)             |      |
| Logs                    | logs                 | ✕    |         | [Test](https://logs.cloudflare-docs.workers.dev/logs)                                 |      |
| Magic Transit           | magic-transit        | ✕    |         | [Test](https://magic-transit.cloudflare-docs.workers.dev/magic-transit)               |      |
| Mobile SDK              | mobile-sdk           | ✕    |         | [Test](https://mobile-sdk.cloudflare-docs.workers.dev/mobile-sdk)                     |      |
| Network Interconnect    | network-interconnect | ✕    |         | [Test](https://network-interconnect.cloudflare-docs.workers.dev/network-interconnect) |      |
| Randomness Beacon       | randomness-beacon    | ✕    |         | [Test](https://randomness-beacon.cloudflare-docs.workers.dev/randomness-beacon)       |      |
| Registrar               | registrar            | ✕    |         | [Test](https://registrar.cloudflare-docs.workers.dev/registrar)                       |      |
| Spectrum                | spectrum             | ✕    | Started | [Test](https://spectrum.cloudflare-docs.workers.dev/spectrum)                         |      |
| SSL                     | ssl                  | ✕    |         | [Test](https://ssl/ssl-tls.cloudflare-docs.workers.dev/ssl/ssl-tls)                   |      |
| Stream                  | stream               | ✕    | Started | [Test](https://stream.cloudflare-docs.workers.dev/stream)                             |      |
| Tenant                  | tenant               |      |         | [Test](https://tenant.cloudflare-docs.workers.dev/tenant)                             |      |
| Terraform               | terraform            | ✕    | Started | [Test](https://terraform.cloudflare-docs.workers.dev/terraform)                       |      |
| Time Services           | time-services        | ✕    |         | [Test](https://time-services.cloudflare-docs.workers.dev/time-services)               |      |
| WAF                     | waf                  | ✕    |         | [Test](https://waf.cloudflare-docs.workers.dev/waf)                                   |      |