Docs: include a 'How do I...?' table to direct on common tasks
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 4/5
- Thời gian dự kiến
- 3-5 ngày
- Mức phù hợp với người mới
- 42/100
- Loại issue
- Tài liệu
- Độ rõ ràng
- Khá rõ ràng
- Mức độ hoạt động
- Đình trệ
- Công nghệ
- python
- Lĩnh vực
- documentation
Hướng nghiên cứu
Bắt đầu bằng cách xem lại bảng “How do I...?” tương ứng trong tài liệu xarray, sau đó kiểm tra cấu trúc tài liệu hiện có của repository này. Tạo một trang tài liệu ánh xạ các tác vụ phổ biến của người dùng tới các phương thức, tham chiếu API, ví dụ, hướng dẫn và công thức liên quan khi phù hợp; được xem là hoàn thành khi bảng cung cấp các liên kết điều hướng đó cho các tác vụ đã xác định.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
As part of our summit this week, we have identified that users would benefit from a page in the documentation which centers around a table which list common tasks that a user might want to do and maps them to relevant methods and their API reference pages; examples; and documentation sections.
A great example of this is an equivalent table in the xarray docs. As well as pointing to methods of direct relevance as per that table, we can include some extra columns which point to relevant sections of the Tutorial and relevant recipes, where applicable.
- Ngôn ngữ chính
- Python
- Star
- 151
- Fork
- 23
- Merge trung bình
- 21 giờ 29 phút
- Pull request đã merge (30 ngày)
- 1
Chuẩn bị môi trường
- Không có Dockerfile hay tệp Docker Compose
- Không có mẫu pull request
- Đọc hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- 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.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của NCAS-CMS/cf-python
-
code tidy
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 76/100
-
Attempt at unsupported conservative 3D mesh regriddingCó thể đã có người làm @sadielbartholomew đã nhận 22 ngày trước. Đang mởbug?
-
Release: migrate from deprecated build commandCó thể đã có người làm @sadielbartholomew đã nhận 24 ngày trước. Đang mởrelease
-
Remove support for Python 3.10 (EOL)Có thể đã có người làm @sadielbartholomew đã nhận 24 ngày trước. Đang mởenhancement
-
error from netCDF in cf.writeĐang mởbug
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 45/100
Tất cả issue của NCAS-CMS/cf-python
Issue tương tự
-
adr
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
kristofdegrave/homeassistant-smart-charging#1607 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
namespace operations
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 64/100
EclipseFdn/open-vsx.org#13665 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
doc good first issue help wanted
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
collective/icalendar#1865 · 2 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 82/100
canonical/opentelemetry-collector-operator#409 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 85/100
mozilla/addons-release-tests#1243 ·
Maintainer thường phản hồi trong vòng 1 ngày