From 7bbc4bb0b0007e1b85b39187a8249a50ef2ab887 Mon Sep 17 00:00:00 2001 From: Oliver Steele Date: Sun, 9 Jul 2017 19:20:26 -0400 Subject: [PATCH] Update docs to point to issues. --- .github/ISSUE_TEMPLATE.md | 6 +++--- CONTRIBUTING.md | 2 +- benchmarks.md | 6 +++--- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 4c3b5d2..6b4a0fd 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,8 +1,8 @@ ## Checklist -- [ ] I have searched the [issue list](https://github.com/osteele/gojekyll/issues). This issue is not listed. -- [ ] I have reviewed the [feature parity board](https://github.com/osteele/gojekyll/projects/1). This issue is not already represented by one of those notes. -- [ ] I have a reproducible test case. +- [ ] I have search the [issue list](https://github.com/osteele/gojekyll/issues) for my issue. +- [ ] I have verified the behavior with `jekyll`. +- [ ] I tried hard to create a reproducible test case. ## System information diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 92f79f0..8e1a0c8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,7 +3,7 @@ Here's some ways to help: * Try using gojekyll on your site. Use this as fodder for test cases. -* Choose an item to work on from one of the [project boards](https://github.com/osteele/gojekyll/projects). Convert it to an Issue and assign it to yourself, so we know you're working on it. +* Choose an item to work on from the [issues list](https://github.com/osteele/gojekyll/issues). * Search the sources for FIXME and TODO comments. * Improve the [code coverage](https://coveralls.io/github/osteele/gojekyll?branch=master). diff --git a/benchmarks.md b/benchmarks.md index 9ce0897..6e3e2bb 100644 --- a/benchmarks.md +++ b/benchmarks.md @@ -5,13 +5,13 @@ Disable the cache by setting the environment variable `GOJEKYLL_DISABLE_CACHE=1`. Disable threading by setting `GOMAXPROCS=1`. -SASS conversion and Pygments (`highlight`) are cached. +SASS conversion and Pygments (`{% highlight %}`) are cached. ## Jekyll Docs This site contains only one SASS file. -It contains a few instances of {% highlight %}. -This causes calls to Pygment, which dominate the un-cached times. +It contains a few instances of `{% highlight %}`. +Each of these results in a call to Pygment. This dominates the un-cached times. | Executable | Options | Time | |------------|-----------------------------|---------------|