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-4648: Document namespace nomenclature better #417

Merged
merged 11 commits into from
Sep 13, 2023

Conversation

hexbabe
Copy link
Member

@hexbabe hexbabe commented Aug 31, 2023

RSDK-4648

  • Change instances of acme and other non-standardized models to conform to new conventions
  • Add note about naming rules
  • Change link to docs to actual link to docs once @andf-viam's custom namespaces docs are live
  • Add naming convention sentence to simple and complex examples

@CLAassistant
Copy link

CLAassistant commented Aug 31, 2023

CLA assistant check
All committers have signed the CLA.

@hexbabe hexbabe marked this pull request as ready for review September 5, 2023 16:40
@hexbabe hexbabe requested a review from a team as a code owner September 5, 2023 16:40
@hexbabe hexbabe marked this pull request as draft September 5, 2023 16:41
@hexbabe hexbabe force-pushed the RSDK-4648 branch 5 times, most recently from 41cb777 to 0791bcb Compare September 5, 2023 16:47
hexbabe added 2 commits September 5, 2023 12:49
… to link to Andrew's updated docs about custom namespaces once that is up
@hexbabe hexbabe marked this pull request as ready for review September 5, 2023 18:21
@hexbabe
Copy link
Member Author

hexbabe commented Sep 5, 2023

Should I make the changes to simple and complex module on this PR instead? @cheukt

@cheukt
Copy link
Member

cheukt commented Sep 5, 2023

ya, let's make them here

@hexbabe
Copy link
Member Author

hexbabe commented Sep 6, 2023

ya, let's make them here

ok i did it

examples/complex_module/README.md Show resolved Hide resolved
docs/examples/example.ipynb Show resolved Hide resolved
Copy link
Contributor

@andf-viam andf-viam left a comment

Choose a reason for hiding this comment

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

We updated a few docs headers for the soft launch, I've commented the updated link targets.

docs/examples/example.ipynb Show resolved Hide resolved
examples/complex_module/README.md Outdated Show resolved Hide resolved
examples/complex_module/README.md Outdated Show resolved Hide resolved
examples/simple_module/README.md Outdated Show resolved Hide resolved
hexbabe added 2 commits September 8, 2023 13:14
…viam' namespace gizmo and service back to 'acme' because i dont think we have gizmo and summation service...; changed simple module code to be same as readme
@@ -103,7 +103,7 @@ An example configuration for an Arm component, a Gizmo component, and a Summatio
"name": "mysum1",
"type": "summation",
"namespace": "acme",
"model": "viam:sum:mysum",
"model": "acme:demo:mysum",
Copy link
Member Author

@hexbabe hexbabe Sep 11, 2023

Choose a reason for hiding this comment

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

I changed this back to acme because I did not see a sum or summation as a Viam-supported component as per the RDK repo

@@ -54,7 +54,7 @@ An example configuration for an Arm component, a Gizmo component, and a Summatio
"name": "gizmo1",
"type": "gizmo",
"namespace": "acme",
"model": "viam:gizmo:mygizmo",
"model": "acme:demo:mygizmo",
Copy link
Member Author

@hexbabe hexbabe Sep 11, 2023

Choose a reason for hiding this comment

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

I changed this back to acme because I did not see a gizmo as a Viam-supported component as per the RDK repo

@hexbabe hexbabe requested a review from cheukt September 11, 2023 15:05
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.

one more small change, but looks pretty good to me

docs/examples/example.ipynb Show resolved Hide resolved
docs/examples/example.ipynb Show resolved Hide resolved
Copy link
Contributor

@Fahmina Fahmina left a comment

Choose a reason for hiding this comment

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

LGTM!

@hexbabe hexbabe requested a review from cheukt September 13, 2023 16:32
@hexbabe hexbabe merged commit 5f494d5 into viamrobotics:main Sep 13, 2023
5 checks passed
@hexbabe hexbabe deleted the RSDK-4648 branch September 27, 2023 17: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.

5 participants