docs: Improve Actors environment variables docs #1668

patrikbraborec · 2025-07-03T20:51:21Z

The improvements address issues I encountered during building my first actor and setting env variables. Please take it as a suggestion open to discussion!
The page now contains some "duplicate" information with the page https://docs.apify.com/cli/docs/vars#set-up-environment-variables-in-apify-console. I think that is not an issue; maybe we can interlink those pages.
I am not completely sure about the Configuration class and how I described it, but I tried it locally and in Apify console, and it worked that way, but I just maybe do not understand it yet.

Signed-off-by: Patrik Braborec <[email protected]>

cursor

Bug: Misleading Variable Assignment in Python Example

In the Python example for accessing environment variables, the variable userId is misleadingly assigned the value of os.environ['api_token']. This contradicts the variable's name and the surrounding comments, causing confusion.

sources/platform/actors/development/programming_interface/environment_variables.md#L157-L161

apify-docs/sources/platform/actors/development/programming_interface/environment_variables.md

Lines 157 to 161 in ff39d10

    
           # get api_token 
        
           userId = os.environ['api_token'] 
        
           # print api_token to console 
        
           print(userId)

Fix in Cursor • Fix in Web

Comment bugbot run to trigger another review on this PR
Was this report helpful? Give feedback by reacting with 👍 or 👎

apify-service-account · 2025-07-03T20:54:47Z

Preview for this PR was built for commit ff39d100 and is ready at https://pr-1668.preview.docs.apify.com!

Signed-off-by: Patrik Braborec <[email protected]>

apify-service-account · 2025-07-03T21:02:07Z

Preview for this PR was built for commit f59a3f25 and is ready at https://pr-1668.preview.docs.apify.com!

apify-service-account · 2025-07-03T21:05:04Z

Preview for this PR was built for commit 6e113021 and is ready at https://pr-1668.preview.docs.apify.com!

TC-MO

Did few rewrites for clarity & conciseness
rewrote notes to be more active voice to adhere to msoft style guide and general technical writing principle

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

apify-service-account · 2025-07-03T21:58:51Z

Preview for this PR was built for commit 1fe541de and is ready at https://pr-1668.preview.docs.apify.com!

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

…ronment_variables.md Co-authored-by: Michał Olender <[email protected]>

apify-service-account · 2025-07-04T11:27:40Z

Preview for this PR was built for commit 27c720ab and is ready at https://pr-1668.preview.docs.apify.com!

…ronment_variables.md Co-authored-by: Michał Olender <[email protected]>

apify-service-account · 2025-07-04T11:31:58Z

Preview for this PR was built for commit 2891771b and is ready at https://pr-1668.preview.docs.apify.com!

apify-service-account · 2025-07-04T11:34:44Z

Preview for this PR was built for commit c4cb588c and is ready at https://pr-1668.preview.docs.apify.com!

…ronment_variables.md Co-authored-by: Michał Olender <[email protected]>

apify-service-account · 2025-07-04T12:01:08Z

Preview for this PR was built for commit f2aafda2 and is ready at https://pr-1668.preview.docs.apify.com!

Signed-off-by: Patrik Braborec <[email protected]>

apify-service-account · 2025-07-04T12:17:11Z

Preview for this PR was built for commit 05cc36c8 and is ready at https://pr-1668.preview.docs.apify.com!

Signed-off-by: Patrik Braborec <[email protected]>

…ronment_variables.md Co-authored-by: Michał Olender <[email protected]>

apify-service-account · 2025-07-04T14:18:23Z

Preview for this PR was built for commit 3e83d6e3 and is ready at https://pr-1668.preview.docs.apify.com!

…ronment_variables.md Co-authored-by: Michał Olender <[email protected]>

apify-service-account · 2025-07-04T14:21:11Z

Preview for this PR was built for commit 97fb2d09 and is ready at https://pr-1668.preview.docs.apify.com!

Signed-off-by: Patrik Braborec <[email protected]>

apify-service-account · 2025-07-04T14:23:53Z

Preview for this PR was built for commit 672168ec and is ready at https://pr-1668.preview.docs.apify.com!

apify-service-account · 2025-07-04T14:27:03Z

Preview for this PR was built for commit fa1a1f67 and is ready at https://pr-1668.preview.docs.apify.com!

Signed-off-by: Patrik Braborec <[email protected]>

apify-service-account · 2025-07-07T12:28:48Z

Preview for this PR was built for commit dd66c2e8 and is ready at https://pr-1668.preview.docs.apify.com!

apify-service-account · 2025-07-07T12:32:01Z

Preview for this PR was built for commit 7c9e756d and is ready at https://pr-1668.preview.docs.apify.com!

metalwarrior665

Just few small nits and good for me

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

ku3o

Hey Patrik 👋 ,

First of all, welcome to Apify 🎉 . Great to have you here. I have only one comment

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

…ronment_variables.md Co-authored-by: Lukáš Křivka <[email protected]>

apify-service-account · 2025-07-08T09:32:23Z

Preview for this PR was built for commit 507b9a1b and is ready at https://pr-1668.preview.docs.apify.com!

apify-service-account · 2025-07-08T09:40:52Z

Preview for this PR was built for commit dfbc6b86 and is ready at https://pr-1668.preview.docs.apify.com!

TC-MO

LGTM

docs: Improve Actors environment variables docs

ff39d10

