diff --git a/sources/academy/platform/deploying_your_code/deploying.md b/sources/academy/platform/deploying_your_code/deploying.md index 2385fd3352..6eb41e895a 100644 --- a/sources/academy/platform/deploying_your_code/deploying.md +++ b/sources/academy/platform/deploying_your_code/deploying.md @@ -1,13 +1,11 @@ --- -title: Deploying -description: Push local code to the platform, or create a new Actor on the console and integrate it with a Git repo to optionally automatically rebuild any new changes. +title: Publishing your Actor +description: Push local code to the platform, or create a new Actor on the console and integrate it with a Git repository to optionally automatically rebuild any new changes. sidebar_position: 5 slug: /deploying-your-code/deploying --- -# Deploying {#deploying} - -**Push local code to the platform, or create a new Actor on the console and integrate it with a Git repo to optionally automatically rebuild any new changes.** +**Push local code to the platform, or create a new Actor on the console and integrate it with a Git repository to optionally automatically rebuild any new changes.** --- @@ -17,7 +15,7 @@ Once you've **actorified** your code, there are two ways to deploy it to the Api Before we deploy our project onto the Apify platform, let's ensure that we've pushed the changes we made in the last 3 lessons into our remote GitHub repository. -> The benefit of using this method is that any time you push to the Git repo, the code on the platform is also updated and the Actor is automatically rebuilt. Also, you don't have to use a GitHub repository - you can use GitLab or any other service you'd like. +> The benefit of using this method is that any time you push to the Git repository, the code on the platform is also updated and the Actor is automatically rebuilt. Also, you don't have to use a GitHub repository - you can use GitLab or any other service you'd like. ### Creating the Actor @@ -33,7 +31,7 @@ In the **Source** tab on the new Actor's page, we'll click the dropdown menu und Now we'll paste the link to our GitHub repository into the **Git URL** text field and click **Save**. -### Adding the webhook to the repository {#adding-repo-webhook} +### Adding the webhook to the repository {#adding-repository-webhook} The final step is to click on **API** in the top right corner of our Actor's page: @@ -41,9 +39,9 @@ The final step is to click on **API** in the top right corner of our Actor's pag And scroll through all of the links until we find the **Build Actor** API endpoint. Now we'll copy this endpoint's URL, head back over to our GitHub repository and navigate to **Settings > Webhooks > Add webhook**. The final thing to do is to paste the URL and save the webhook. -![Adding a webhook to your GitHub repo](../../../platform/actors/development/deployment/images/ci-github-integration.png) +![Adding a webhook to your GitHub repository](../../../platform/actors/development/deployment/images/ci-github-integration.png) -That's it! The Actor should now pull its source code from the repo and automatically build. +That's it! The Actor should now pull its source code from the repository and automatically build. ## Without a GitHub repository (using the Apify CLI) {#with-apify-cli} @@ -57,7 +55,7 @@ One important thing to note is that you can use a `.gitignore` file to exclude f ## Deployed! {#deployed} -Great! Once you've pushed your Actor to the platform, you should see it in the list of Actors under the **Actors** tab. If you used `apify push`, you'll have access to the **multifile editor** (discussed [here](../getting_started/creating_actors.md)). +Great! Once you've pushed your Actor to the platform, you will find it listed under the **Actors** tab. When using the `apify push` command, you will have access to the multifile editor. For details about using the multifile editor, refer to [Creating Actors](/academy/getting-started/creating-actors#web-ide). ![Deployed Actor on the Apify platform](./images/actor-page.jpg) diff --git a/sources/academy/platform/deploying_your_code/docker_file.md b/sources/academy/platform/deploying_your_code/docker_file.md index f69824d5fc..2686e7872f 100644 --- a/sources/academy/platform/deploying_your_code/docker_file.md +++ b/sources/academy/platform/deploying_your_code/docker_file.md @@ -1,5 +1,5 @@ --- -title: Dockerfile +title: Creating Actor Dockerfile description: Understand how to write a Dockerfile (Docker image blueprint) for your project so that it can be run within a Docker container on the Apify platform. sidebar_position: 4 slug: /deploying-your-code/docker-file @@ -8,8 +8,6 @@ slug: /deploying-your-code/docker-file import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# Dockerfile {#dockerfile} - **Understand how to write a Dockerfile (Docker image blueprint) for your project so that it can be run within a Docker container on the Apify platform.** --- @@ -20,7 +18,7 @@ The **Dockerfile** is a file which gives the Apify platform (or Docker, more spe ## Base images {#base-images} -If your project doesn’t already contain a Dockerfile, don’t worry! Apify offers [many base images](/sdk/js/docs/guides/docker-images) that are optimized for building and running Actors on the platform, which can be found [here](https://hub.docker.com/u/apify). When using a language for which Apify doesn't provide a base image, [Docker Hub](https://hub.docker.com/) provides a ton of free Docker images for most use-cases, upon which you can create your own images. +If your project doesn’t already contain a Dockerfile, don’t worry! Apify offers [many base images](/sdk/js/docs/guides/docker-images) that are optimized for building and running Actors on the platform, which can be found on [Docker Hub](https://hub.docker.com/u/apify). When using a language for which Apify doesn't provide a base image, [Docker Hub](https://hub.docker.com/) provides a ton of free Docker images for most use-cases, upon which you can create your own images. > Tip: You can see all of Apify's Docker images [on DockerHub](https://hub.docker.com/u/apify). diff --git a/sources/academy/platform/deploying_your_code/index.md b/sources/academy/platform/deploying_your_code/index.md index 47a2f2aed6..9026ebc54a 100644 --- a/sources/academy/platform/deploying_your_code/index.md +++ b/sources/academy/platform/deploying_your_code/index.md @@ -1,5 +1,5 @@ --- -title: Deploying your code +title: Deploying your code to Apify description: In this course learn how to take an existing project of yours and deploy it to the Apify platform as an Actor. sidebar_position: 9 category: apify platform diff --git a/sources/academy/platform/deploying_your_code/input_schema.md b/sources/academy/platform/deploying_your_code/input_schema.md index f337203a76..6138e8ea6d 100644 --- a/sources/academy/platform/deploying_your_code/input_schema.md +++ b/sources/academy/platform/deploying_your_code/input_schema.md @@ -1,12 +1,10 @@ --- -title: Input schema +title: Creating Actor input schema description: Learn how to generate a user interface on the platform for your Actor's input with a single file - the INPUT_SCHEMA.json file. sidebar_position: 2 slug: /deploying-your-code/input-schema --- -# Input schema {#input-schema} - **Learn how to generate a user interface on the platform for your Actor's input with a single file - the INPUT_SCHEMA.json file.** --- diff --git a/sources/academy/platform/deploying_your_code/inputs_outputs.md b/sources/academy/platform/deploying_your_code/inputs_outputs.md index 45a5be745a..fbef2d2db7 100644 --- a/sources/academy/platform/deploying_your_code/inputs_outputs.md +++ b/sources/academy/platform/deploying_your_code/inputs_outputs.md @@ -1,12 +1,10 @@ --- -title: Inputs & outputs +title: Managing Actor inputs and outputs description: Learn to accept input into your Actor, do something with it, and then return output. Actors can be written in any language, so this concept is language agnostic. sidebar_position: 1 slug: /deploying-your-code/inputs-outputs --- -# Inputs & outputs {#inputs-outputs} - **Learn to accept input into your Actor, do something with it, and then return output. Actors can be written in any language, so this concept is language agnostic.** --- diff --git a/sources/academy/platform/deploying_your_code/output_schema.md b/sources/academy/platform/deploying_your_code/output_schema.md index 551d94eca7..a18f7591a9 100644 --- a/sources/academy/platform/deploying_your_code/output_schema.md +++ b/sources/academy/platform/deploying_your_code/output_schema.md @@ -1,17 +1,15 @@ --- -title: Dataset schema +title: Creating dataset schema description: Learn how to generate an appealing Overview table interface to preview your Actor results in real time on the Apify platform. sidebar_position: 3 slug: /deploying-your-code/dataset-schema --- -# Dataset schema - **Learn how to generate an appealing Overview table interface to preview your Actor results in real time on the Apify platform.** --- -The Dataset schema generates an interface that enables users to instantly preview their Actor results in real time. +The dataset schema generates an interface that enables users to instantly preview their Actor results in real time. ![Dataset Schema](../../../platform/actors/development/actor_definition/images/output-schema-example.png)