DOCS-2881: Revamp Micro-RDK docs #4241
Conversation
viambot
added
the
safe to build
✅ Deploy Preview for viam-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
EshaMaharishi
left a comment
EshaMaharishi
left a comment
There was a problem hiding this comment.
Nice work! Left a few comments
docs/operate/reference/viam-micro-server/micro-troubleshooting.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Esha Maharishi <esha.maharishi@gmail.com>
| ## Build firmware with cloud build | ||
|
|
||
| When developing and testing your firmware, it is easiest to build firmware locally. | ||
| When you are ready to deploy your firmware to a fleet of microcontrollers, you can use the Viam cloud build service to simplify the process of building and hosting your firmware by eliminating the need to build locally and then upload the firmware image to a cloud storage bucket. |
There was a problem hiding this comment.
I think it's okay to see how you would configure OTA and then how you would produce a URL - especially because I think we could also make the cloud build instructions shorter, like:
- Create a GitHub repository for your firmware project. Note that any modules included in the firmware must point to GitHub repositories (not a local path).
- [Current Step 5]
- [Current Step 6]
In particular I don't think we should mention any of the credentials stuff (I appreciate you thinking about this though!) because the plan for https://viam.atlassian.net/browse/RSDK-10503 is to stop putting credentials in the firmware build, and instead only providing them at flash time via the micro-rdk-installer.
For including how to build OTA firmware locally - in a way I thought it was nice since it clarifies that OTA supports any URL, not just the one from cloud builds. And I liked the short and simple way you described it.
nathan-contino
left a comment
nathan-contino
left a comment
There was a problem hiding this comment.
LGTM, a lot of my comments are optional and/or focused on content that you slightly changed, but didn't originally write.
Co-authored-by: nate contino <ncontino@u.rochester.edu> Co-authored-by: Esha Maharishi <esha.maharishi@gmail.com>
Co-authored-by: nate contino <ncontino@u.rochester.edu>
Co-authored-by: nate contino <ncontino@u.rochester.edu>
|
It looks like the following files may have been renamed. Please ensure you set all needed aliases: |
|
🔎💬 Inkeep AI search and chat service is syncing content for source 'Viam Docs' |
4 participants
No description provided.