-
Notifications
You must be signed in to change notification settings - Fork 182
feat: Fixing docs vs actual product disprepancies #2345
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
Changes from all commits
f424c06
d6d35b4
5db7b64
ee2e119
1053ee4
cb5a00d
74e7290
72c1dd6
73f93a7
adf9a35
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -34,11 +34,11 @@ For this tutorial, let's choose [Website Content Crawler](https://console.apify. | |
|
|
||
| ### 2. Configure and run your Actor | ||
|
|
||
| Once you select the Actor, click **Use Actor**. | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This button is used for the new UI; beware. |
||
| Once you select the Actor, you will be taken to the Actor's detail page. | ||
|
|
||
| In the **Input** tab, you can customize your Actor's behavior. Website Content Crawler is pre-configured to run without extra input, so you don't need to change anything. | ||
|
|
||
| To run the Actor, click **Save & Start**. | ||
| To run the Actor, click **Start**. | ||
|
|
||
|  | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -12,7 +12,7 @@ You can find all your tasks in the [Apify Console](https://console.apify.com/act | |
|
|
||
| ## Create | ||
|
|
||
| To create a task, open any Actor from [Apify Store](https://console.apify.com/store) or your list of [Actors](https://console.apify.com/actors) in Apify Console. At the top-right section of the page, click the **Create task** button. | ||
| To create a task, open any Actor from [Apify Store](https://console.apify.com/store) or your list of [Actors](https://console.apify.com/actors) in Apify Console. At the top-right section of the page, click the **Save as a new task** button. | ||
|
|
||
|  | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @TC-MO This screenshot deserves a proper refresh. |
||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -26,7 +26,7 @@ The resources you can access and account details you can edit will depend on you | |
|
|
||
| ### Manage your organizations | ||
|
|
||
| You can view and manage the organizations you are a member of from the **Organizations** tab on your [account page](https://console.apify.com/account#/myorganization). | ||
| You can view and manage the organizations you are a member of from the **Organizations** tab on your [account page](https://console.apify.com/settings/organizations). | ||
|
|
||
| If you want to leave an organization you own, you must first transfer ownership to someone else. | ||
|
|
||
|
|
@@ -40,7 +40,7 @@ The organization, its Actors, and its integrations will keep running as they are | |
|
|
||
| While you cannot manage an organization account's settings and members via API, you can access its Actor and task runs, webhooks, schedules, and storages just as you would with any other account. | ||
|
|
||
| As a member of an organization, you are assigned an [API token](../../integrations/index.mdx) (under the **Integrations** tab) and proxy password (click the **Proxy** button in the left menu) for accessing the Apify platform via REST API. | ||
| As a member of an organization, you are assigned an [API token](../../integrations/index.mdx) (under the **API & Integrations** tab) and proxy password (click the **Proxy** button in the left menu) for accessing the Apify platform via REST API. | ||
|
|
||
|  | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @TC-MO This screenshot deserves a proper refresh. |
||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -22,7 +22,7 @@ The organization account is available on all plans. [Visit the pricing page](htt | |
|
|
||
| ## Create a new organization | ||
|
|
||
| You can create a new organization by clicking the **Create new organization** button under the **Organizations** tab in your [account](https://console.apify.com/account#/myorganizations). If you want the organization to have a separate email address (used for notifications), enter it here. Otherwise, leave the **email** field empty and the owner's email will be used for notifications. | ||
| You can create a new organization by clicking the **Create new organization** button under the **Organizations** tab in your [account](https://console.apify.com/settings/organizations). If you want the organization to have a separate email address (used for notifications), enter it here. Otherwise, leave the **email** field empty and the owner's email will be used for notifications. | ||
|
|
||
|  | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @TC-MO This screenshot deserves a proper refresh. |
||
|
|
||
|
|
@@ -40,7 +40,7 @@ Before converting your personal account into an organization, make sure it has a | |
|
|
||
| An organization can't be a member of other organizations. If you want to convert your account to one, you'll first need to **leave all the organizations you are a part of**. | ||
|
|
||
| Then, under the **Organizations** [tab](https://console.apify.com/account#/myorganizations), click the **Convert this user account to an organization** button. | ||
| Then, under the **Organizations** [tab](https://console.apify.com/settings/organizations), click the **Convert this user account to an organization** button. | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @TC-MO It might be worth noting that you can't convert your account to an organization if you're already part of one. |
||
|
|
||
|  | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -29,7 +29,7 @@ If you did not receive the email, you can visit the [sign-in page](https://conso | |
|
|
||
| ### Google or GitHub | ||
|
|
||
| If you do not want to create a new password for Apify Console, you can also use your Google or GitHub account to sign up. To do that, click the **Sign up with Google** or **Sign up with GitHub** buttons. You will proceed to the corresponding authentication page, where you must sign in and authorize Apify to access your account. Then, when you come back to Apify Console, we will create your account. | ||
| If you do not want to create a new password for Apify Console, you can also use your Google or GitHub account to sign up. To do that, click the **Continue with Google** or **Continue with GitHub** buttons. You will proceed to the corresponding authentication page, where you must sign in and authorize Apify to access your account. Then, when you come back to Apify Console, we will create your account. | ||
|
|
||
| If you used Google to sign up, there is no verification step after this, and you can start using Apify Console right away. | ||
| On the other hand, if you used GitHub to create your account and your GitHub account does not have a verified email, we will ask you to verify your email address before you can start using Apify Console. The process works the same as the process for email and password authentication. | ||
|
|
@@ -66,22 +66,28 @@ After you click on the link (or copy it to your browser), you will proceed to a | |
|
|
||
|  | ||
|
|
||
| ## Homepage overview | ||
| ## Dashboard overview | ||
|
|
||
|  | ||
|  | ||
|
|
||
| The Apify Console homepage provides an overview of your account setup. The header displays your account name and current plan level. The homepage features several sections: | ||
| The Apify Console Dashboard provides an overview of your account. The header displays your account name and current plan level. The Dashboard features several sections: | ||
|
|
||
| - **Recently Viewed**: This section displays Actors you have recently accessed. If you haven't used any Actors yet, you will see suggestions instead. | ||
| - **Recently viewed**: This section displays Actors you have recently accessed. If you haven't used any Actors yet, you will see suggestions instead. | ||
|
|
||
| - **Suggested Actors for You**: Based on your and other users' recent activities, this section recommends Actors that might interest you. | ||
| - **Suggested Actors for you**: Based on your and other users' recent activities, this section recommends Actors that might interest you. | ||
|
|
||
| - **Actor Runs**: This section is divided into two tabs: | ||
| - **Actor runs**: This section is divided into two tabs: | ||
| - **Recent**: View your latest Actor runs. | ||
| - **Scheduled**: Check your upcoming scheduled runs and tasks. | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @TC-MO I would also add a mention about the "Create" button. |
||
|
|
||
| Use the side menu to navigate other parts of Apify Console easily. | ||
|
|
||
| The **Create** dropdown in the top navigation offers three options: | ||
|
|
||
| - **Create Actor** | ||
| - **Create schedule** | ||
| - **Create a new token** | ||
|
|
||
| <!-- markdownlint-disable-next-line --> | ||
| #### Keyboard shortcuts | ||
|
|
||
|
|
@@ -93,7 +99,7 @@ You can also navigate Apify Console via keyboard shortcuts. | |
| | Shortcut | Tab | | ||
| | :--- | :--- | | ||
| | Show shortcuts | Shift? | | ||
| | Home | GH | | ||
| | Dashboard | GH | | ||
| | Store | GO | | ||
| | Actors | GA | | ||
| | Development | GD | | ||
|
|
@@ -111,13 +117,14 @@ You can also navigate Apify Console via keyboard shortcuts. | |
| | Tab name | Description | | ||
| | :--- | :--- | | ||
| | [Apify Store](/platform/console/store) | Search for Actors that suit your web-scraping needs. | | ||
| | [Dashboard](/platform/console) | Overview of your account with recently viewed Actors, suggestions, and recent runs. | | ||
| | [Actors](/platform/actors) | View recent & bookmarked Actors. | | ||
| | [Runs](/platform/actors/running/runs-and-builds) | View your recent runs. | | ||
| | [Saved tasks](/platform/actors/running/tasks) | View your saved tasks. | | ||
| | [Schedules](/platform/schedules) | Schedule Actor runs & tasks to run at specified time. | | ||
| | [Integrations](/platform/integrations) | View your integrations. | | ||
| | [Schedules](/platform/schedules) | Schedule Actor runs & tasks to run at specified time. | | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @mtrunkat Not sure why this moved lower? |
||
| | [Development](/platform/actors/development) | • My Actors - See Actors developed by you. <br/> • Insights - see analytics for your Actors. <br/> • Messaging - check on issues reported in your Actors or send emails to users of your Actors. | | ||
| | [Proxy](/platform/proxy) | View your proxy usage & credentials | | ||
| | [Proxy](/platform/proxy) | View your proxy usage & credentials. | | ||
| | [Storage](/platform/storage) | View stored results of your runs in various data formats. | | ||
| | [Billing](/platform/console/billing) | Billing information, statistics and invoices. | | ||
| | [Billing](/platform/console/billing) | Billing information, statistics, and invoices. | | ||
| | [Settings](/platform/console/settings) | Settings of your account. | | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @TC-MO I would also add a mention about the "Create" button. |
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Worth adding which version of a Crawlee + Cheerio template we're using. TypeScript or JavaScript? 🤔