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

Use NERVES_TARGET when building examples #50

Closed
wants to merge 2 commits into from
Closed

Use NERVES_TARGET when building examples #50

wants to merge 2 commits into from

Conversation

pkazmier
Copy link
Contributor

@pkazmier pkazmier commented Sep 25, 2016

Small doc changes:

  1. Added a note about specifying the target via environment variable to example at the end of the page. This tripped me as a new user following along as I ended up building to the wrong target.
  2. Reduced the heading level of questions in the FAQ document to maintain better visual balance on the page while planning for future sections that can be used to group the questions as the document grows.

Added a note about specifying the target via environment variable to example at the end of the page.

This tripped me as a new user following along as I ended up building to the wrong target.
The questions are currently a level 1 heading, which is too large given the length of the questions. By changing these to level 3 headings, the visual balance of the page is improved.

By using level 3 headings for the questions, level 2 headings are available for use later to group questions once the FAQ becomes large enough. In addition, these future level 2 section headers will render in the navigation tree.
Copy link
Contributor

@GregMefford GregMefford 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 taking the time to improve the docs! 🚀

I just had one comment above. If you agree with my proposal, could you please update and squash it into your previous commit so that you still just have the two commits for the independent improvements?

```
$ git clone https://github.com/nerves-project/nerves-examples
$ cd nerves-examples/blinky
$ mix deps.get && mix firmware
$ NERVES_TARGET=rpi3 sh -c "mix deps.get && mix firmware"
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm concerned that this little "shell magic" might be intimidating to newcomers. As an alternative, how about NERVES_TARGET=rpi3 mix do deps.get, firmware. This has the additional benefit of introducing the existence of the mix do command, which people may not have encountered yet.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sure. I have not encountered the mix do either. I like that much better. Will resubmit tomorrow.

@GregMefford
Copy link
Contributor

Sorry for the big red X in your face! I was playing with the new GitHub Code Review feature and didn't realize the "request changes" option would look so harsh.

I think this change is mostly great and I don't mean to give you that gut reaction to your contribution being rejected. 🎈

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.

None yet

2 participants