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

Use the .env file consistently in SDK getting started guides #2190

Open
jlvandenhout opened this issue Mar 15, 2024 · 2 comments
Open

Use the .env file consistently in SDK getting started guides #2190

jlvandenhout opened this issue Mar 15, 2024 · 2 comments
Assignees

Comments

@jlvandenhout
Copy link
Contributor

Description

Use the .env file for setting environment variables consistently for all applicable variables and for all supported languages.

For example the Rust wallet guide currently uses the .env file only for the node URL, but not for Stronghold password and path. Python uses .env for the node URL and Stronghold password with defaults, but not for the Stronghold path. etc.

Motivation

It would benefit both maintaining the getting started examples themselves, and maintaining the Wiki guides, if we would use the .env file for setting environment variables consistently for all required variables and for all languages.

Are you planning to do it yourself in a pull request?

No

@Thoralf-M
Copy link
Member

Didn't we don't want to use .env at all for the getting started examples? I know for Rust it was changed here 69c695b#diff-bafc1c2f478b5b7c62dfa933ff5930af67f2bf938ff7dfb4fd375a2a499db864 but we can just undo this

@thibault-martinez thibault-martinez added this to the v2.0.0 (Q1 2024) milestone Mar 18, 2024
@jlvandenhout
Copy link
Contributor Author

Correct. But seeing we keep getting back to the .env file, I'd say we stop fighting the system. The sole reason for moving away from .env for getting started guides was so we could make them as "copy-paste" as possible. But seeing this results in unmaintained or incorrect guides quite easily, I say let's move back to using .env like all the rest of the examples and we'll make sure to explain the use of .env and list the proper dependencies on the Wiki side.

@thibault-martinez thibault-martinez self-assigned this Apr 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Sprint Backlog
Development

No branches or pull requests

3 participants