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

feat: update bazel documentation and enable bazel-module manager #22803

Merged
merged 26 commits into from
Jun 16, 2023
Merged

feat: update bazel documentation and enable bazel-module manager #22803

merged 26 commits into from
Jun 16, 2023

Conversation

cgrindel
Copy link
Contributor

Changes

  • Update the Bazel documentation to include information on Bazel module support.
  • Enable the bazel-module manager.

Context

Closes #13658.

Documentation (please check one with an [x])

  • I have updated the documentation, or
  • No documentation update is required

How I've tested my work (please select one)

I have verified these changes via:

  • Code inspection only, or
  • Newly added/modified unit tests, or
  • No unit tests but ran on a real repository, or
  • Both unit tests + ran on a real repository

@viceice viceice requested a review from HonkingGoose June 15, 2023 18:32
Copy link
Member

@viceice viceice left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

needs lint fix

@cgrindel
Copy link
Contributor Author

@viceice Thanks. It took me a minute to find the doc-fix command.

@cgrindel cgrindel requested a review from viceice June 15, 2023 18:34
@zharinov
Copy link
Collaborator

Seems like we have sort of flip-flop issue with codecov status

Copy link
Collaborator

@HonkingGoose HonkingGoose left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

First round of fixes:

  • Reduce capitalization in headings
  • Use lists
  • Rely on the Markdown renderer (or the site build process) to number ordered lists correctly like 1. 2. 3. 4. ....
  • Use simple words and phrases
  • Remove duplicate words from list items by creating a platform sentence

docs/usage/bazel.md Outdated Show resolved Hide resolved
docs/usage/bazel.md Outdated Show resolved Hide resolved
docs/usage/bazel.md Outdated Show resolved Hide resolved
docs/usage/bazel.md Outdated Show resolved Hide resolved
docs/usage/bazel.md Outdated Show resolved Hide resolved
docs/usage/bazel.md Outdated Show resolved Hide resolved
docs/usage/bazel.md Outdated Show resolved Hide resolved
docs/usage/bazel.md Outdated Show resolved Hide resolved
docs/usage/bazel.md Show resolved Hide resolved
docs/usage/bazel.md Show resolved Hide resolved
@cgrindel cgrindel requested a review from HonkingGoose June 15, 2023 19:53
Copy link
Collaborator

@HonkingGoose HonkingGoose left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Second round of review. 🙂

docs/usage/bazel.md Outdated Show resolved Hide resolved
docs/usage/bazel.md Outdated Show resolved Hide resolved
docs/usage/bazel.md Outdated Show resolved Hide resolved
docs/usage/bazel.md Outdated Show resolved Hide resolved
docs/usage/bazel.md Outdated Show resolved Hide resolved
docs/usage/bazel.md Outdated Show resolved Hide resolved
docs/usage/bazel.md Outdated Show resolved Hide resolved
docs/usage/bazel.md Outdated Show resolved Hide resolved
@cgrindel cgrindel requested a review from HonkingGoose June 15, 2023 20:43
rarkins
rarkins previously approved these changes Jun 16, 2023
Copy link
Member

@viceice viceice left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

waiting for @HonkingGoose approval

Copy link
Collaborator

@HonkingGoose HonkingGoose left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Last round. 😉

docs/usage/bazel.md Outdated Show resolved Hide resolved
docs/usage/bazel.md Outdated Show resolved Hide resolved
docs/usage/bazel.md Outdated Show resolved Hide resolved
docs/usage/bazel.md Outdated Show resolved Hide resolved
docs/usage/bazel.md Outdated Show resolved Hide resolved
docs/usage/bazel.md Outdated Show resolved Hide resolved
docs/usage/bazel.md Outdated Show resolved Hide resolved
docs/usage/bazel.md Outdated Show resolved Hide resolved
docs/usage/bazel.md Outdated Show resolved Hide resolved
docs/usage/bazel.md Outdated Show resolved Hide resolved
@cgrindel
Copy link
Contributor Author

@HonkingGoose I made another pass through the document to ensure we use the same voice.

Copy link
Collaborator

@HonkingGoose HonkingGoose left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks way better after your voice passes. 🥳 There are still some small things to fix though.

docs/usage/bazel.md Outdated Show resolved Hide resolved
docs/usage/bazel.md Outdated Show resolved Hide resolved
@cgrindel cgrindel requested a review from HonkingGoose June 16, 2023 17:21
Copy link
Collaborator

@HonkingGoose HonkingGoose left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ready to merge after fixing this thing. 😉

docs/usage/bazel.md Outdated Show resolved Hide resolved
@cgrindel cgrindel requested a review from HonkingGoose June 16, 2023 17:53
@rarkins rarkins added this pull request to the merge queue Jun 16, 2023
Merged via the queue into renovatebot:main with commit 8131b43 Jun 16, 2023
@cgrindel cgrindel deleted the feat/13658_bazel_module_bazel_doc branch June 16, 2023 19:47
@renovate-release
Copy link
Collaborator

🎉 This PR is included in version 35.123.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 17, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bazel: support bzlmod
6 participants