Documentation of destination in .env is not sufficient

Đang mở
  • Có gì không ổn?
#1,861 2 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
1/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
45/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
javascript
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu với docs-js/tutorials/getting-started/2-execute-odata-request.mdx tại phần “Manage destinations centrally (optional)”. Làm rõ định dạng .env và thêm một ví dụ rõ ràng, hợp lệ về destinations được đặt trong dấu ngoặc kép dựa trên lỗi đã được báo cáo; xác minh rằng tài liệu được hiển thị chính xác và ví dụ đủ để cấu hình destination.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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

Ngôn ngữ chính
HTML
Star
52
Fork
57
Merge trung bình
2 ngày 1 giờ
Pull request đã merge (30 ngày)
20

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của SAP/cloud-sdk

Tất cả issue của SAP/cloud-sdk

Issue tương tự

Thêm issue về Documentation

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.