-
Notifications
You must be signed in to change notification settings - Fork 133
docs: Improve Quick Start section in the platform docs #1733
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
+145
−106
Merged
Changes from all commits
Commits
Show all changes
45 commits
Select commit
Hold shift + click to select a range
8620fe4
docs: Improve Quick Start flow
patrikbraborec 45c98ed
docs: Quick Start improvement - structure
patrikbraborec c301d94
Finish the first version of new quick start
patrikbraborec 29cae04
Refactor web ide journey
patrikbraborec 4e2332b
Add what you will learn section to web journey
patrikbraborec be1c2cf
Revert package-lock.json
patrikbraborec 33b0588
Fix lint errors
patrikbraborec 737d991
Fix lint errors
patrikbraborec 303324a
Update sources/platform/actors/development/quick_start/index.mdx
patrikbraborec d87b1a0
Update sources/platform/actors/development/quick_start/index.mdx
patrikbraborec 911b6da
Update sources/platform/actors/development/quick_start/index.mdx
patrikbraborec 424b2f9
Update sources/platform/actors/development/quick_start/index.mdx
patrikbraborec 44e4289
Update sources/platform/actors/development/quick_start/index.mdx
patrikbraborec 78056ba
Update sources/platform/actors/development/quick_start/start_locally.md
patrikbraborec 6cb41c3
Update sources/platform/actors/development/quick_start/start_locally.md
patrikbraborec b85ee81
Update sources/platform/actors/development/quick_start/start_web_ide.md
patrikbraborec 9ea064b
Update sources/platform/actors/development/quick_start/start_web_ide.md
patrikbraborec d3bf084
Update sources/platform/actors/development/quick_start/start_web_ide.md
patrikbraborec 508879f
Update sources/platform/actors/development/quick_start/start_locally.md
patrikbraborec 68197e0
Update sources/platform/actors/development/quick_start/start_locally.md
patrikbraborec 2b8139e
Update sources/platform/actors/development/quick_start/start_locally.md
patrikbraborec a9363a3
Fix PR comments
patrikbraborec 7840497
Fix lint errors
patrikbraborec 140e7a7
Remove title from quick start page
patrikbraborec 29b3c3b
Update sources/platform/actors/development/quick_start/index.mdx
patrikbraborec afbcabe
Update sources/platform/actors/development/quick_start/start_locally.md
patrikbraborec 3d88d00
Update sources/platform/actors/development/quick_start/start_locally.md
patrikbraborec 79818ac
Update sources/platform/actors/development/quick_start/start_locally.md
patrikbraborec ad65280
Update sources/platform/actors/development/quick_start/start_locally.md
patrikbraborec c80168b
Update sources/platform/actors/development/quick_start/start_locally.md
patrikbraborec c29c047
Update sources/platform/actors/development/quick_start/start_locally.md
patrikbraborec f22dc79
Update sources/platform/actors/development/quick_start/start_locally.md
patrikbraborec f83174b
Update sources/platform/actors/development/quick_start/start_locally.md
patrikbraborec 86cb0ee
Update sources/platform/actors/development/quick_start/start_locally.md
patrikbraborec ca0d675
Update sources/platform/actors/development/quick_start/start_locally.md
patrikbraborec 0c4ba41
Update sources/platform/actors/development/quick_start/start_locally.md
patrikbraborec 581b1e4
Update sources/platform/actors/development/quick_start/start_locally.md
patrikbraborec 462cf25
Update sources/platform/actors/development/quick_start/start_web_ide.md
patrikbraborec 1c842f0
Update sources/platform/actors/development/quick_start/start_web_ide.md
patrikbraborec 389b6f8
Update sources/platform/actors/development/quick_start/start_web_ide.md
patrikbraborec 9872c41
Update sources/platform/actors/development/quick_start/start_web_ide.md
patrikbraborec c4e15fd
Update sources/platform/actors/development/quick_start/start_web_ide.md
patrikbraborec e5f458b
Update sources/platform/actors/development/quick_start/start_web_ide.md
patrikbraborec 5dede40
Update sources/platform/actors/development/quick_start/start_web_ide.md
patrikbraborec 95760db
Fix links
patrikbraborec 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
46 changes: 26 additions & 20 deletions
46
sources/platform/actors/development/quick_start/index.mdx
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 |
|---|---|---|
| @@ -1,53 +1,59 @@ | ||
| --- | ||
| title: Quick start | ||
| sidebar_position: 1 | ||
| description: Create your first Actor using the Apify Console IDE or locally. | ||
| description: Create your first Actor using the Apify Web IDE or locally in your IDE. | ||
| slug: /actors/development/quick-start | ||
| --- | ||
|
|
||
| # Development: Quick start | ||
| import Card from "@site/src/components/Card"; | ||
| import CardGrid from "@site/src/components/CardGrid"; | ||
|
|
||
| **Create your first Actor using the Apify Console IDE or locally.** | ||
| **Create your first Actor using the Apify Web IDE or locally in your IDE.** | ||
|
|
||
| --- | ||
|
|
||
| :::note | ||
| :::info Before you build | ||
|
|
||
| Before you start building your own Actor, try out a couple of existing Actors from [Apify Store](https://apify.com/store). See the [Running Actors](../../running/index.md) section for more information on running existing Actors. | ||
|
|
||
| ::: | ||
|
|
||
| ## Language | ||
| ## Technology stack | ||
|
|
||
| Any code that can run inside of a Docker container can be turned into Apify [Actor](../../index.mdx). This gives you freedom in choosing your technical stack, including programming language and technologies. | ||
|
|
||
| But to fully benefit from running on top of the Apify platform, we recommend you choose either JavaScript/Node.js or Python, where Apify provides first-level support regarding its SDK, API clients, and learning materials. | ||
|
|
||
| For these languages, you can also choose from many code templates that help you to kickstart your project quickly: | ||
| For these languages, you can also [choose from many code templates](https://apify.com/templates) that help you to kickstart your project quickly. | ||
|
|
||
| <a href="https://apify.com/templates" target="_blank"> | ||
| <img src={require("./images/templates.png").default} width="70%" /> | ||
| </a> | ||
|  | ||
|
|
||
| ## [](#local-development)Local development | ||
| ## Development paths | ||
|
|
||
| You can create Actor in two ways: | ||
| You can develop Actor in two ways: | ||
|
|
||
| - Using the **Web IDE** in [Apify Console](https://console.apify.com). This is the fastest way to kick-start your Actor development and try out the Apify platform. | ||
| - Develop your Actor **locally** and only deploy to the Apify platform when it is production ready. This way, you benefit from your local setup for a better development and debugging experience. After you are done with the development, you can easily [deploy](./deployment) your Actor to Apify platform. | ||
| ### Local development | ||
|
|
||
| Now, let's start with: | ||
| Develop your Actor locally in your IDE and only deploy to the Apify platform when it is production ready. | ||
|
|
||
| import Card from "@site/src/components/Card"; | ||
| import CardGrid from "@site/src/components/CardGrid"; | ||
| This way, you benefit from your local setup for a better development and debugging experience. After you are done with the development, you can [deploy](./deployment) your Actor to the Apify platform. | ||
|
|
||
| <CardGrid> | ||
| <Card | ||
| title="Apify Console web IDE" | ||
| to="/platform/actors/development/quick-start/web-ide" | ||
| title="Start Locally in Your IDE" | ||
| to="/platform/actors/development/quick-start/locally" | ||
| /> | ||
| </CardGrid> | ||
|
|
||
| ### Web IDE | ||
|
|
||
| Using the Web IDE in [Apify Console](https://console.apify.com). | ||
|
|
||
| This is the fastest way to kick-start your Actor development and try out the Apify platform. | ||
|
|
||
| <CardGrid> | ||
| <Card | ||
| title="Locally on your machine" | ||
| to="/platform/actors/development/quick-start/locally" | ||
| title="Start in Apify Web IDE" | ||
| to="/platform/actors/development/quick-start/web-ide" | ||
| /> | ||
| </CardGrid> |
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
Oops, something went wrong.
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.