Go Down

Topic: where to submit website/documentation change requests? (Read 264 times) previous topic - next topic


pert

If the request is for one of the Arduino language reference pages you can submit a pull request or issue report here:
https://github.com/arduino/reference-en
That's for the English language version. There are separate repositories for each of the translated languages.

For other website pages (such as that tutorial) you can submit an issue report here:
https://github.com/arduino/Arduino/issues

Before submitting an issue report or pull request please do a search for previously submitted issues or pull requests, both closed and open to make sure it hasn't already been done.

If you don't have a GitHub account or want to discuss your proposed changes first then feel free to post here on the forum. I'm always happy to relay issues I can verify over to GitHub.

Thanks for your interest in contributing to the Arduino documentation!

yaxy

As a search for "interger" failed at /issues, issue submitted.

Totally unfamiliar with GitHub. If I understand the verb "pull" correctly, what good is it to retrieve (pull down) a local copy of a document/page/source code in order to change/correct it? At some point, doesn't a "push" request need to be made and approved so it's updated for the rest of the world to see?

Thanks for the help.

pert

The "pull" in "pull request" is relative to the maintainer of the parent repository. So you do this:
  • Fork repository
  • Commit fix to your fork
  • Send a request for the maintainer of the parent repository to pull your commit from your fork into their repository.

You likely don't have permissions to push to the parent repository so you send them a request. The operation from their point of view is a pull, not a push.

GitHub is really awesome. It makes it so easy to collaborate on open source projects. Unfortunately the source of the tutorial web pages is not available in a repository so that's kind of clunky to have to submit an issue report instead of a pull request but they recently got all the Arduino Language Reference pages set up so that we can submit pull requests for fixes or improvements and it's really cool. They even have an "Edit" link on every reference page. They plan to do the same with all the Arduino library reference pages and some of the other web content eventually.

Git has a fairly steep learning curve but luckily GitHub's web interface lets you do the more basic operations very easily. Once you've done that for a while and find you need to do something more complex that the web interface doesn't allow it's a pretty smooth transition to working with local repositories, ether via Git command line or a Git client GUI, and then pushing your work to GitHub.

Go Up