Skip to content

Commit 9eaf91b

Browse files
authored
docs: Update Quickstart with Git (#1395)
I added a note for now, but I think it makes sense to create a separate topic just on git and link them well. I'll see what makes most sense when I'm done updating the remaining topics. Part of #1240.
1 parent 6435152 commit 9eaf91b

2 files changed

Lines changed: 30 additions & 10 deletions

File tree

‎docs/quick-start.md‎

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,15 @@ The CLI then asks you for the following:
2323
1. Name your Actor. Use lowercase letters, numbers, and hyphens.
2424
1. Select a type of Actor to create: web scraper, AI agent, API and data pipeline, or browser automation. Let's choose **web scraper**.
2525
1. Choose the programming language: JavaScript, TypeScript, or Python. Let's choose **JavaScript**.
26-
1. Based on your choice, the CLI suggests Actor templates. For this tutorial, let's choose **Crawlee and Cheerio**.
26+
1. Based on your choice, the CLI suggests Actor templates. For this tutorial, let's choose **JavaScript Cheerio crawler**.
2727

28-
:::tip Explore Actor templates
28+
:::tip Explore Actor templates
2929

30-
To find a template that best suits your needs, browse the [full list of templates](https://apify.com/templates).
30+
To find a template that best suits your needs, browse the [full list of templates](https://apify.com/templates).
3131

32-
:::
32+
:::
33+
34+
1. Choose where to host the source code of your Actor: on Apify, GitHub, GitLab, or Bitbucket. Let's choose **Apify**.
3335

3436
The CLI creates a new directory with the boilerplate code and installs all project dependencies.
3537

@@ -59,11 +61,19 @@ Local runs store their data in the `storage` directory:
5961
| `storage/key_value_stores/default/` | Records the Actor read or wrote, including its input. |
6062
| `storage/request_queues/default/` | Requests the Actor enqueued. |
6163

62-
6364
## 3. Deploy your Actor
6465

6566
By deploying your Actor to the Apify platform, you can run your code on Apify's infrastructure, schedule runs, and monitor logs and stored data.
6667
68+
<details>
69+
<summary>Deploy a Git-sourced Actor</summary>
70+
71+
If you chose to host the source code on GitHub, GitLab, or Bitbucket, `apify create` created the Actor on the Apify platform and connected it to your repository.
72+
73+
As a result, Git stores and versions your code. To deploy and build your Actor, use `git push`.
74+
75+
</details>
76+
6777
### Log in to Apify Console
6878
6979
To log in, run:

‎website/versioned_docs/version-1.10/quick-start.md‎

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,15 @@ The CLI then asks you for the following:
2323
1. Name your Actor. Use lowercase letters, numbers, and hyphens.
2424
1. Select a type of Actor to create: web scraper, AI agent, API and data pipeline, or browser automation. Let's choose **web scraper**.
2525
1. Choose the programming language: JavaScript, TypeScript, or Python. Let's choose **JavaScript**.
26-
1. Based on your choice, the CLI suggests Actor templates. For this tutorial, let's choose **Crawlee and Cheerio**.
26+
1. Based on your choice, the CLI suggests Actor templates. For this tutorial, let's choose **JavaScript Cheerio crawler**.
2727

28-
:::tip Explore Actor templates
28+
:::tip Explore Actor templates
2929

30-
To find a template that best suits your needs, browse the [full list of templates](https://apify.com/templates).
30+
To find a template that best suits your needs, browse the [full list of templates](https://apify.com/templates).
3131

32-
:::
32+
:::
33+
34+
1. Choose where to host the source code of your Actor: on Apify, GitHub, GitLab, or Bitbucket. Let's choose **Apify**.
3335

3436
The CLI creates a new directory with the boilerplate code and installs all project dependencies.
3537

@@ -59,11 +61,19 @@ Local runs store their data in the `storage` directory:
5961
| `storage/key_value_stores/default/` | Records the Actor read or wrote, including its input. |
6062
| `storage/request_queues/default/` | Requests the Actor enqueued. |
6163

62-
6364
## 3. Deploy your Actor
6465

6566
By deploying your Actor to the Apify platform, you can run your code on Apify's infrastructure, schedule runs, and monitor logs and stored data.
6667
68+
<details>
69+
<summary>Deploy a Git-sourced Actor</summary>
70+
71+
If you chose to host the source code on GitHub, GitLab, or Bitbucket, `apify create` created the Actor on the Apify platform and connected it to your repository.
72+
73+
As a result, Git stores and versions your code. To deploy and build your Actor, use `git push`.
74+
75+
</details>
76+
6777
### Log in to Apify Console
6878
6979
To log in, run:

0 commit comments

Comments
 (0)