You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,7 +27,7 @@ npm link cloudflare-docs-engine && npm run bootstrap && npm run develop
27
27
28
28
## Publishing
29
29
30
-
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.
30
+
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.
Copy file name to clipboardExpand all lines: products/argo-tunnel/src/content/use-cases/index.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,4 +21,4 @@ To do this, [download](../downloads/) the Mac, Linux or Windows version of Tunne
21
21
22
22
## Webhooks In Development Environments
23
23
24
-
When developing an application that uses webhooks (such as building an app for [Github](https://developer.github.com/webhooks/), [Slack](https://api.slack.com/incoming-webhooks) or [Stripe](https://stripe.com/docs/webhooks)) you can use Tunnel to run a webhook endpoint from your local environment. Once you run Tunnel on your computer, Tunnel will expose a public URL that you can set as your webhook endpoint. Tunnel will forward all requests to that endpoint to your local development environment.
24
+
When developing an application that uses webhooks (such as building an app for [GitHub](https://developer.github.com/webhooks/), [Slack](https://api.slack.com/incoming-webhooks) or [Stripe](https://stripe.com/docs/webhooks)) you can use Tunnel to run a webhook endpoint from your local environment. Once you run Tunnel on your computer, Tunnel will expose a public URL that you can set as your webhook endpoint. Tunnel will forward all requests to that endpoint to your local development environment.
Copy file name to clipboardExpand all lines: products/docs-engine/src/content/contributing/development-setup.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -61,6 +61,6 @@ At this point, you can make changes to the Markdown files inside the contect dir
61
61
62
62
<Aside>
63
63
64
-
__Note:__ Unfortunately, for now you’ll need to stop and restart `npm run develop` every time you make changes. This is something we’re urgently looking to fix and can be tracked [in this Github issue](https://github.com/cloudflare/cloudflare-docs-engine/issues/279), which also includes a workaround which may help in the interim.
64
+
__Note:__ Unfortunately, for now you’ll need to stop and restart `npm run develop` every time you make changes. This is something we’re urgently looking to fix and can be tracked [in this GitHub issue](https://github.com/cloudflare/cloudflare-docs-engine/issues/279), which also includes a workaround which may help in the interim.
Copy file name to clipboardExpand all lines: products/docs-engine/src/content/how-it-works.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,11 +6,11 @@ order: 1
6
6
7
7
<Aside>
8
8
9
-
__Note for Cloudflare employees:__ The details of this process are still being worked out. For the time being, please do not migrate any Cloudflare products without first checking in Adam ([[email protected]](mailto:[email protected]), [@adamschwartz on Github](https://github.com/adamschwartz)). Thanks for your patience.
9
+
__Note for Cloudflare employees:__ The details of this process are still being worked out. For the time being, please do not migrate any Cloudflare products without first checking in Adam ([[email protected]](mailto:[email protected]), [@adamschwartz on GitHub](https://github.com/adamschwartz)). Thanks for your patience.
10
10
11
11
</Aside>
12
12
13
-
In short, docs sites built with the Cloudflare Docs Engine are [Gatsby](https://www.gatsbyjs.com) sites with a bunch of [custom MDX components](/markdown) and a shell UI you that’s consistent across products, all deployed as a [Workers Sites project](https://workers.cloudflare.com/sites) via the [Wrangler Github Action](https://github.com/cloudflare/wrangler-action).
13
+
In short, docs sites built with the Cloudflare Docs Engine are [Gatsby](https://www.gatsbyjs.com) sites with a bunch of [custom MDX components](/markdown) and a shell UI you that’s consistent across products, all deployed as a [Workers Sites project](https://workers.cloudflare.com/sites) via the [Wrangler GitHub Action](https://github.com/cloudflare/wrangler-action).
14
14
15
15
--------------------------------
16
16
@@ -99,7 +99,7 @@ Many of the other fields are self-explanatory. See [Configuration](/reference/co
99
99
100
100
### 3. wrangler.toml
101
101
102
-
Each docs site is deployed as a [Workers Sites project](https://workers.cloudflare.com/sites) via a [Wrangler Github Action](https://github.com/cloudflare/wrangler-action).
102
+
Each docs site is deployed as a [Workers Sites project](https://workers.cloudflare.com/sites) via a [Wrangler GitHub Action](https://github.com/cloudflare/wrangler-action).
103
103
104
104
To set this up, you’ll need to [configure your `wrangler.toml`](https://developers.cloudflare.com/workers/cli-wrangler/configuration#keys) file just as you would any other [Workers Sites project](https://developers.cloudflare.com/workers/platform/sites/).
105
105
@@ -167,7 +167,7 @@ Here’s a minimal example site built with Docs Engine:
Copy file name to clipboardExpand all lines: products/docs-engine/src/content/how-to-guides/contribute-to-a-product.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ order: 1
6
6
7
7
<Aside>
8
8
9
-
__Note for Cloudflare employees:__ The details of this process are still being worked out. For the time being, please do not migrate any Cloudflare products without first checking in with Adam ([[email protected]](mailto:[email protected]), [@adamschwartz on Github](https://github.com/adamschwartz)). Thanks for your patience.
9
+
__Note for Cloudflare employees:__ The details of this process are still being worked out. For the time being, please do not migrate any Cloudflare products without first checking in with Adam ([[email protected]](mailto:[email protected]), [@adamschwartz on GitHub](https://github.com/adamschwartz)). Thanks for your patience.
10
10
11
11
</Aside>
12
12
@@ -18,7 +18,7 @@ A product has been migrated if it is listed in the [migration table](https://git
18
18
19
19
## Two ways to contibute
20
20
21
-
1. For small changes, simply find the `.md` file you want to modify inside the product’s `src/content/` directory. The `Edit on Github` link in the footer of every deployed page will automatically link you there.
21
+
1. For small changes, simply find the `.md` file you want to modify inside the product’s `src/content/` directory. The `Edit on GitHub` link in the footer of every deployed page will automatically link you there.
22
22
23
23
2. For larger changes, or changes made to multiple files at once, you’ll want to set up a local development environment, which you can do by [following these steps](/how-to-guides/migrate-a-product#step-2-set-up-local-development).
Copy file name to clipboardExpand all lines: products/docs-engine/src/content/how-to-guides/migrate-a-product.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,17 +6,17 @@ order: 0
6
6
7
7
<Aside>
8
8
9
-
__Note for Cloudflare employees:__ The details of this process are still being worked out. For the time being, please do not migrate any Cloudflare products without first checking in with Adam ([[email protected]](mailto:[email protected]), [@adamschwartz on Github](https://github.com/adamschwartz)). Thanks for your patience.
9
+
__Note for Cloudflare employees:__ The details of this process are still being worked out. For the time being, please do not migrate any Cloudflare products without first checking in with Adam ([[email protected]](mailto:[email protected]), [@adamschwartz on GitHub](https://github.com/adamschwartz)). Thanks for your patience.
10
10
11
11
</Aside>
12
12
13
-
This document is intended to help __Cloudflare employees__ migrate [existing docs sites](https://developers.cloudflare.com/docs/) to the [`products/` folder](https://github.com/cloudflare/cloudflare-docs/tree/master/products) inside the [@cloudflare/cloudflare-docs](https://github.com/cloudflare/cloudflare-docs) repo on Github.
13
+
This document is intended to help __Cloudflare employees__ migrate [existing docs sites](https://developers.cloudflare.com/docs/) to the [`products/` folder](https://github.com/cloudflare/cloudflare-docs/tree/master/products) inside the [@cloudflare/cloudflare-docs](https://github.com/cloudflare/cloudflare-docs) repo on GitHub.
14
14
15
15
--------------------------------
16
16
17
17
## Prerequisites
18
18
19
-
This document assumes a basic understanding of software development, how Github works, as well as familiarity with the Markdown syntax and YAML frontmatter.
19
+
This document assumes a basic understanding of software development, how GitHub works, as well as familiarity with the Markdown syntax and YAML frontmatter.
20
20
21
21
It also assumes you have read through [how the Docs Engine works](/how-it-works).
22
22
@@ -82,7 +82,7 @@ The next thing you’ll want to do is get a local development setup going.
82
82
83
83
<Aside>
84
84
85
-
__Note:__ Unfortunately, for now you’ll need to stop and restart `npm run develop` every time you make changes. This is something we’re urgently looking to fix and can be tracked [in this Github issue](https://github.com/cloudflare/cloudflare-docs-engine/issues/279), which also includes a workaround which may help in the interim.
85
+
__Note:__ Unfortunately, for now you’ll need to stop and restart `npm run develop` every time you make changes. This is something we’re urgently looking to fix and can be tracked [in this GitHub issue](https://github.com/cloudflare/cloudflare-docs-engine/issues/279), which also includes a workaround which may help in the interim.
86
86
87
87
</Aside>
88
88
@@ -99,7 +99,7 @@ In terms of improving/updating the content itself, there are a number of great r
99
99
-[__Workers docs site__ example](https://developers.cloudflare.com/workers) – You can also take a look at the [Workers content](https://github.com/cloudflare/cloudflare-docs/tree/4fd3a4af9507b20bb23fea4d7c4f4cd349c0f463/products/workers/src/content) for an example of a well-structured docs site.
100
100
101
101
102
-
- Feel free to [@adamschwartz](https://github.com/adamschwartz) in an issue on Github, or DM @afs in chat.
102
+
- Feel free to [@adamschwartz](https://github.com/adamschwartz) in an issue on GitHub, or DM @afs in chat.
103
103
104
104
105
105
## Step 4: Deploy your new site
@@ -108,7 +108,7 @@ This is still being worked out, but in essence, this requires three easy steps (
108
108
109
109
1. Uncomment a few lines inside your `wrangler.toml` file to enable `[env.production]`.
110
110
111
-
2. Add a second `wrangler publish` with the new `production` environment in the Github Action [`deploy.yml` file](https://github.com/cloudflare/cloudflare-docs/blob/4fd3a4af9507b20bb23fea4d7c4f4cd349c0f463/.github/workflows/deploy.yml).
111
+
2. Add a second `wrangler publish` with the new `production` environment in the GitHub Action [`deploy.yml` file](https://github.com/cloudflare/cloudflare-docs/blob/4fd3a4af9507b20bb23fea4d7c4f4cd349c0f463/.github/workflows/deploy.yml).
112
112
113
113
3. Make a pull request to remove the corresponding content from inside Bitbucket (`@DOCS/developer-docs/browse/src/content`).
To try it yourself, fork the [example repo on Github](https://github.com/adamschwartz/docs-engine-example), and then [set up a dev environment](/contributing/development-setup).
27
+
To try it yourself, fork the [example repo on GitHub](https://github.com/adamschwartz/docs-engine-example), and then [set up a dev environment](/contributing/development-setup).
Copy file name to clipboardExpand all lines: products/docs-engine/src/content/reference/configuration.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,7 +24,7 @@ Create a `docs-config.js` file which exports (by setting `module.exports`) a Jav
24
24
- The logo for the docs site, represented as the SVG `<path/>`[`d` attribute](https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/d) for an inline SVG element with `viewBox="0 0 48 48"`. The example `"M8 8h32v32h-32v-32z"` would draw a solid `32px` square centered inside the `48px` square space.
- The Github repo (e.g. `"cloudflare/cloudflare-docs"`) used to for example construct the the “Edit on Github” links displayed in each docs page’s footer.
27
+
- The GitHub repo (e.g. `"cloudflare/cloudflare-docs"`) used to for example construct the the “Edit on GitHub” links displayed in each docs page’s footer.
- By default the engine assumes that a docs site’s structure is placed in the root of a project repo. However, this whole structure can also be placed inside any sub-folder by setting this property. For example, this site’s content is inside the [`products/docs-engine` folder](https://github.com/cloudflare/cloudflare-docs/tree/4fd3a4af9507b20bb23fea4d7c4f4cd349c0f463/products/docs-engine) of [@cloudflare/cloudflare-docs](https://github.com/cloudflare/cloudflare-docs) so its `"products/docs-engine"`.
Copy file name to clipboardExpand all lines: products/logs/src/content/analytics-integrations/elastic/index.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -52,7 +52,7 @@ Cloudflare logs are HTTP/HTTPS request logs in JSON format and are gathered from
52
52
</a>
53
53
Before getting Cloudflare logs into Elastic:
54
54
55
-
1. Install an AWS Lambda function, available in the file _cloudflare-elastic-lambda.zip_ from Github at this location: [https://github.com/cloudflare/cloudflare-elastic/releases/tag/v0.3-7.x](https://github.com/cloudflare/cloudflare-elastic/releases/tag/v0.3-7.x).
55
+
1. Install an AWS Lambda function, available in the file _cloudflare-elastic-lambda.zip_ from GitHub at this location: [https://github.com/cloudflare/cloudflare-elastic/releases/tag/v0.3-7.x](https://github.com/cloudflare/cloudflare-elastic/releases/tag/v0.3-7.x).
56
56
57
57
2. Upload the _cloudflare-elastic-lambda.zip_ file to an S3 bucket.
0 commit comments