Improve docs (a bit) #288
Improve docs (a bit) #288
Conversation
- We don't use ruby SASS or yuglify any more - Correct import commands - Link to install instructions in README
ghost
assigned This is renamed since pytest 3.4. See https://github.com/pytest-dev/pytest/blob/master/CHANGELOG.rst#pytest-340-2018-01-30
chris48s
force-pushed
the
improve_docs
branch
from
378a4a7
to
5aebc93
Compare
|
Note: the reason this PR didn't trigger a build first time was because we need to turn on "Build forked pull requests" in CircleCI. This seems to be off by default (I guess this is because there is an abuse vector here: on a paid plan, someone can just rinse all your build minutes by submitting loads of spurious PRs to your public repos). I've turned it on for all our other projects while I was there, but we'll need to remember to enable it if/when we migrate more projects. I'll have a look at the coveralls fail now. This is probably also a fix we'll need in lots of places.. |
chris48s
force-pushed
the
improve_docs
branch
from
04abc90
to
5aebc93
Compare
|
Hmm. As far as I can tell this should work. We've got |
|
As I'm fairly sure none of these changes are test breaking, should I merge this, or is it useful to keep here for testing circle CI? |
|
Aah yes I'd forgotten about this.
If you look at the build, you can see the "run tests" step passed. Its the "Update Coveralls" stage that is failing.
I'd quite like to figure this out if we're going to make wider use of Circle CI but I don't think there is anything special about this PR. I expect this will fail with any PR where the source branch is on a fork.. I'm just not sure what the fix is. All the posts I found about this problem said "set |
Having just followed through the process of setting this project up from scratch again, I've made a few corrections to the setup instructions.
More generally, it would be useful to refresh the readme a bit as it explains the project from the perspective of "We've just started this project - these are our ambitions for it" as opposed to "We've been running this project for several years - this is what it does" (spoiler: they're not exactly the same 😉 ), but that is a slightly different job.