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.

Sign up for GitHub

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

Jump to bottom

Bzlmod /external/migration page does not mention --enable_bzlmod #19561

Closed
jlisee opened this issue Sep 19, 2023 · 3 comments
Closed

Bzlmod /external/migration page does not mention --enable_bzlmod #19561

jlisee opened this issue Sep 19, 2023 · 3 comments
Assignees
@meteorcloudy
Labels
help wanted Someone outside the Bazel team could own this P2 We'll consider working on this in future. (Assignee optional) team-ExternalDeps External dependency handling, remote repositiories, WORKSPACE file. type: documentation (cleanup)

Comments

@jlisee
Copy link
Contributor

jlisee commented Sep 19, 2023 •
edited
Loading

Page link:

https://bazel.build/external/migration

Problem description (include actual vs expected text, if applicable):

The need for the --enable_bzlmod flag is mentioned only once in the bzlmod overview page. It's easy to miss this which means you spend a while figuring out why none of the Bzlmod sample content is working for you.

At a minimum tutorials like the migration guide should mention it, but in general the flag and how to use it need to much more prominent in the documentation and general examples. For example this external guide mentions setting the flag in your RC file as the first step before doing anything else.

Where do you see this issue? (include link to specific section of the page, if applicable)

The https://bazel.build/external/migration is missing information on using the flag.

Any other information you'd like to share?

Here is a proposed documentation patch. I can make this a PR if desired:
master...jlisee:bazel:jlisee/bzlmod-flag-migration-guide
@jlisee jlisee added team-Documentation Documentation improvements that cannot be directly linked to other team labels type: documentation (cleanup) untriaged labels Sep 19, 2023
@jlisee jlisee changed the title [bazel.build] Problem with /external/migration Bzlmod /external/migration page does not mention --enable_bzlmod Sep 19, 2023
@keertk
Copy link
Member

keertk commented Sep 19, 2023

Thanks for the issue and proposed doc fix, @jlisee!
cc @Wyverald to take a look and confirm

@keertk keertk added the team-ExternalDeps External dependency handling, remote repositiories, WORKSPACE file. label Sep 19, 2023
@meteorcloudy meteorcloudy self-assigned this Sep 20, 2023
@meteorcloudy meteorcloudy added P2 We'll consider working on this in future. (Assignee optional) help wanted Someone outside the Bazel team could own this and removed untriaged team-Documentation Documentation improvements that cannot be directly linked to other team labels labels Sep 20, 2023
@meteorcloudy
Copy link
Member

@jlisee Thanks for reporting, happy to review the PR!

@jlisee jlisee mentioned this issue Sep 20, 2023
Closed
@jlisee
Copy link
Contributor Author

jlisee commented Sep 20, 2023

@jlisee Thanks for reporting, happy to review the PR!

PR up at #19574

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@meteorcloudy meteorcloudy

Labels
help wanted Someone outside the Bazel team could own this P2 We'll consider working on this in future. (Assignee optional) team-ExternalDeps External dependency handling, remote repositiories, WORKSPACE file. type: documentation (cleanup)
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Update bzlmod migration to mention enable_bzlmod jlisee/bazel
6 participants
@jlisee @meteorcloudy @sgowroji @keertk @Pavank1992 @iancha1992