Skip to content

Commit

Permalink
extend vocabulary & remove unnecessary vale off and on
Browse files Browse the repository at this point in the history
  • Loading branch information
TC-MO committed Dec 13, 2024
1 parent 003de23 commit ca4fae2
Show file tree
Hide file tree
Showing 10 changed files with 31 additions and 28 deletions.
5 changes: 4 additions & 1 deletion .github/styles/config/vocabularies/Docs/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ nginx
:::tip
:::warning

maxWidth
startUrls

PDFs
dataset's
gif
Expand Down Expand Up @@ -64,7 +67,7 @@ llama_index
[Ff]lowise

exploitability
Whitepaper
[Ww]hitepaper
[Cc]ron
scalably
metamorph
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -86,9 +86,9 @@ navigator.permissions.query('some_permission');
```

### With canvases {#with-canvases}
<!-- vale off -->

This technique is based on rendering [WebGL](https://developer.mozilla.org/en-US/docs/Web/API/WebGL_API) scenes to a canvas element and observing the pixels rendered. WebGL rendering is tightly connected with the hardware, and therefore provides high entropy. Here's a quick breakdown of how it works:
<!-- vale on -->

1. A JavaScript script creates a [`<canvas>` element](https://developer.mozilla.org/en-US/docs/Web/API/Canvas_API) and renders some font or a custom shape.
2. The script then gets the pixel-map from the `<canvas>` element.
3. The collected pixel-map is stored in a cryptographic hash specific to the device's hardware.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ Unfortunately, most APIs will require a valid cookie to be included in the `cook
Luckily, there are ways to retrieve and set cookies for requests prior to sending them, which will be covered more in-depth within future Scraping Academy modules. The most important things to know at the moment are:

## Cookies {#cookies}
<!-- vale off -->

