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 new validator tools subfolder and doc for building a command-line validator on Mac OS X #1554

Merged
merged 1 commit into from
Jan 25, 2016
Merged

Conversation

pietergreyling
Copy link
Contributor

Add new validator tools subfolder and doc for how to build the official AMP-HTML command-line AMP validator on Mac OS X.

@googlebot
Copy link

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed, please reply here (e.g. I signed it!) and we'll verify. Thanks.


  • If you've already signed a CLA, it's possible we don't have your GitHub username or you're using a different email address. Check your existing CLA data and verify that your email is set on your git commits.
  • If you signed the CLA as a corporation, please let us know the company's name.

@pietergreyling
Copy link
Contributor Author

I signed it
On Jan 25, 2016 01:03, "googlebot" notifications@github.com wrote:

Thanks for your pull request. It looks like this may be your first
contribution to a Google open source project. Before we can look at your
pull request, you'll need to sign a Contributor License Agreement (CLA).

[image: 📝] Please visit https://cla.developers.google.com/
https://cla.developers.google.com/ to sign.

Once you've signed, please reply here (e.g. I signed it!) and we'll

verify. Thanks.


Reply to this email directly or view it on GitHub
#1554 (comment).


```
$ brew install node
$ sudo npm install -g lodash
Copy link
Member

Choose a reason for hiding this comment

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

You can probably avoid the -g here. If you have a package.json local installation should work.

@cramforce
Copy link
Member

Could you also update and point to your new doc in https://github.com/ampproject/amphtml/blob/master/validator/README.md

@powdercloud
Copy link
Contributor

Would it make sense to call this new directory docs instead of tools?
I have a hunch we'll want to add some more docs (e.g. about versioning), so it'd be a good precedent.

@pietergreyling
Copy link
Contributor Author

Done:
renamed validator/{tools => docs}/building_a_command_line_amp_validator_for_mac_os_x.md
repointed: validator/README.md to refer to docs/..

$ brew install node
```

### Edit /etc/hosts
Copy link
Contributor

Choose a reason for hiding this comment

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

I'd like to drop this section since it's not needed for the validator. We have a DEVELOPMENT.md with these instructions instead.

@powdercloud
Copy link
Contributor

Sweet, thank you! I think this is good to go, except I see very many commits in this PR. Would you mind squashing these so the overall change history for the project is easier to read? You may already know how to do this, but in case not, this doc has helped me in the past:
https://github.com/ginatrapani/todo.txt-android/wiki/Squash-All-Commits-Related-to-a-Single-Issue-into-a-Single-Commit

@pietergreyling
Copy link
Contributor Author

Squash done as follows (although authentication for terminal git push fails - 2 factor auth maybe?):

commit 63bedbb679e6ef6659bae5595a4d58d2a44df5b5
Author: Pieter Greyling pieter.greyling@gmail.com
Date: Mon Jan 25 00:43:28 2016 +0000

Created new docs folder.
Created building_a_command_line_amp_validator_for_mac_os_x.md.
Changed validator/build.py to allow experimental validator builds for Mac OS X systems.

@pietergreyling
Copy link
Contributor Author

Forced push using 2F token over https:
To https://github.com/pietergreyling/amphtml.git

  • 4ce49f1...0eba1d5 greyling-tools -> greyling-tools (forced update)

@powdercloud
Copy link
Contributor

Hmm, I wonder whether something went wrong. Now I see a bunch of different files in there (https://github.com/ampproject/amphtml/pull/1554/files - 9 total). :-(

@pietergreyling
Copy link
Contributor Author

Yep, only the last 3 are mine:
validator/docs/building_a_command_line_amp_validator_for_mac_os_x.md
validator/build.py
validator/README.md

@powdercloud
Copy link
Contributor

Thank you! @jridgewell I think the comment about the /etc/hosts makes sense but a link to the development.md can go in as a follow up as well, so I think this one is fine as is.

powdercloud added a commit that referenced this pull request Jan 25, 2016
Add new validator tools subfolder and doc for building a command-line validator on Mac OS X
@powdercloud powdercloud merged commit cf339bb into ampproject:master Jan 25, 2016
@pietergreyling pietergreyling deleted the greyling-tools branch January 26, 2016 08:26
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.

6 participants