-
Notifications
You must be signed in to change notification settings - Fork 36
docs: improve overview page #963
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
+28
−15
Merged
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
021a65f
docs: improve intro page
marcel-rbro 17a0c31
docs: change intro to overview
marcel-rbro e657afb
docs: review suggestions
marcel-rbro 272b353
apply review suggestions
marcel-rbro f198f4f
Merge branch 'master' into docs/improve-intro-page
marcel-rbro 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,23 +1,24 @@ | ||
| --- | ||
| title: Overview | ||
| title: Apify CLI overview | ||
| description: An introduction to Apify CLI, a command-line interface for creating, developing, building, and running Apify Actors and managing the Apify cloud platform. | ||
| sidebar_label: Overview | ||
| --- | ||
|
|
||
| Apify command-line interface (Apify CLI) helps you create, develop, build and run | ||
| [Apify Actors](https://apify.com/actors), | ||
| and manage the Apify cloud platform from any computer. | ||
| Apify command-line interface (Apify CLI) helps you create, develop, build and run [Apify Actors](https://apify.com/actors), and manage the Apify platform from any computer. | ||
|
|
||
| Apify Actors are cloud programs that can perform arbitrary web scraping, automation or data processing job. | ||
| They accept input, perform their job and generate output. | ||
| While you can develop Actors in an online IDE directly in the [Apify web application](https://console.apify.com/), | ||
| for complex projects it is more convenient to develop Actors locally on your computer | ||
| using <a href="https://github.com/apify/apify-sdk-js">Apify SDK</a> | ||
| and only push the Actors to the Apify cloud during deployment. | ||
| This is where the Apify CLI comes in. | ||
| Apify Actors are cloud programs that can perform arbitrary web scraping, automation or data processing job. They accept input, perform their job and generate output. The Apify CLI enables you to develop Actors locally on your computer using your preferred code editor, version control system, and development tools. This approach gives you full control over your development environment, makes it easier to work on complex projects, and allows you to leverage the [Apify SDK](https://github.com/apify/apify-sdk-js) with all its powerful features. When you're ready, simply push your Actor to the Apify platform for deployment. | ||
|
|
||
| :::note Run Actors in Docker | ||
| :::note Actor development environment | ||
|
|
||
| Actors running on the Apify platform are executed in Docker containers, so with an appropriate `Dockerfile` | ||
| you can build your Actors in any programming language. | ||
| However, we recommend using JavaScript/Node.js and Python, for which we provide most libraries and support. | ||
| Actors running on the Apify platform are executed in Docker containers, so with an appropriate `Dockerfile` you can build your Actors in any programming language. However, we recommend using JavaScript/Node.js and Python, for which we provide most libraries and support. | ||
|
|
||
| ::: | ||
|
|
||
| ## Learn more | ||
|
|
||
| Learn everything you need to use the Apify CLI effectively: | ||
|
|
||
| - Learn how to [install](./installation.md) the CLI on your system | ||
| - Get started with your [first Actor project](./quick-start.md) | ||
| - See the complete [reference of all CLI commands](./reference.md) and options | ||
| - Find [solutions to common issues](./troubleshooting.md) | ||
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.