Signed-off-by: Patrik Braborec <[email protected]>

patrikbraborec requested a review from TC-MO as a code owner July 3, 2025 20:51

cursor bot reviewed Jul 3, 2025

View reviewed changes

patrikbraborec added 2 commits July 3, 2025 22:58

chore: fix links in Actors environment docs

f59a3f2

Signed-off-by: Patrik Braborec <[email protected]>

docs: Change example in Actor environment docs

6e11302

Signed-off-by: Patrik Braborec <[email protected]>

TC-MO requested changes Jul 3, 2025

View reviewed changes

fix mdlint

1fe541d

metalwarrior665 requested changes Jul 4, 2025

View reviewed changes

Update sources/platform/actors/development/programming_interface/envi…

27c720a

…ronment_variables.md Co-authored-by: Michał Olender <[email protected]>

patrikbraborec and others added 3 commits July 4, 2025 13:29

Update sources/platform/actors/development/programming_interface/envi…

25207f7

…ronment_variables.md Co-authored-by: Michał Olender <[email protected]>

Update sources/platform/actors/development/programming_interface/envi…

2891771

…ronment_variables.md Co-authored-by: Michał Olender <[email protected]>

Update sources/platform/actors/development/programming_interface/envi…

c4cb588

…ronment_variables.md Co-authored-by: Michał Olender <[email protected]>

Update sources/platform/actors/development/programming_interface/envi…

f2aafda

…ronment_variables.md Co-authored-by: Michał Olender <[email protected]>

docs: Update env variables example

05cc36c

Signed-off-by: Patrik Braborec <[email protected]>

patrikbraborec and others added 2 commits July 4, 2025 16:14

docs: Add explanation of actor.json with git-workflow

3e83d6e

Signed-off-by: Patrik Braborec <[email protected]>

Update sources/platform/actors/development/programming_interface/envi…

97fb2d0

…ronment_variables.md Co-authored-by: Michał Olender <[email protected]>

Update sources/platform/actors/development/programming_interface/envi…

672168e

…ronment_variables.md Co-authored-by: Michał Olender <[email protected]>

docs: Fix note section

fa1a1f6

Signed-off-by: Patrik Braborec <[email protected]>

patrikbraborec self-assigned this Jul 4, 2025

TC-MO added documentation Improvements or additions to documentation. adhoc Ad-hoc unplanned task added during the sprint. labels Jul 4, 2025

patrikbraborec requested a review from honzajavorek as a code owner July 7, 2025 12:25

patrikbraborec force-pushed the improve-actors-env-docs branch from dd66c2e to fa1a1f6 Compare July 7, 2025 12:26

docs: Revert Configuration class section

7c9e756

Signed-off-by: Patrik Braborec <[email protected]>

patrikbraborec mentioned this pull request Jul 7, 2025

Improve / Change Configuration class section in env variables docs #1669

Open

metalwarrior665 requested changes Jul 8, 2025

View reviewed changes

sources/platform/actors/development/programming_interface/environment_variables.md Outdated Show resolved Hide resolved

sources/platform/actors/development/programming_interface/environment_variables.md Show resolved Hide resolved

ku3o reviewed Jul 8, 2025

View reviewed changes

sources/platform/actors/development/programming_interface/environment_variables.md Outdated Show resolved Hide resolved

Update sources/platform/actors/development/programming_interface/envi…

507b9a1

…ronment_variables.md Co-authored-by: Lukáš Křivka <[email protected]>

Fix how-to title grammar

dfbc6b8

metalwarrior665 approved these changes Jul 8, 2025

View reviewed changes

TC-MO approved these changes Jul 8, 2025

View reviewed changes

patrikbraborec merged commit 9c14e10 into master Jul 8, 2025
9 checks passed

patrikbraborec deleted the improve-actors-env-docs branch July 8, 2025 13:56

	# get api_token
	userId = os.environ['api_token']

	# print api_token to console
	print(userId)

docs: Improve Actors environment variables docs #1668

docs: Improve Actors environment variables docs #1668

Uh oh!

Conversation

patrikbraborec commented Jul 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

cursor bot left a comment

Choose a reason for hiding this comment

Bug: Misleading Variable Assignment in Python Example

Uh oh!

apify-service-account commented Jul 3, 2025

Uh oh!

apify-service-account commented Jul 3, 2025

Uh oh!

apify-service-account commented Jul 3, 2025

Uh oh!

TC-MO left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

apify-service-account commented Jul 3, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

apify-service-account commented Jul 4, 2025

Uh oh!

apify-service-account commented Jul 4, 2025

Uh oh!

apify-service-account commented Jul 4, 2025

Uh oh!

apify-service-account commented Jul 4, 2025

Uh oh!

apify-service-account commented Jul 4, 2025

Uh oh!

apify-service-account commented Jul 4, 2025

Uh oh!

apify-service-account commented Jul 4, 2025

Uh oh!

apify-service-account commented Jul 4, 2025

Uh oh!

apify-service-account commented Jul 4, 2025

Uh oh!

apify-service-account commented Jul 7, 2025

Uh oh!

apify-service-account commented Jul 7, 2025

Uh oh!

metalwarrior665 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

ku3o left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

apify-service-account commented Jul 8, 2025

Uh oh!

apify-service-account commented Jul 8, 2025

Uh oh!

TC-MO left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

patrikbraborec commented Jul 3, 2025 •

edited

Loading