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-4647: Improve python docs on how to add local module to config #415

Merged
merged 2 commits into from
Sep 5, 2023

Conversation

hexbabe
Copy link
Member

@hexbabe hexbabe commented Aug 31, 2023

RSDK-4647

Added note linking to docs for adding to registry

Added sentence clarifying the relationship of the config type, model, name to the component class' type, model, name

@hexbabe hexbabe requested a review from a team as a code owner August 31, 2023 17:24
@hexbabe hexbabe requested review from njooma and cheukt August 31, 2023 17:24
@CLAassistant
Copy link

CLAassistant commented Aug 31, 2023

CLA assistant check
All committers have signed the CLA.

@cheukt cheukt removed the request for review from njooma September 5, 2023 15:22
@cheukt
Copy link
Member

cheukt commented Sep 5, 2023

cc @Fahmina

@hexbabe hexbabe marked this pull request as draft September 5, 2023 16:30
@hexbabe hexbabe marked this pull request as ready for review September 5, 2023 16:31
@hexbabe hexbabe force-pushed the RSDK-4647 branch 2 times, most recently from eb2e404 to 20a7c67 Compare September 5, 2023 16:43
Copy link
Member

@cheukt cheukt left a comment

Choose a reason for hiding this comment

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

Can you update the readme in complex_module and simple_module to also include The aforementioned `type`, `model`, and `name` should be the same as those in the `MODEL` class attribute defined in your custom class.

@@ -481,11 +481,11 @@
"metadata": {},
"source": [
"### 5. Configure a modular resource\n",
"**NOTE:** *These instructions are for local development. Soon we will launch a `Registry` which will allow users to upload modules to app.viam.com directly. We will update the documentation with instructions on how to do that shortly.*\n",
"**NOTE:** *These instructions are for local development. If you are adding your module to the registry, follow [these instructions](https://docs.viam.com/extend/modular-resources/configure/) instead. Otherwise, continue with these instructions, which will show you how to configure the module locally.*\n",
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
"**NOTE:** *These instructions are for local development. If you are adding your module to the registry, follow [these instructions](https://docs.viam.com/extend/modular-resources/configure/) instead. Otherwise, continue with these instructions, which will show you how to configure the module locally.*\n",
"**NOTE:** *If you are adding your module to the registry, follow [these instructions](https://docs.viam.com/extend/modular-resources/configure/) instead. Otherwise, continue with these instructions, which will show you how to configure the module locally.*\n",

@hexbabe hexbabe merged commit 715e587 into viamrobotics:main Sep 5, 2023
5 checks passed
@hexbabe hexbabe deleted the RSDK-4647 branch September 5, 2023 19:27
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.

3 participants