Skip to content

Commit e8ee332

Browse files
committed
Fix case of GitHub
Change `Github` to `GitHub`
1 parent 0bc0a92 commit e8ee332

File tree

15 files changed

+25
-25
lines changed

15 files changed

+25
-25
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ npm link cloudflare-docs-engine && npm run bootstrap && npm run develop
2727

2828
## Publishing
2929

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.
3131

3232
Test environment deploys to:
3333

products/argo-tunnel/src/content/use-cases/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,4 @@ To do this, [download](../downloads/) the Mac, Linux or Windows version of Tunne
2121

2222
## Webhooks In Development Environments
2323

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.

products/docs-engine/src/content/contributing/development-setup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,6 @@ At this point, you can make changes to the Markdown files inside the contect dir
6161

6262
<Aside>
6363

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.
6565

6666
</Aside>

products/docs-engine/src/content/how-it-works.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ order: 1
66

77
<Aside>
88

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.
1010

1111
</Aside>
1212

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).
1414

1515
--------------------------------
1616

@@ -99,7 +99,7 @@ Many of the other fields are self-explanatory. See [Configuration](/reference/co
9999

100100
### 3. wrangler.toml
101101

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).
103103

104104
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/).
105105

@@ -167,7 +167,7 @@ Here’s a minimal example site built with Docs Engine:
167167
`}}/>
168168
</div></div></div>
169169

170-
__[Open demo](https://docs-engine-example.adam.workers.dev)__ · ([Github](https://github.com/adamschwartz/docs-engine-example))
170+
__[Open demo](https://docs-engine-example.adam.workers.dev)__ · ([GitHub](https://github.com/adamschwartz/docs-engine-example))
171171

172172
--------------------------------
173173

products/docs-engine/src/content/how-to-guides/contribute-to-a-product.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ order: 1
66

77
<Aside>
88

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.
1010

1111
</Aside>
1212

@@ -18,7 +18,7 @@ A product has been migrated if it is listed in the [migration table](https://git
1818

1919
## Two ways to contibute
2020

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.
2222

2323
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).
2424

products/docs-engine/src/content/how-to-guides/migrate-a-product.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,17 @@ order: 0
66

77
<Aside>
88

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.
1010

1111
</Aside>
1212

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.
1414

1515
--------------------------------
1616

1717
## Prerequisites
1818

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.
2020

2121
It also assumes you have read through [how the Docs Engine works](/how-it-works).
2222

@@ -82,7 +82,7 @@ The next thing you’ll want to do is get a local development setup going.
8282

8383
<Aside>
8484

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.
8686

8787
</Aside>
8888

@@ -99,7 +99,7 @@ In terms of improving/updating the content itself, there are a number of great r
9999
- [__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.
100100

101101

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.
103103

104104

105105
## Step 4: Deploy your new site
@@ -108,7 +108,7 @@ This is still being worked out, but in essence, this requires three easy steps (
108108

109109
1. Uncomment a few lines inside your `wrangler.toml` file to enable `[env.production]`.
110110

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).
112112

113113
3. Make a pull request to remove the corresponding content from inside Bitbucket (`@DOCS/developer-docs/browse/src/content`).
114114

products/docs-engine/src/content/how-to-guides/set-up-a-new-repo.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Here’s a minimal example site built with Docs Engine:
2424

2525
__[Open demo](https://docs-engine-example.adam.workers.dev)__
2626

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).
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).
2828

2929
--------------------------------
3030

products/docs-engine/src/content/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Documentation for the __Docs Engine__ which powers Cloudflare’s developer docs
1212

1313
The engine is built with [Gatsby](https://www.gatsbyjs.com/), and makes generous use of custom [MDX components](/markdown).
1414

15-
It’s __open-source__ and [available on Github](https://github.com/cloudflare/cloudflare-docs-engine).
15+
It’s __open-source__ and [available on GitHub](https://github.com/cloudflare/cloudflare-docs-engine).
1616

1717
<p><Link to="/how-it-works" class="Button Button-is-docs-primary">How it works</Link> &nbsp; <Link to="/faq" class="Button Button-is-docs-secondary">FAQ</Link></p>
1818

@@ -22,7 +22,7 @@ It’s __open-source__ and [available on Github](https://github.com/cloudflare/c
2222

2323
<TableWrap>
2424

25-
| Docs site | Github |
25+
| Docs site | GitHub |
2626
|------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------|
2727
| [Workers](https://developers.cloudflare.com/workers/) | [@cloudflare/cloudflare-docs/.../workers](https://github.com/cloudflare/cloudflare-docs/tree/master/products/workers) |
2828
| [Docs Engine](https://docs-engine-docs.adam.workers.dev/) — This site. | [@cloudflare/cloudflare-docs/.../docs-engine](https://github.com/cloudflare/cloudflare-docs/tree/master/products/docs-engine) |

products/docs-engine/src/content/reference/configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Create a `docs-config.js` file which exports (by setting `module.exports`) a Jav
2424
- 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.
2525

2626
- `contentRepo` <Type>string</Type> <PropMeta>required</PropMeta>
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.
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.
2828

2929
- `contentRepoFolder` <Type>string</Type> <PropMeta>optional</PropMeta>
3030
- 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"`.

products/logs/src/content/analytics-integrations/elastic/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Cloudflare logs are HTTP/HTTPS request logs in JSON format and are gathered from
5252
</a>
5353
Before getting Cloudflare logs into Elastic:
5454

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).
5656

5757
2. Upload the _cloudflare-elastic-lambda.zip_ file to an S3 bucket.
5858

0 commit comments

Comments
 (0)