Skip to content

Commit

Permalink
chore: update readme (cloudflare#3622)
Browse files Browse the repository at this point in the history 
* Update README.md

Update README with new instructions post-merge of cloudflare#3609

* update hugo versions

Co-authored-by: Luke Edwards <luke.edwards05@gmail.com>
  • Loading branch information
@kristianfreeman @lukeed
kristianfreeman and lukeed authored Feb 25, 2022
1 parent 6f62e52 commit 2caeae0
Showing 1 changed file with 43 additions and 53 deletions.
96 changes: 43 additions & 53 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,68 +1,58 @@
# Cloudflare Docs

**[View the docs →](https://developers.cloudflare.com/docs/)**
**[View the docs →](https://developers.cloudflare.com/)**

[Contribute to the docs](https://developers.cloudflare.com/docs-engine/contributing/to-cloudflare-docs)
[Contribute to the docs](https://github.com/cloudflare/cloudflare-docs/blob/production/CONTRIBUTING.md)

[Set up local development](https://developers.cloudflare.com/docs-engine/contributing/development-setup)
## Setup

## For Cloudflare employees
You must have [Hugo](https://gohugo.io) installed on your system and available in your `$PATH` as a global binary. Most operating systems are supported – follow the relevant [Install Hugo](https://gohugo.io/getting-started/installing) instructions for your operating system guides to get started.

To get write access to this repo, please reach out to the **Developer Docs** room in chat.
> **Important:** This project is built with version `0.92.2+extended` but `0.92.x` is the minimum required version. You may (probably) use a newer version of Hugo, but will be subject to any Hugo changes.
## Products

| Product | `pathPrefix` | Test | Prod |
| :------------------------------ | :------------------------------ | :---------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------ |
| 1.1.1.1 | 1.1.1.1 | [Test](https://1-1-1-1.cloudflare-docs.workers.dev/1.1.1.1) | [Prod](https://developers.cloudflare.com/1.1.1.1) |
| Analytics | analytics | [Test](https://analytics.cloudflare-docs.workers.dev/analytics) | [Prod](https://developers.cloudflare.com/analytics) |
| API | api | [Test](https://api.cloudflare-docs.workers.dev/api) | [Prod](https://developers.cloudflare.com/api) |
| Automatic Platform Optimization | automatic-platform-optimization | [Test](https://automatic-platform-optimization.cloudflare-docs.workers.dev/automatic-platform-optimization) | [Prod](https://developers.cloudflare.com/automatic-platform-optimization) |
| Bots | bots | [Test](https://bots.cloudflare-docs.workers.dev/bots) | [Prod](https://developers.cloudflare.com/bots) |
| BYOIP | byoip | [Test](https://byoip.cloudflare-docs.workers.dev/byoip) | [Prod](https://developers.cloudflare.com/byoip) |
| Cache | cache | [Test](https://cache.cloudflare-docs.workers.dev/cache/) | [Prod](https://developers.cloudflare.com/cache/) |
| Cloudflare One | cloudflare-one | [Test](https://cloudflare-one.cloudflare-docs.workers.dev/cloudflare-one) | [Prod](https://developers.cloudflare.com/cloudflare-one) |
| DDoS Protection | ddos-protection | [Test](https://ddos-protection.cloudflare-docs.workers.dev/ddos-protection) | [Prod](https://developers.cloudflare.com/ddos-protection) |
| Distributed Web Gateway | distributed-web | [Test](https://distributed-web.cloudflare-docs.workers.dev/distributed-web) | [Prod](https://developers.cloudflare.com/distributed-web) |
| Docs Engine | docs-engine | [Test](https://docs-engine.cloudflare-docs.workers.dev/docs-engine) | [Prod](https://developers.cloudflare.com/docs-engine) |
| Email Routing | email-routing | [Test](https://email-routing.cloudflare-docs.workers.dev/email-routing) | [Prod](https://developers.cloudflare.com/email-routing) |
| Events | events | [Test](https://events.cloudflare-docs.workers.dev/events) | [Prod](https://developers.cloudflare.com/events) |
| Firewall | firewall | [Test](https://firewall.cloudflare-docs.workers.dev/firewall) | [Prod](https://developers.cloudflare.com/firewall) |
| Fundamentals | fundamentals | [Test](https://fundamentals.cloudflare-docs.workers.dev/fundamentals) | [Prod](https://developers.cloudflare.com/fundamentals) |
| HTTP/3 | http3 | [Test](https://http3.cloudflare-docs.workers.dev/http3) | [Prod](https://developers.cloudflare.com/http3) |
| Image Optimization | images | [Test](https://images.cloudflare-docs.workers.dev/images) | [Prod](https://developers.cloudflare.com/images) |
| Load Balancing | load-balancing | [Test](https://load-balancing.cloudflare-docs.workers.dev/load-balancing) | [Prod](https://developers.cloudflare.com/load-balancing) |
| Logs | logs | [Test](https://logs.cloudflare-docs.workers.dev/logs) | [Prod](https://developers.cloudflare.com/logs) |
| Magic Firewall | magic-firewall | [Test](https://magic-firewall.cloudflare-docs.workers.dev/magic-firewall) | [Prod](https://developers.cloudflare.com/magic-firewall) |
| Magic Transit | magic-transit | [Test](https://magic-transit.cloudflare-docs.workers.dev/magic-transit) | [Prod](https://developers.cloudflare.com/magic-transit) |
| Network Interconnect | network-interconnect | [Test](https://network-interconnect.cloudflare-docs.workers.dev/network-interconnect) | [Prod](https://developers.cloudflare.com/network-interconnect) |
| Pages | pages | [Test](https://pages.cloudflare-docs.workers.dev/pages) | [Prod](https://developers.cloudflare.com/pages) |
| Railgun | railgun | [Test](https://railgun.cloudflare-docs.workers.dev/railgun) | [Prod](https://developers.cloudflare.com/railgun) |
| Randomness Beacon | randomness-beacon | [Test](https://randomness-beacon.cloudflare-docs.workers.dev/randomness-beacon) | [Prod](https://developers.cloudflare.com/randomness-beacon) |
| Registrar | registrar | [Test](https://registrar.cloudflare-docs.workers.dev/registrar) | [Prod](https://developers.cloudflare.com/registrar) |
| Rules | rules | [Test](https://rules.cloudflare-docs.workers.dev/rules) | [Prod](https://developers.cloudflare.com/rules) |
| Ruleset Engine | ruleset-engine | [Test](https://ruleset-engine.cloudflare-docs.workers.dev/ruleset-engine) | [Prod](https://developers.cloudflare.com/ruleset-engine) |
| Security Center | security-center | [Test](https://security-center.cloudflare-docs.workers.dev/security-center) | [Prod](https://developers.cloudflare.com/security-center) |
| Spectrum | spectrum | [Test](https://spectrum.cloudflare-docs.workers.dev/spectrum) | [Prod](https://developers.cloudflare.com/spectrum) |
| SSL | ssl | [Test](https://ssl.cloudflare-docs.workers.dev/ssl) | [Prod](https://developers.cloudflare.com/ssl) |
| Stream | stream | [Test](https://stream.cloudflare-docs.workers.dev/stream) | [Prod](https://developers.cloudflare.com/stream) |
| Tenant | tenant | [Test](https://tenant.cloudflare-docs.workers.dev/tenant) | [Prod](https://developers.cloudflare.com/tenant) |
| Terraform | terraform | [Test](https://terraform.cloudflare-docs.workers.dev/terraform) | [Prod](https://developers.cloudflare.com/terraform) |
| Time Services | time-services | [Test](https://time-services.cloudflare-docs.workers.dev/time-services) | [Prod](https://developers.cloudflare.com/time-services) |
| WAF | waf | [Test](https://waf.cloudflare-docs.workers.dev/waf) | [Prod](https://developers.cloudflare.com/waf) |
| WARP Client | warp-client | [Test](https://warp-client.cloudflare-docs.workers.dev/warp-client) | [Prod](https://developers.cloudflare.com/warp-client) |
| Workers | workers | [Test](https://workers.cloudflare-docs.workers.dev/workers) | [Prod](https://developers.cloudflare.com/workers) |
| Zaraz | zaraz | [Test](https://zaraz.cloudflare-docs.workers.dev/zaraz) | [Prod](https://developers.cloudflare.com/zaraz) |
You must also have a recent version of Node.js (14+) installed. You may use [Volta](https://github.com/volta-cli/volta), a Node version manager, to install the latest version of Node and `npm`, which is a package manager that is included with `node`'s installation.

### Deployment
```sh
$ curl https://get.volta.sh | bash
$ volta install node
```

Finally, you will need to install the Node.js dependencies for this project using npm or another package manager:

```sh
$ npm install
```

## Development

When making changes to the site, including any content changes, you may run a local development server by running the following command:

```sh
$ npm run dev
```

Each [product](https://github.com/cloudflare/cloudflare-docs/tree/production/products)’s docs are automatically deployed via [@cloudflare/wrangler](https://github.com/cloudflare/wrangler) using GitHub Actions to both testing and production environments:
This spawns a server that will be accessible via `http://localhost:1313` in your browser. Additionally, any changes made within the project – including `content/**` changes – will automatically reload your browser tab(s), allowing you to instantly preview your changes!

```txt
TEST: https://$pathPrefix.cloudflare-docs.workers.dev/$pathPrefix/
PROD: https://developers.cloudflare.com/$pathPrefix/
Additionally, this project includes a CI step for ensuring consistent code style. This applies to all files within the project, including markdown (`*.md`) files, but will not affect the content itself or the content's output display. To see the style error(s), you may run:

```sh
$ npm run lint
```

Finally, some of these code-style errors may be fixed automatically. To do so, you may run:

```sh
$ npm run format
```

## For Cloudflare employees

To get write access to this repo, please reach out to the **Developer Docs** room in chat.

### Deployment

Our docs are deployed using [Cloudflare Pages](https://pages.cloudflare.com). Every commit pushed to production will automatically deploy to [developers.cloudflare.com](https://developers.cloudflare.com), and any pull requests opened will have a corresponding staging URL available in the pull request comments.

### License and Legal Notices

Except as otherwise noted, Cloudflare and any contributors grant you a license to the Cloudflare Developer Documentation and other content in this repository under the [Creative Commons Attribution 4.0 International Public License](https://creativecommons.org/licenses/by/4.0/legalcode), see the [LICENSE file](https://github.com/cloudflare/cloudflare-docs/blob/production/LICENSE), and grant you a license to any code in the repository under the [MIT License](https://opensource.org/licenses/MIT), see the [LICENSE-CODE file](https://github.com/cloudflare/cloudflare-docs/blob/production/LICENSE-CODE).
Expand Down

0 comments on commit 2caeae0

Please sign in to comment.