Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc improvment #646

Open
zoesteinkamp opened this issue Mar 21, 2024 · 3 comments
Open

Doc improvment #646

zoesteinkamp opened this issue Mar 21, 2024 · 3 comments
Labels
question Further information is requested

Comments

@zoesteinkamp
Copy link

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

@zoesteinkamp zoesteinkamp added the bug Something isn't working label Mar 21, 2024
@bednar
Copy link
Contributor

bednar commented Apr 2, 2024

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

@bednar bednar added question Further information is requested and removed bug Something isn't working labels Apr 2, 2024
@powersj
Copy link
Contributor

powersj commented Apr 22, 2024

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
Copy link
Contributor

bednar commented Apr 23, 2024

Thx @powersj

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

3 participants