Skip to content

Commit 5dfddcb

Browse files
authored
fix: make standby headings h2 (#1098)
This PR changes standby docs headings to H2 so they're displayed in the side bar.
1 parent 425c57f commit 5dfddcb

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

sources/platform/actors/development/programming_interface/actor_standby.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Traditional Actors are designed to run a single task and then stop. They're most
1313
However, in some applications, waiting for an Actor to start is not an option. Actor Standby mode solves this problem by letting you have the Actor ready
1414
in the background, waiting for the incoming HTTP requests. In a sense, the Actor behaves like a real-time web server or standard API server.
1515

16-
#### How can I develop Actors using Standby mode
16+
## How can I develop Actors using Standby mode
1717

1818
import Tabs from '@theme/Tabs';
1919
import TabItem from '@theme/TabItem';
@@ -69,6 +69,6 @@ async def main() -> None:
6969
Please make sure to describe your Actors, their endpoints, and the schema for their
7070
inputs and ouputs in your README.
7171

72-
#### Can I monetize my Actor in the Standby mode
72+
## Can I monetize my Actor in the Standby mode
7373

7474
No, Standby mode is in Beta, and monetization is not supported.

sources/platform/actors/running/actor_standby.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Traditional Actors are designed to run a single task and then stop. They're most
1414
However, in some applications, waiting for an Actor to start is not an option. Actor Standby mode solves this problem by letting you have the Actor ready
1515
in the background, waiting for the incoming HTTP requests. In a sense, the Actor behaves like a real-time web server or standard API server.
1616

17-
#### How do I know if Standby mode is enabled?
17+
## How do I know if Standby mode is enabled?
1818

1919
You will know that the Actor is enabled for Standby mode if you see the **Standby** tab on the Actor's detail page.
2020
In the tab, you will find the hostname of the server, the description of the Actor's endpoints,
@@ -25,18 +25,18 @@ hit the API endpoint and get results.
2525

2626
![Standby tab](./images/actor_standby/standby-tab.png)
2727

28-
#### Can I still run the Actor in normal mode
28+
## Can I still run the Actor in normal mode
2929

3030
Yes, you can still modify the input and click the Start button to run the Actor in normal mode. However, note that the Standby Actor might
3131
not support this mode; the run might fail or return empty results. The normal mode is always supported in Standby Beta, even for Actors that don't handle
3232
it well. Please head to the Actor README to learn more about the capabilities of your chosen Actor.
3333

34-
#### Is there any scaling to accommodate the incoming requests
34+
## Is there any scaling to accommodate the incoming requests
3535

3636
When you use the Actor in Standby mode, the system automatically scales the Actor to accommodate the incoming requests. Under the hood,
3737
the system starts new Actor runs, which you will see in the Actor runs tab, with the origin set to Standby.
3838

39-
#### How do I customize Standby configuration
39+
## How do I customize Standby configuration
4040

4141
The Standby configuration currently consists of the following properties:
4242

@@ -51,15 +51,15 @@ use the Actor-level hostname, this will always use the default configuration. To
5151
You can then head to the Standby tab of the created Task and modify the configuration as needed. Note that the task has a specific hostname, so make
5252
sure to use that in your application if you wish to use the custom configuration.
5353

54-
#### Are the Standby runs billed differently
54+
## Are the Standby runs billed differently
5555

5656
No, the Standby runs are billed in the same fashion as the normal runs.
5757
However, running Actors in Standby mode might have unexpected costs, as the Actors run in the background and consume resources even when no requests are being sent until they are terminated after the idle timeout period.
5858

59-
#### Are the Standby runs shared among users
59+
## Are the Standby runs shared among users
6060

6161
No, even if you use the Actor-level hostname with the default configuration, the background Actor runs for your requests are not shared with other users.
6262

63-
#### How can I develop Actors using Standby mode
63+
## How can I develop Actors using Standby mode
6464

6565
See the [Actor Standby development section](../development/programming_interface/actor_standby.md).

0 commit comments

Comments
 (0)