SAP / SAP/cloud-sdk

Documentation of destination in .env is not sufficient

Open
#1,861 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
52
Forks
57
Avg merge
12h 33m
Merged PRs (30d)
18

Description

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

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with docs-js/tutorials/getting-started/2-execute-odata-request.mdx at the “Manage destinations centrally (optional)” section. Clarify the .env formatting and add an explicit valid quoted destinations example based on the reported error; verify the documentation renders correctly and the example is sufficient to configure the destination.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.