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.

Sign up for GitHub

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

Jump to bottom

DOCS-3423: Improve capture sync data #3950

Closed
wants to merge 2 commits into from
Closed

DOCS-3423: Improve capture sync data #3950

wants to merge 2 commits into from

Conversation

sguequierre
Copy link
Contributor

@sguequierre sguequierre commented Jan 31, 2025 •
edited
Loading

  • incorporating the last of Jack's feedback here as well as a couple small things I found

@viambot viambot added the safe to build This pull request is marked safe to build from a trusted zone label Jan 31, 2025
@netlify Netlify
Copy link

netlify bot commented Jan 31, 2025 •
edited
Loading

✅ Deploy Preview for viam-docs ready!

Name Link
🔨 Latest commit fdc85ac
🔍 Latest deploy log https://app.netlify.com/sites/viam-docs/deploys/679cef2ff93b0e0008fcdd96
😎 Deploy Preview https://deploy-preview-3950--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: 26 (🔴 down 3 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.

@sguequierre sguequierre changed the title DOCS-3423: More feedback from jack DOCS-3423: Improve capture sync data Jan 31, 2025
npentrel
npentrel reviewed Jan 31, 2025
View reviewed changes
Copy link
Collaborator

@npentrel npentrel left a comment

Choose a reason for hiding this comment

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

All good aside from the save instructions - maybe we can make them shorter instead? What's the thinking on that?

docs/data-ai/capture-data/capture-sync.md
@@ -46,6 +46,7 @@ You can also sync data from arbitrary folders on your machine.
## Configure the data management service

To start, configure the data management service to capture and sync data.
Data management is available for both `{{< glossary_tooltip term_id="viam-server" text="viam-server" >}}` and `{{< glossary_tooltip term_id="viam-micro-server" text="viam-micro-server" >}}`, but the configuration attributes available are different.
Copy link
Collaborator

Choose a reason for hiding this comment

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

nit

Suggested change
Data management is available for both `{{< glossary_tooltip term_id="viam-server" text="viam-server" >}}` and `{{< glossary_tooltip term_id="viam-micro-server" text="viam-micro-server" >}}`, but the configuration attributes available are different.
Data management is available for both `{{< glossary_tooltip term_id="viam-server" text="viam-server" >}}` and `{{< glossary_tooltip term_id="viam-micro-server" text="viam-micro-server" >}}`, but the configuration attributes are different.

docs/data-ai/capture-data/capture-sync.md
@@ -54,8 +55,6 @@ From your machine's **CONFIGURE** tab in the [Viam app](https://app.viam.com), a
On the panel that appears, configure data capture and sync attributes as applicable.
To both capture data and sync it to the cloud, keep both **Capturing** and **Syncing** switched on.

Click the **Save** button in the top right corner of the page to save your config.
Copy link
Collaborator

Choose a reason for hiding this comment

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

why?

docs/data-ai/capture-data/capture-sync.md
@@ -54,8 +55,6 @@ From your machine's **CONFIGURE** tab in the [Viam app](https://app.viam.com), a
On the panel that appears, configure data capture and sync attributes as applicable.
To both capture data and sync it to the cloud, keep both **Capturing** and **Syncing** switched on.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Could we integrate the save callout like this?

Suggested change
To both capture data and sync it to the cloud, keep both **Capturing** and **Syncing** switched on.
To both capture data and sync it to the cloud, keep both **Capturing** and **Syncing** switched on and **save**.

docs/data-ai/capture-data/capture-sync.md
@@ -697,11 +693,9 @@ If this is a test project, make sure you stop data capture to avoid charges for

In the **Data capture** section of your resource's configuration card, toggle the switch to **Off**.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
In the **Data capture** section of your resource's configuration card, toggle the switch to **Off**.
In the **Data capture** section of your resource's configuration card, toggle the switch to **Off** and **save**.

@sguequierre
Copy link
Contributor Author

closing as new pr is better

@sguequierre sguequierre closed this Feb 3, 2025
@sguequierre sguequierre deleted the DOCS-3423/more-feedback-jack-capture-sync branch February 3, 2025 15:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@npentrel npentrel npentrel left review comments

Assignees
No one assigned
Labels
safe to build This pull request is marked safe to build from a trusted zone
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@sguequierre @npentrel @viambot