Skip to content

docs: rename Academy articles #1639

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.

Sign up for GitHub

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
merged 7 commits into from
Jun 19, 2025
Merged

docs: rename Academy articles #1639

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
9640749
docs: rename Academy articles
TC-MO Jun 17, 2025
e425f88
fix vale
TC-MO Jun 17, 2025
01db868
fix mdlint
TC-MO Jun 17, 2025
d268487
fix mdlint
TC-MO Jun 17, 2025
a690d0d
update link & remove double space
TC-MO Jun 17, 2025
032850d
update titles
TC-MO Jun 18, 2025
2bcfb78
adjust the prose
TC-MO Jun 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 8 additions & 10 deletions sources/academy/platform/deploying_your_code/deploying.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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: How to deploy your Actor
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we have a pattern of naming articles with "how to"? I'm not 100% sure, but I'd keep the general approach of "ing ", so in this case, Deploying your Actor, and similarly the others.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is special case as the article for input schema is named same as the one in platform docs. You can see context for the change in this discussion. But after changing one, it felt way out of place so it made sense to me to rename the whole section with similar style for consistency. This is temporary solution until Apify Platform section is dealt with

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

imho naming articles "how to" is okay. see

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm aware of the conversation and I know what how-tos are. The conversation is about the fact that there were three pages called "Input schema". That is, of course, wrong. JC's idea was to rename it to "how to X", and I completely understand why. But we're not here to write articles that have limited context. Our articles must fit our system. While we do have a couple of articles named "How to", it's a deviation, not the norm. The norm (at Apify Docs) is to use the gerund to name articles. It also looks ugly and is hard to navigate if you have a wall of How to X in a page tree.

I'm also not against Diataxis. I think it's right... for Technical Writers. But it is inherently wrong to force users think about what type of educational/documentation material it is before they can find it, let alone open it. It's the same when governmental clerks want you to follow the process even though it doesn't make any sense to you. That's what forcing Diataxis upon users is. Looking at the linked LangChain docs, as a new potential user, I want to see some inspiration or I have some scenario in my mind. But this way, everything is collapsed under multiple sections of "Tutorials", "How-to guides", and "Conceptual guides", which tells me literally nothing, and I have to open all of them to understand what I'll find. If they named the sections "Some articles", "Another batch of articles", "Miscellaneous", it would give me the same amount of information.

That's why I'm pushing for not being named as "How to X". Even if it's a temporary change, it can have a proper naming.

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.**

---

Expand All @@ -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

Expand All @@ -33,17 +31,17 @@ 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:

![API button](../expert_scraping_with_apify/images/api-button.jpg)

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}

Expand All @@ -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 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 in [Creating Actors](../getting_started/creating_actors.md)).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be nicer to have the hyperlink directly underneath the text instead of having a clause with "discussed in X" or "discussed here".

Also, when I open the page, there's nothing about a multifile editor. As a reader (and even as an Apify emploee), I don't know what that is from that page, so the link doesn't really help me.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've updated the link to speficially go to #web-ide section of the Creating Actors page. But anything more would require a big rewrite, which is not the point of this change. I can attempt it but this will balloon this rather simple PR into something much more substantial

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, I see. What about the first part of the comment? :)


![Deployed Actor on the Apify platform](./images/actor-page.jpg)

Expand Down
6 changes: 2 additions & 4 deletions sources/academy/platform/deploying_your_code/docker_file.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Dockerfile
title: How to create an 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
Expand All @@ -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.**

---
Expand All @@ -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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

double space "found on Docker Hub"


> Tip: You can see all of Apify's Docker images [on DockerHub](https://hub.docker.com/u/apify).

Expand Down
4 changes: 1 addition & 3 deletions sources/academy/platform/deploying_your_code/input_schema.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
---
title: Input schema
title: How to write 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.**

---
Expand Down
4 changes: 1 addition & 3 deletions sources/academy/platform/deploying_your_code/inputs_outputs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
---
title: Inputs & outputs
title: How to handle 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.**

---
Expand Down
4 changes: 1 addition & 3 deletions sources/academy/platform/deploying_your_code/output_schema.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
---
title: Dataset schema
title: How to create a 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.**

---
Expand Down