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

Documentation of destination in .env is not sufficient #1861

Open
AdrianRygiol opened this issue Jul 15, 2024 · 2 comments
Open

Documentation of destination in .env is not sufficient #1861

AdrianRygiol opened this issue Jul 15, 2024 · 2 comments

Comments

@AdrianRygiol
Copy link

Dear SAP Cloud SDK colleagues,

the documentation of the destination in .env file is not sufficient here:

https://github.com/SAP/cloud-sdk/blob/main/docs-js/tutorials/getting-started/2-execute-odata-request.mdx#manage-destinations-centrally-optional

With the sentence alone Every environment variable in the .env file has to be defined on one line I could not make it work.

I always got errors like Error in reading the given destinations from the environment variable Error in parsing the destinations from the environment variable...

After many attempts, finally I found out that the destination in .env must use quotation marks and must look as follows:

destinations='[{"name": "<DESTINATIONNAME_1>", "url": "<URL to your system>", "username": "<USERNAME>", "password": "<PASSWORD>",{"name": "<DESTINATIONNAME_2>", "url": "<URL to your system>", "username": <USERNAME>", "password": "<PASSWORD>"}]'

Could you please improve the documentation here and add such an explicit example for a valid .env string?

Thanks and best regards,
Adrian

@tomfrenken
Copy link
Member

tomfrenken commented Jul 16, 2024

Hi @AdrianRygiol,

thank you for your feedback.

If I search for your exact use case of local destinations, I immediately find this entry in our documentation, do you feel like anything is missing here? Or would you rather hope for a dedicated .env file section, separate from e.g. the destinations subsection of our documentation?

@tomfrenken
Copy link
Member

After reading through the documentation that you've linked, I can see how that can be confusing, I will create a PR to update this specific part of our documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants