plotly / plotly/plotly.js

[mkdocs] some examples don't run in the docs

Đang mở
#7,640 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

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

bug
Ngôn ngữ chính
JavaScript
Star
18.3k
Fork
2k
Merge trung bình
2 ngày 12 giờ
Pull request đã merge (30 ngày)
28

Mô tả

If you take an example like this from the current docs, it doesn't run in the mkdocs site

https://plotly.com/javascript/tile-map-layers/#openstreetmap-tiles

This example uses d3 but the mkdocs site isn't loading that.

We should:

  • determine what other JS libraries are needed by the docs and ensure the are loaded
    and/or
  • rewrite examples to make sure no additional JS libraries are needed

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

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.

Hướng nghiên cứu

Bắt đầu với ví dụ về các ô bản đồ OpenStreetMap trong tài liệu JavaScript được liên kết và kiểm tra cách trang MkDocs tải các tập lệnh của mình. Xác định các ví dụ tài liệu khác phụ thuộc vào các thư viện JavaScript bên ngoài, sau đó bảo đảm các thư viện đó được tải hoặc các ví dụ không còn cần đến chúng; công việc được xem là hoàn tất khi các ví dụ bị ảnh hưởng chạy được trên trang MkDocs.

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

Đánh giá

Công nghệ
d3, javascript
Lĩnh vực
documentation, web-dev
Loại issue
Lỗi
Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
35/100

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.