Documentation is inconsistent

[UebelAndre]

🐞 bug report

Description

In trying to use the "experimental"/"modern" rev of this repository in this workspace, I stumbled across some documentation I found to be unclear or incorrect.

• In Getting Started users are instructed to load and call a deprecated macro pip_repositories
• It's unclear how to use dependencies loaded from the non-legacy section on Importing pip dependencies
• It's also not clear what information is in ./docs It appears to be legacy information since the pip documentation is missing pip_install

I think it'd be awesome if someone with context on the current state of the repository could do a refresh on the documentation here 🙏 .

[thundergolfer]

In Getting Started users are instructed to load and call a deprecated macro pip_repositories

Oh yep thanks for pointing this out. Obsolete info.

It's unclear how to use dependencies loaded from the non-legacy section

That detail is in Consuming Pip Dependencies. Do you think that the sections are too separated?

It's also not clear what information is in ./docs

Yeh that folder contained documentation that seemed to be once published to Github pages:

I wasn't around when that Github pages site was even working, if it did ever. We've got to sort out the connection between this repo's documentation and the official Bazel documentation. It should be a separate issue.

[UebelAndre]

That detail is in Consuming Pip Dependencies. Do you think that the sections are too separated?

No, I just didn't know if that was referring to the legacy way of doing things. I think I was just confused by the layout of the doc

I wasn't around when that Github pages site was even working, if it did ever. We've got to sort out the connection between this repo's documentation and the official Bazel documentation. It should be a separate issue.

Is there a separate issue for that?

[UebelAndre]

I would probably opt to remove the "legacy" documentation. It should be there in the versions people are using, right?

[thundergolfer]

@UebelAndre it looks like the main outstanding item is:

It's unclear how to use dependencies loaded from non-legacy section ...

What action should be taken to close out this issue? Note that the latest README changes are PR'd here: #501

[github-actions]

This issue has been automatically marked as stale because it has not had any activity for 180 days. It will be closed if no further activity occurs in 30 days.
Collaborators can add an assignee to keep this open indefinitely. Thanks for your contributions to rules_python!

[UebelAndre]

The "legacy" documentation was removed in #582 which now covers all my concerns here. Closing this issue out.