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

[RSDK-8760] - README improvements #21

Merged
merged 15 commits into from
Oct 8, 2024
Merged

[RSDK-8760] - README improvements #21

merged 15 commits into from
Oct 8, 2024

Conversation

seanavery
Copy link
Collaborator

@seanavery seanavery commented Oct 7, 2024

Description

Depending on testing from PR #20

  • Makes module public
  • Improvements to README

@seanavery seanavery changed the title [RSDK-8760] - Release [RSDK-8760] - Release 0.0.1 Oct 7, 2024
@seanavery seanavery requested review from randhid and hexbabe and removed request for randhid October 7, 2024 21:06
Copy link

@randhid randhid left a comment

Choose a reason for hiding this comment

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

One little nit, but otherwise lgtm

README.md Show resolved Hide resolved
Copy link
Collaborator

@hexbabe hexbabe left a comment

Choose a reason for hiding this comment

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

I don't see it on the registry yet? Should we run viam module update after merge? Also should we get someone from docs team to look at the README updates?

@seanavery
Copy link
Collaborator Author

I don't see it on the registry yet?

Cutting release once this PR is in.

Also should we get someone from docs team to look at the README updates?

Probably a good idea!

@seanavery seanavery changed the title [RSDK-8760] - Release 0.0.1 [RSDK-8760] - README improvements Oct 8, 2024
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated
]
}
```

Make sure to configure a [Data Manager Service](https://docs.viam.com/services/data/cloud-sync/) to uplaod video files to the cloud.
### Configure a Data Manager Service
Copy link
Contributor

Choose a reason for hiding this comment

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

Would suggest moving this up to above configure a video-store section in a section called ## Requirements and also adding the instructions to configure through the UI:

Navigate to the [**CONFIGURE** tab](https://docs.viam.com/configure/) of your [machine](https://docs.viam.com/fleet/machines/) in [the Viam app](https://app.viam.com/). [Add data-management to your machine](https://docs.viam.com/configure/#services).

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Added requirements section.

README.md Outdated Show resolved Hide resolved
seanavery and others added 5 commits October 8, 2024 12:33
Co-authored-by: Sierra Guequierre <sguequierre@gmail.com>
Co-authored-by: Sierra Guequierre <sguequierre@gmail.com>
Co-authored-by: Sierra Guequierre <sguequierre@gmail.com>
Co-authored-by: Sierra Guequierre <sguequierre@gmail.com>
@seanavery seanavery merged commit 7462a3d into main Oct 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants