Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Doc improvment

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

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
35/100
Loại issue
Tài liệu
Độ rõ ràng
Cần làm rõ
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 so sánh các trang tài liệu v1 và v2 được liên kết trong issue, sau đó kiểm tra các điểm bắt đầu của tài liệu trong repository client này và thư viện v1 được tham chiếu. Done cần bao gồm một lộ trình rõ ràng từ tài liệu cũ đến tài liệu v2 và hướng dẫn phân biệt các phiên bản Python, client-library và InfluxDB được hỗ trợ.

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

Mô tả

question
Specifications

Minor item... As I'm navigating various online docs, I found these two:
old v1 client library: https://influxdb-python.readthedocs.io/en/latest/include-readme.html
new v2 client library: https://influxdb-client.readthedocs.io/en/stable/
It would have been convenient (for me) for the old doc to link to the newer doc, but that github repository is archived:
This repository has been archived by the owner on Jul 18, 2023. It is now read-only.
This is in the influxdata github repository so I will just leave this here as a suggested fix if that's OK.
Of course, I could have navigated github itself and found v2 docs that way...
More generally - are there no conventions (in Python) for indicating which versions we are working with? I'm currently learning python 3.12, influx client 2, influx 2.x and regularly stumbling into older examples and documentation. I have an extensive IT background so ought to know how to locate docs and resources, but it's like we're purposely making life hard for our (future) selves.

Code sample to reproduce problem

N/A

Expected behavior

N/A

Actual behavior

N/A

Additional info

This has been added by Zoe - The devrel. To come back and address in here, the v1 library, and the docs

Ngôn ngữ chính
Python
Star
792
Fork
186
Merge trung bình
3 giờ 2 phút
Pull request đã merge (30 ngày)
1

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

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

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 influxdata/influxdb-client-python

Tất cả issue của influxdata/influxdb-client-python

Issue tương tự

Thêm issue về Python

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.