-
Notifications
You must be signed in to change notification settings - Fork 10.4k
[Workers] Add documentation for cf-tutor tool #17627
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
b19a3c3
Add documentation for cf-tutor tool
db-cloudflare 7480c1f
Add beta tag
db-cloudflare 3dd9194
Add beta tag.
db-cloudflare d7029d9
Fix links to cf-tutor docs
db-cloudflare 88a9a1d
Fix links
db-cloudflare 7a4eaab
Update download from browser steps
db-cloudflare 40b76ce
Add full stop
db-cloudflare 25b207b
Fix beta tag
db-cloudflare 4be72a1
Update src/content/docs/workers/get-started/cf-tutor.mdx
db-cloudflare c18e81c
Update src/content/docs/workers/get-started/cf-tutor.mdx
db-cloudflare b724b57
Update src/content/partials/workers/cf-tutor.mdx
db-cloudflare f36f907
Update src/content/partials/workers/cf-tutor.mdx
db-cloudflare File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| --- | ||
| title: CLI guided learning | ||
| pcx_content_type: get-started | ||
| sidebar: | ||
| order: 2 | ||
| badge: | ||
| text: Beta | ||
| head: | ||
| - tag: title | ||
| content: Get started - CLI guided learning | ||
| --- | ||
|
|
||
| import { Badge, Render } from "~/components"; | ||
|
|
||
| Cloudflare CLI tutor, or `cf-tutor`, is a guided learning experience within your terminal. If you are unfamiliar with Workers, or are new to command line interface (CLI) based development, cf-tutor offers an introduction on how to use Workers with other Cloudflare products through your terminal. | ||
|
|
||
| `cf-tutor` is currently a beta application in pre-release. To download the application, you can use the `git clone` in your terminal, or download the application from the releases page on the project repo. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| <Render file="prereqs" product="workers" /> | ||
|
|
||
| ## How to run | ||
|
|
||
| <Render file="cf-tutor" product="workers" /> | ||
|
|
||
| ## Next steps | ||
|
|
||
| To do more: | ||
|
|
||
| - Visit the [Cloudflare dashboard](https://dash.cloudflare.com/) for simpler editing. | ||
| - Learn how to [test and debug](/workers/testing/) your Workers. | ||
| - Read about [Workers limits and pricing](/workers/platform/). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| --- | ||
| {} | ||
| --- | ||
|
|
||
| import { TabItem, Tabs } from "~/components"; | ||
|
|
||
| <Tabs> | ||
|
|
||
| <TabItem label="Git clone HTTPS"> | ||
|
|
||
| 1. Open a terminal window. | ||
| 2. In your terminal, navigate to the folder you wish to install cf-tutor. You can change directory by using the `cd` command followed by the folder path. You can either enter the full path such as `cd Documents/Projects/ ` or you can use `cd` multiple times to go folder by folder. To see the files and folders in the directory you are currently in, run `ls`. | ||
| 3. Run the command `git clone https://github.com/db-cloudflare/cf-tutor.git` to download cf-tutor. | ||
| 4. Run the command `cd cf-tutor` to enter the application folder. | ||
| 5. Run the command `npm i` to install all dependendant packages. | ||
| 6. Once the dependencies have installed, run `npm start ` to run the application | ||
|
|
||
| </TabItem> | ||
|
|
||
| <TabItem label="Git clone SSH"> | ||
|
|
||
| The following steps require an SSH key. Vist [GitHub documentation on Connecting with SSH to learn more](https://docs.github.com/en/authentication/connecting-to-github-with-ssh) | ||
|
|
||
| 1. Open a terminal window. | ||
| 2. In your terminal, navigate to the folder you wish to install cf-tutor. You can change directory by using the `cd` command followed by the folder path. You can either enter the full path such as `cd Documents/Projects/ ` or you can use `cd` multiple times to go folder by folder. To see the files and folders in the directory you are currently in, run `ls`. | ||
| 3. Run the command `git clone git@github.com:db-cloudflare/cf-tutor.git` and enter your SSH key to download cf-tutor. | ||
| 4. Run the command `cd cf-tutor` to enter the application folder. | ||
| 5. Run the command `npm i` to install all dependendant packages. | ||
| 6. Once the dependencies have installed, run `npm start ` to run the application | ||
|
|
||
| </TabItem> | ||
|
|
||
| <TabItem label="Download from browser"> | ||
|
|
||
| 1. Open [cf-tutor releases](https://github.com/db-cloudflare/cf-tutor/releases). | ||
| 2. Download the cf-tutor.zip file and extract the folder inside it into your desired location. | ||
| 3. In your terminal, navigate to the cf-tutor folder. You can change directory by using the `cd` command followed by the folder path. You can either enter the full path such as `cd Documents/Projects/cf-tutor` or you can use `cd` multiple times to go folder by folder. To see the files and folders in the directory you are currently in, run `ls`. | ||
| 4. Run the command `npm i` to install all dependendant packages. | ||
| 5. Once the dependencies have installed, run `npm start ` to run the application. | ||
|
|
||
| </TabItem> </Tabs> | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.