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

Conda index CLI reference page maybe should be updated to reference separate conda-index tool #5235

Open
2 tasks done
PatSunter opened this issue Mar 14, 2024 · 1 comment
Labels
type::documentation request for improved documentation

Comments

@PatSunter
Copy link

Checklist

  • I added a descriptive title
  • I searched open reports and couldn't find a duplicate

What happened?

TL; DR: it looks like the "conda index" docs reference page now needs to be updated to redirect users to read https://conda.github.io/conda-index/#conda-index now it's a separate project and had to be invoked differently.

More detail: I have been using an older conda-build version and running the conda index command happily until recently (3.28.2) .

However having just upgraded to conda-build package version 24.1.2 - the conda index command stopped being available.

Going doc-hunting on the internet the first hit I find is this project's https://docs.conda.io/projects/conda-build/en/latest/resources/commands/conda-index.html reference page - which as of today (14 Feb 2024) says to run conda index as I did previously.

Some extra searching and I found https://github.com/conda/conda-index?tab=readme-ov-file#conda-index, and pieced together that it's now a separate project, and my conda env update meant I had switched to using it.

As those docs currently say re how to invoke conda index when using the new package:

python -m conda_index
Note conda index (instead of python -m conda_index) may find legacy conda-build index.

So replacing the conda-index docs page in this repo with some redirect guidance would be nice please - especially for users like me in this conda update conda-build use-case.

Additional Context

No response

@PatSunter PatSunter added the type::documentation request for improved documentation label Mar 14, 2024
@PatSunter
Copy link
Author

Ah - further to this issue report, via looking at https://github.com/conda/conda-index/blob/main/CHANGELOG.md#040-2024-01-29 I see there is now supposed to be ability to run conda index command and invoke the new separate conda-index, per:
conda/conda-index#81

Which back-references in this project issues/PRs #4828, #4645 - and one of those references a PR to start marking conda-index as deprecated: #4885 .

So a couple of remarks to help close this issue:

  1. Re Use deprecated.topic for conda-build index deprecation. #4885 - I see it added a note into changelog:
    There is a note about the deprecated behaviour showing at:
    https://docs.conda.io/projects/conda-build/en/24.3.x/release-notes.html#id46

but there is no "deprecated" text showing on this page right now (feel like something warranted here): https://docs.conda.io/projects/conda-build/en/24.3.x/resources/commands/conda-build.html

  1. Re why I had trouble running conda index after I did an upgrade:

Reading the conda-build docs again I see in this page:
https://docs.conda.io/projects/conda-build/en/latest/install-conda-build.html

... your pretty strong recommendation to install conda-build into a base environment.

Having just done this, I now can run conda build and it appears to be using the new separate conda-build package judging by the updated output I get.

So maybe not too much needs to change re these docs ?? But perhaps still some note on the conda index CLI reference page to make it clear that it's now being provided by a separate tool.

@PatSunter PatSunter changed the title Conda index reference page now incompatible with separate conda-index tool that is invoked differently Conda index CLI reference page maybe should be updated to reference separate conda-index tool Mar 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type::documentation request for improved documentation
Projects
Status: 🆕 New
Development

No branches or pull requests

1 participant