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

DOCS-3524: Update code deployment docs #3964

Merged
merged 4 commits into from
Feb 5, 2025

Conversation

npentrel
Copy link
Collaborator

@npentrel npentrel commented Feb 4, 2025

@viambot viambot added the safe to build This pull request is marked safe to build from a trusted zone label Feb 4, 2025
Copy link

netlify bot commented Feb 4, 2025

Deploy Preview for viam-docs ready!

Name Link
🔨 Latest commit 5037a6b
🔍 Latest deploy log https://app.netlify.com/sites/viam-docs/deploys/67a3be4631f0da000836343a
😎 Deploy Preview https://deploy-preview-3964--viam-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 38 (🟢 up 12 from production)
Accessibility: 98 (no change from production)
Best Practices: 100 (no change from production)
SEO: 92 (no change from production)
PWA: 70 (no change from production)
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

@npentrel npentrel force-pushed the DOCS-3524 branch 2 times, most recently from 525ebcd to ad4532e Compare February 5, 2025 19:18
@viambot
Copy link
Member

viambot commented Feb 5, 2025

It looks like the following files may have been renamed. Please ensure you set all needed aliases:
rename docs/manage/software/{deploy-packages.md => deploy-software.md} (26%) rename docs/manage/software/{update-packages.md => update-software.md} (72%)

@npentrel npentrel merged commit 37c6c8a into viamrobotics:main Feb 5, 2025
12 checks passed
@npentrel npentrel deleted the DOCS-3524 branch February 5, 2025 20:50
Copy link

github-actions bot commented Feb 5, 2025

🔎💬 Inkeep AI search and chat service is syncing content for source 'Viam Docs (https://docs.viam.com)'

{{% tablestep link="/operate/get-started/supported-hardware/" %}}
**1. Configure your software**

Go to your [machine](#prerequisites) in the [Viam app](https://app.viam.com).
Copy link
Contributor

@nataliajacobowitz nataliajacobowitz Feb 5, 2025

Choose a reason for hiding this comment

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

How does a user know which machine? Now i see that i what the prereqs say.
Though I found the prereqs confusing too

You can operate devices by running control logic on another device, for example using an app, or on the machine itself using a {{< glossary_tooltip term_id="module" text="module" >}}.
If all your machine control logic runs on another device or server, move on to [Create a fragment](#create-a-fragment).

If at least some of your machine control logic should run on your machine, place the control logic in a module by following these steps:
Copy link
Contributor

Choose a reason for hiding this comment

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

How do I know if it should run on the machine?

If you want your control logic to run in a loop in the background, you can start this loop here.
Be sure to also implement logic to handle subsequent calls to the reconfigure method gracefully.

For example, in Python, start your logic in <FILE>src/main.py</FILE>:
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't personally know what to make of this example, a lot here and can't tell what is needed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
safe to build This pull request is marked safe to build from a trusted zone
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants