Skip to content

Commit 4b3ace2

Browse files
authored
Merge pull request #6 from cloudflare/readme-codeowners
Codeowners + README
2 parents 101e962 + 6ce2257 commit 4b3ace2

File tree

9 files changed

+24
-1
lines changed

9 files changed

+24
-1
lines changed

.github/CODEOWNERS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @cloudflare/developer-relations

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,25 @@
11
# docs-examples
22

33
This repo holds examples that are used in the [Cloudflare docs](https://developers.cloudflare.com) (and it's accompanying [GitHub repo](https://github.com/cloudflare/cloudflare-docs)).
4+
5+
## When to use
6+
7+
Use this repository when you want to use our [GitHubCode](https://developers.cloudflare.com/style-guide/components/github-code/) component within the Cloudflare docs.
8+
9+
We choose to scope this component solely to repos within the `cloudflare` org for security reasons.
10+
11+
## How to use
12+
13+
For any examples related to a specific product, create a new, top-level folder for that product.
14+
15+
Make sure you have the following files in your Worker:
16+
17+
- `.gitignore`
18+
- `package.json`
19+
- `wrangler.jsonc`
20+
- Everything under `src`
21+
- `worker-configuration.d.ts`
22+
- `tsconfig.json`
23+
- `static/README`
24+
25+
Also, you should make your Worker using `TypeScript`. We can always detype to use JavaScript.
File renamed without changes.
File renamed without changes.
File renamed without changes.

kv-get-started/static/README.md renamed to kv/kv-get-started/static/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22

33
This is a test example for [KV Get Started](https://developers.cloudflare.com/kv/get-started/).
44

5-
[![Deploy to Workers](https://deploy.workers.cloudflare.com/button)](https://deploy.workers.cloudflare.com/?url=https://github.com/cloudflare/docs-examples/tree/main/kv-get-started)
5+
[![Deploy to Workers](https://deploy.workers.cloudflare.com/button)](https://deploy.workers.cloudflare.com/?url=https://github.com/cloudflare/docs-examples/tree/main/kv/kv-get-started)
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)