Documentation of destination in .env is not sufficient
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 1/5
- 見積もり時間
- 1〜3時間
- 初心者へのやさしさ
- 45/100
- issue の種類
- ドキュメント
- 明瞭さ
- 明確に書かれている
- 活発さ
- 停滞
- 技術スタック
- javascript
調査の方向性
docs-js/tutorials/getting-started/2-execute-odata-request.mdx の「Manage destinations centrally (optional)」セクションから始めます。.env の形式を明確にし、報告されたエラーに基づいて、引用符で囲んだ destinations の有効な例を明示的に追加します。ドキュメントが正しくレンダリングされ、例だけで destination を設定できることを確認します。
索引モデルが issue の本文から書いたものです。
説明
Dear SAP Cloud SDK colleagues,
the documentation of the destination in .env file is not sufficient here:
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
- 主要言語
- HTML
- スター
- 52
- フォーク
- 57
- 平均マージ
- 2日 1時間
- マージ済み PR（30日）
- 20
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
SAP/cloud-sdk のほかの issue
-
Docs: 2 broken linksオープン
難易度 1/5 1時間未満 初心者へのやさしさ 78/100
メンテナーはふだん 1 日以内に返信
-
feedback
難易度 2/5 1〜3時間 初心者へのやさしさ 35/100
SAP/cloud-sdk#1829 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
enhancement feature request Java waiting for release
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
SAP/cloud-sdk#742 · コメント 6 件 ·
メンテナーはふだん 1 日以内に返信
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
osrep/Runes2P.jl#279 ·
メンテナーはふだん 1 日以内に返信
-
documentation good first issue help wanted
難易度 2/5 半日 初心者へのやさしさ 72/100
Is0cre/MonkeyThrive#6 ·
-
bug
難易度 1/5 1時間未満 初心者へのやさしさ 65/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
Imbad0202/academic-research-skills#1093 ·
メンテナーはふだん 1 日以内に返信
-
1.3 documentation
難易度 1/5 1〜3時間 初心者へのやさしさ 78/100