Skip to content
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.

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

docs: improve environment variables section #1124

Merged
merged 10 commits into from
Aug 9, 2024
Merged

Conversation

TC-MO
Copy link
Contributor

@TC-MO TC-MO commented Jul 28, 2024

remove outdated screenshots and instructions
make sure instructions reflect current state
reformat md table to be more readable
change doc structure and logical flow
add admonitions

TC-MO added 2 commits July 29, 2024 00:07
remove outdated screenshots and instructions
make sure instructions reflect current state
reformat md table to be more readable
change doc structure and logical flow
add admonitions
@github-actions github-actions bot added the t-docs Issues owned by technical writing team. label Jul 28, 2024
@mtrunkat mtrunkat requested a review from jirimoravcik July 29, 2024 13:36
@TC-MO TC-MO requested a review from janbuchar August 7, 2024 12:40
Copy link
Contributor

@janbuchar janbuchar left a comment

Choose a reason for hiding this comment

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

Thanks so much for this! Are there still some internal variables that should be included? Also, we may mention the deprecated forms of some variables, for example APIFY_DEFAULT_DATASET_ID

TC-MO added 2 commits August 8, 2024 13:04
updated env var tables with description to missing ones
disable GeneralURL vale rule
@TC-MO
Copy link
Contributor Author

TC-MO commented Aug 8, 2024

Thanks so much for this! Are there still some internal variables that should be included? Also, we may mention the deprecated forms of some variables, for example APIFY_DEFAULT_DATASET_ID

I kind of hoped the spreadsheet was all that was missing :D

@janbuchar
Copy link
Contributor

Thanks so much for this! Are there still some internal variables that should be included? Also, we may mention the deprecated forms of some variables, for example APIFY_DEFAULT_DATASET_ID

I kind of hoped the spreadsheet was all that was missing :D

If you put everything in the spreadsheet into the docs, then yeah, that should do it 🙂 I don't think that for example APIFY_INPUT_SECRETS_PRIVATE_KEY_FILE is in the updated doc though.

@TC-MO TC-MO requested a review from janbuchar August 8, 2024 12:54
@TC-MO TC-MO requested a review from janbuchar August 9, 2024 10:07
Copy link
Contributor

@janbuchar janbuchar left a comment

Choose a reason for hiding this comment

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

Good stuff!

@TC-MO TC-MO merged commit eb436e1 into master Aug 9, 2024
7 checks passed
@TC-MO TC-MO deleted the development-env-var branch August 9, 2024 11:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
t-docs Issues owned by technical writing team.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants