influxdata / influxdb-client-python

InfluxDB 2.0 python client
https://influxdb-client.readthedocs.io/en/stable/
MIT License
706 stars 185 forks source link

Doc improvment #646

Open zoesteinkamp opened 5 months ago

zoesteinkamp commented 5 months ago

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

bednar commented 5 months ago

Hi @zoesteinkamp,

thanks for your suggestion.

The v1 docs has link to the v2 repository:

image

Are you suggesting to add direct link to the v2 docs?

More generally - are there no conventions (in Python) for indicating which versions we are working with?

I don't think so...

Best Regards

powersj commented 4 months ago

It would have been convenient (for me) for the old doc to link to the newer doc, but that github repository is archived:

FYI I had to unarchive the v1 library to fix an issue. I updated the README as well to point to the v2 library as well.

bednar commented 4 months ago

Thx @powersj