[Submit]Tiny code error in one tutorial

[seyoung]

Hei guys,

I was following "Using a standard USB webcam" - https://www.raspberrypi.org/documentati ... /README.md.

When editing crontab script:

Code: Select all

* * * * * /home/pi/webcam.sh 2>&1

should be

Code: Select all

* * * * * /home/pi/webcam/webcam.sh 2>&1

I didn't know where to submit this so I post it here.

Thanks.

[joan]

I think you are expected to fork the page on github, edit the page, and then submit the new page for approval.

To my mind a self defeating process as it's too much hassle (speaking for myself, that's why I never bother to point out mistakes).

[DirkS]

I think you are expected to fork the page on github, edit the page, and then submit the new page for approval.

Creating a pull request is optional. It's OK to just submit an issue for a problem.

[DirkS]

I didn't know where to submit this so I post it here.

Create an issue on the documentation Github page at https://github.com/raspberrypi/documentation

[ktb]

It doesn't necessarily seem to be a mistake/error. The instructions do not tell you whether to create the webcam.sh file in /home/pi/ or in /home/pi/webcam/. So you've assumed that you should have the webcam.sh file located in the webcam directory (I think I agree FWIW) and the author seems to assume that the webcam.sh script should be located in /home/pi/. The instructions could be more clear.

[DirkS]

It doesn't necessarily seem to be a mistake/error. The instructions do not tell you whether to create the webcam.sh file in /home/pi/ or in /home/pi/webcam/.

BASH SCRIPT

You can write a Bash script which takes a picture with the webcam. The script below saves the images in the /home/pi/webcam directory, so create the webcam subdirectory first with:

mkdir webcam
To create a script, open up your editor of choice and write the following example code:

I would say that's actually *does* tell you to create it in the subdir.
They should have added a 'cd webcam' command though.

[joan]

I think you are expected to fork the page on github, edit the page, and then submit the new page for approval.

Creating a pull request is optional. It's OK to just submit an issue for a problem.

That's much easier, but it still requires users to be familiar with github. Perhaps the View/Edit this page on GitHub button could be replaced to a link to the issues button. However don't you still need a github account? These are all barriers.

[ktb]

It doesn't necessarily seem to be a mistake/error. The instructions do not tell you whether to create the webcam.sh file in /home/pi/ or in /home/pi/webcam/.

BASH SCRIPT

You can write a Bash script which takes a picture with the webcam. The script below saves the images in the /home/pi/webcam directory, so create the webcam subdirectory first with:

mkdir webcam
To create a script, open up your editor of choice and write the following example code:

I would say that's actually *does* tell you to create it in the subdir.
They should have added a 'cd webcam' command though.

Well, then I suppose you have a more creative mind than I do.

[DirkS]

Well, then I suppose you have a more creative mind than I do.

Reading the instructions again, I think you're right. It's just the images that go in the subdir, not the script.

[seyoung]

Oh, that's right. the webcam.sh is supposed to be above the dir webcam.
Sorry guys

[DougieLawson]

If the documentation isn't 100% clear then open an issue (or an issue and a pull request) to save someone else from the same confusion you've found. The RPF can always close the issue if they think it doesn't need a re-write.