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

Add networking tutorial #167

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add networking tutorial #167

wants to merge 1 commit into from

Conversation

atharva-18
Copy link
Contributor

Summary

This PR adds a wiki entry describing a networking setup for use in robotics projects.

Copy link
Collaborator

@nevalsar nevalsar left a comment

Choose a reason for hiding this comment

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

Thank you for sending in the PR! I have some broad comments about the content being added.

  • The page is essentially a link to a YouTube video for a specific network configuration (namely, projects running in CMU RI). Some alternatives that would better suit the audience and content of this wiki are:
    • A plaintext write-up of the video content, which makes it straightforward to keep the guide up to date without having to redo the entire video / maintaining a coupled errata.
    • A compilation of resources (video or otherwise) that cover a range of networking setups encountered in robotics projects.
  • The included description for the video is very open ended and does not quite illustrate what to expect at the linked resource - the description does not specify the kind of platform, network infrastructure or the expected outcome which this resource helps achieve. A helpful description can be something like: “Video tutorial for configuring static IP on a Linux machine for remote login and monitoring”, or "network configuration for real-time image processing over a congested network".
  • Keep in mind that this wiki is intended for a larger audience not restricted to CMU RI. It would be much better to keep the instructions general, with any CMU-specific configuration called out separately.

Disclaimer: I did not go through the full content of the video (it's quite long) but that serves to illustrate my point about videos being hard to maintain, update or even skim through.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants