Update LRE/store docs to fix #2406#2498
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
MarcusSorealheis
force-pushed
the
update-docs
branch
from
4eb7b28 to
2dcd819
Compare
|
|
||
| ```bash | ||
| nativelink ./nativelink-lre.json5 | ||
| build --remote_cache=grpcs://TODO |
There was a problem hiding this comment.
I thought I clarified that you would need to point at your value, in the comments.
| ## 5. Point `user.bazelrc` at a real cache and executor | ||
|
|
||
| ```bash | ||
| build --remote_cache=grpcs://TODO |
| Fill in [app.nativelink.com](https://app.nativelink.com) credentials | ||
| or your own cluster's endpoint. Leaving the placeholders in place | ||
| fails fast and specifically — this is the exact error building with | ||
| `grpcs://TODO` still in place produces: |
There was a problem hiding this comment.
the true issue is not the TODO. The issue is app.nativelink.com.
| ```bash | ||
| bazel build //hello | ||
| # In user.bazelrc | ||
| build --remote_cache=grpcs://TODO |
There was a problem hiding this comment.
did you read the comment above
There was a problem hiding this comment.
Just read now, I was going through the code changes.
| nix flake init -t github:TraceMachina/nativelink#lre | ||
| nix develop | ||
| ``` | ||
| - **[app.nativelink.com](https://app.nativelink.com)** — paste your |
There was a problem hiding this comment.
Although, this document specifies how to fill the TODOs, we should share an example or share the reference to this section whenever we have mentioned the TODOs. A user reading from top to bottom of the doc won't have the clue on where to find this TODOs.
|
Other than @amankrx's point about referring to the place where to fix the |
3 participants
Description
There were several issues. The LRE docs were specifically broken. There is also some confusion between users about looking to test or operate a nativelink cluster locally. This PR clears up that confusion and updates a couple more docs we should have updated upon adding the two new stores in Cloudflare and Oracle.
Fixes #2406
Type of change
Please delete options that aren't relevant.
How Has This Been Tested?
Please also list any relevant details for your test configuration
Checklist
bazel test //...passes locallygit amendsee some docsThis change is