diff --git a/.gitignore b/.gitignore index 7334d6c..50cb7c3 100644 --- a/.gitignore +++ b/.gitignore @@ -3,3 +3,5 @@ deploy_key deploy_key.pub encoding.html UnicodeData.txt +deploy.sh +review.sh diff --git a/Makefile b/Makefile index 863a151..3704157 100644 --- a/Makefile +++ b/Makefile @@ -1,8 +1,11 @@ -local: encoding.bs - bikeshed spec encoding.bs encoding.html --md-Text-Macro="SNAPSHOT-LINK LOCAL COPY" - remote: encoding.bs curl https://api.csswg.org/bikeshed/ -f -F file=@encoding.bs > encoding.html -F md-Text-Macro="SNAPSHOT-LINK LOCAL COPY" +local: encoding.bs + bikeshed spec encoding.bs encoding.html --md-Text-Macro="SNAPSHOT-LINK LOCAL COPY" + deploy: encoding.bs curl --remote-name --fail https://resources.whatwg.org/build/deploy.sh && bash ./deploy.sh + +review: encoding.bs + curl --remote-name --fail https://resources.whatwg.org/build/review.sh && bash ./review.sh diff --git a/README.md b/README.md index 1d52b06..ae58da7 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ This repository hosts the [Encoding Standard](https://encoding.spec.whatwg.org/) ### Code of conduct -We are committed to providing a friendly, safe and welcoming environment for all. Please read and +We are committed to providing a friendly, safe, and welcoming environment for all. Please read and respect the [WHATWG Code of Conduct](https://whatwg.org/code-of-conduct). ### Contribution opportunities @@ -11,7 +11,7 @@ We'd love your help fixing the minor and larger issues with the Encoding Standar typographical and grammar errors are also most welcome. We'd be happy to mentor you through this process. If you're interested and need help getting -started, leave a comment on the issue or ask around [on IRC](https://wiki.whatwg.org/wiki/IRC). +started, leave a comment on the issue or ask around [on IRC](https://whatwg.org/irc). ### Pull requests @@ -22,12 +22,11 @@ reading through the [WHATWG FAQ](https://whatwg.org/faq) if you are new here. Please add your name to the Acknowledgments section in your first pull request, even for trivial fixes. The names are sorted lexicographically. -If you want to preview the spec locally, you can either use a locally installed copy of -[Bikeshed](https://github.com/tabatkins/bikeshed) by running `make` or use the HTTP API version by -running `make remote`. +### Building "locally" -If you want to do a complete "local deploy" including commit and/or branch snapshots, run -`make deploy`. +For quick local iteration, run `make`. To verify your changes locally, run `make deploy`. See more +in the +[WHATWG Contributor Guidelines](https://github.com/whatwg/meta/blob/master/CONTRIBUTING.md#building). ### Merge policy @@ -37,4 +36,4 @@ If you can commit to this repository, see the ### Tests Tests can be found in the `encoding/` directory of -[web-platform-tests](https://github.com/w3c/web-platform-tests). +[web-platform-tests/wpt](https://github.com/web-platform-tests/wpt).