Rewrite examples and new user documentation #4251
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Added examples/hello and examples/basic_gazelle. The first is a minimal
example, the second uses Gazelle. Both use modules.
- Removed examples/basic-gazelle. It served as an example for a tutorial
that's been replaced upstream. It used WORKSPACE, so it needed an
update. I replaced it with a smaller example, since it pulled in
a lot of external dependencies.
- Updated .bazelci/presubmit.yml to build examples on all platforms.
I wonder if we want to use bazel_integration_test or go_bazel_test
for this though.
- Several updates to README.rst:
- Removed Announcements section since it's a bit cluttered and doesn't mention
recent releases.
- Fixed formatting on gomock link.
- Removed "The rules are in the beta stage of development" since they're
actually pretty mature.
- Added arm64 as a supported platform. It's being tested on macOS at least.
- Rewrote the Setup section to link to the new user tutorial, the two
examples, and the bzlmod/WORKSPACE docs.
This reverts commit bd629cf.
fmeum
approved these changes
Feb 8, 2025
Co-authored-by: Fabian Meumertzheim <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What type of PR is this?
What does this PR do? Why is it needed?
Which issues(s) does this PR fix?
Fixes #3717
Fixes #3183
Fixes #1912
Fixes #1154
Updates #1643
Other notes for review