1. For sites that heavily rely on cookies for user-verification and request authorization, certain generic requests (such as to the website's main page, or to the target page) will return back a (or multiple) `set-cookie` header(s).
2. The `set-cookie` response header(s) can be parsed and used as the `cookie` header in the headers of a request. A great package for parsing these values from a response's headers is [`set-cookie-parser`](https://www.npmjs.com/package/set-cookie-parser). With this package, cookies can be parsed from headers like so:
<!-- vale on -->

```js
import axios from 'axios';

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,9 @@ To make an input field secret, you need to add a `"isSecret": true` setting to t
```

The editor for this input field will then turn into a secret input, and when you edit the field value, it will be stored encrypted.
<!-- vale off -->

<img src={require("./images/secret-input-editor.png").default} alt="Secret input editor" style={{ width: '100%', maxWidth: '822px' }}/>
<!-- vale on -->

:::note Type restriction

This is only available for `string` inputs, and the editor type is limited to `textfield` or `textarea`.
Expand Down
6 changes: 3 additions & 3 deletions sources/platform/actors/publishing/badge.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ https://apify.com/actor-badge?actor=<USERNAME>/<ACTOR>
In order to embed the badge in the HTML documentation, just use it as an image wrapped in a link as shown in the example below. Don't froget to use the `username` and `actor-name` of your Actor.

#### Example
<!-- vale off -->

<Tabs>
<TabItem value="html" label="HTML" default>
```html
Expand All @@ -40,13 +40,13 @@ In order to embed the badge in the HTML documentation, just use it as an image w
</a>
```
</TabItem>
<TabItem value="markdown" label="Markdown">
<TabItem value="markdown" label="Markdown">
```markdown
[![Website Content Crawler Actor](https://apify.com/actor-badge?actor=apify/website-content-crawler)](https://apify.com/apify/website-content-crawler)
```
</TabItem>
</Tabs>
<!-- vale on -->

### Supported Actor states

The badge indicates the state of the Actor in the Apify platform as the result of the [automated testing](../development/automated_tests.md).
Expand Down
4 changes: 2 additions & 2 deletions sources/platform/actors/running/usage_and_resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,9 +63,9 @@ A good middle ground is `4096MB`. If you need the results faster, increase the m
Autoscaling only applies to solutions that run multiple tasks (URLs) for at least 30 seconds. If you need to scrape just one URL or use Actors like [Google Sheets](https://apify.com/lukaskrivka/google-sheets) that do just a single isolated job, we recommend you lower the memory.

[//]: # (TODO: It's pretty outdated, we now have platform credits in pricing)
<!-- vale off -->

[//]: # (If you read that you can scrape 1000 pages of data for 1 CU and you want to scrape approximately 2 million of them monthly, that means you need 2000 CUs monthly and should [subscribe to the Business plan]&#40;https://console.apify.com/billing-new#/subscription&#41;.)
<!-- vale on -->


If the Actor doesn't have this information, or you want to use your own solution, just run your solution like you want to use it long term. Let's say that you want to scrape the data **every hour for the whole month**. You set up a reasonable memory allocation like `4096MB`, and the whole run takes 15 minutes. That should consume 1 CU (4 \* 0.25 = 1). Now, you just need to multiply that by the number of hours in the day and by the number of days in the month, and you get an estimated usage of 720 (1 \* 24 \* 30) CUs monthly.

Expand Down
8 changes: 4 additions & 4 deletions sources/platform/integrations/ai/milvus.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,8 +83,8 @@ Another way to interact with Milvus is through the [Apify Python SDK](https://do
MILVUS_TOKEN = "YOUR-MILVUS-TOKEN"
client = ApifyClient(APIFY_API_TOKEN)
```
<!-- vale off -->
1. Call the [Website Content Crawler](https://apify.com/apify/website-content-crawler) Actor to crawl the Milvus documentation and Zilliz website and extract text content from the web pages:

2. Call the [Website Content Crawler](https://apify.com/apify/website-content-crawler) Actor to crawl the Milvus documentation and Zilliz website and extract text content from the web pages:


```python
Expand All @@ -93,8 +93,8 @@ Another way to interact with Milvus is through the [Apify Python SDK](https://do
)
```

<!-- vale on -->
1. Call Apify's Milvus integration and store all data in the Milvus Vector Database:

3. Call Apify's Milvus integration and store all data in the Milvus Vector Database:

```python
milvus_integration_inputs = {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,9 @@ Congratulations! You have successfully connected the Apify app and can now use i
### Watch Actor Runs

> Triggers when a selected Actor run is finished.
<!-- vale off -->
<img src={require("../images/apify-make-trigger.png").default} width="50%" />
<!-- vale on -->

| Input | Description |
| :----------- | :--------------------------------------------------------------------- |
| Webhook name | Enter the desired name for the webhook. E.g. Finished Web Scraper Run. |
Expand All @@ -70,9 +70,9 @@ Congratulations! You have successfully connected the Apify app and can now use i
### Run a task

> Runs a selected Actor task.
<!-- vale off -->
<img src={require("../images/apify-make-run-task.png").default} width="50%" />
<!-- vale on -->

| Input | Description |
| :------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Task | Select or map the task you want to run. |
Expand All @@ -82,9 +82,9 @@ Congratulations! You have successfully connected the Apify app and can now use i
### Run an Actor

> Runs a selected Actor.
<!-- vale off -->
<img src={require("../images/apify-make-run-actor.png").default} width="50%" />
<!-- vale on -->


| Input | Description |
| :------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
Expand All @@ -100,9 +100,9 @@ Congratulations! You have successfully connected the Apify app and can now use i
### Get Dataset Items

> Retrieves items from a [dataset](/platform/storage/dataset).
<!-- vale off -->
<img src={require("../images/apify-make-dataset.png").default} width="50%" />
<!-- vale on -->


| Input | Description |
| :------------------ | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
Expand Down
4 changes: 2 additions & 2 deletions sources/platform/limits.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ slug: /limits
---

The tables below demonstrate the Apify platform's default resource limits. For API limits such as rate limits and max payload size, see the [API documentation](https://docs.apify.com/api/v2#/introduction/rate-limiting).
<!-- vale off -->

> If needed, the limits shown below can be increased on paid accounts. For details, contact us at **[hello@apify.com](mailto:hello@apify.com)** or using the chat in [Apify Console](https://console.apify.com/) under the "Help & Resources → Contact Support".
<!-- vale on -->
## Actor runtime limits {#actor-limits}

<table>
Expand Down
4 changes: 2 additions & 2 deletions sources/platform/security.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ slug: /security

At Apify, security is the top priority of our daily work. Security best practices are reflected in our development, deployment, monitoring, and project management processes.
Read the Apify Security Whitepaper for a full description of Apify's measures and commitments to security:
<!-- vale off -->

<a href="https://apify.com/security-whitepaper.pdf" target="_blank" title="Apify Security Whitepaper">
<img src={require("./images/security/whitepaper-cover.png").default} width="50%" title="Apify Security Whitepaper" />
</a>
<!-- vale on -->

## Reporting a vulnerability

If you notice or suspect a potential security breach, please report this immediately to our security team at [security@apify.com](mailto:security@apify.com), including all the technical details.
Expand Down

0 comments on commit ca4fae2

Please sign in to comment.