DOCS-4018: Add comprehensive table of supported platforms for cloud-build #4336
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
![promptless[bot]](https://avatars.githubusercontent.com/in/979718?s=60&v=4){kind=small}
|
👋 Thanks for contributing! A reviewer will look at it on the next working day! |
✅ Deploy Preview for viam-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
npentrel
reviewed
May 22, 2025
| @@ -244,6 +244,24 @@ For more details, see the [`upload-module` GitHub Action documentation](https:// | |||
|
|
|||
| Once the build is complete, the module will automatically update in the [Viam Registry](https://app.viam.com/registry), and the machines set to use the latest [version](/operate/reference/module-configuration/#module-versioning) of the module will automatically update to the new version. | |||
|
|
|||
| ## Supported platforms for cloud-build | |||
There was a problem hiding this comment.
JessamyT
reviewed
May 22, 2025
There was a problem hiding this comment.
Icons are nice but some comments:
- Biggest comment: "Cloud build" isn't a product--it's kind of just a GH action script we provide for convenience. I've tried to eliminate the term except for when referencing the wording of the CLI generator, and instead talk about it more conceptually, e.g. "a cloud build script" or something
- Feels a bit odd to have this chunk of reference in amongst the tasks
- [nit] Everything should be sentence case, including table headings
- [nit] Newlines
- [nit] Add periods to ends of things
penguinland
approved these changes
May 22, 2025
JessamyT
reviewed
May 22, 2025
| | `linux/arm32v6` | ✅ | ❌ | N/A | For older ARM devices; must be built manually | | ||
| | `linux/arm32v7` | ✅ | ❌ | N/A | For 32-bit ARM devices; must be built manually | | ||
| | `windows/amd64` | ⚠️ | ❌ | N/A | Works for pure Go modules, but may have issues with C++ or modules using C libraries | | ||
| | `darwin/amd64` | ❌ | ❌ | N/A | Intel Macs; not recommended as this platform is being phased out | |
There was a problem hiding this comment.
Passive voice and feels a bit informal?
Fixed nits. and moved the heading to an H4. Unless we want to create a reference page I think this info makes sense to live eith the "Update automatically" section |
npentrel
reviewed
May 23, 2025
npentrel
reviewed
May 23, 2025
npentrel
reviewed
May 23, 2025
npentrel
changed the title
michaellee1019
approved these changes
May 23, 2025
JessamyT
approved these changes
May 23, 2025
Co-authored-by: Jessamy Taylor <[email protected]>
…3c65-20250522-180906
npentrel
deleted the
docs-update-1c0ad906-b57b-42e5-a3b9-7e665b9e3c65-20250522-180906
branch
|
🔎💬 Inkeep AI search and chat service is syncing content for source 'Viam Docs' |
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.
Update the module management documentation to include a detailed table of all supported platforms for cloud-build, including which platforms are recommended, supported in cloud build, and any special considerations for each platform.