Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Things to bear in mind:
About the documentation
README
,CONTRIBUTING.md
and in theWiki pages
to theasciidoctor
pages.README
with an introduction about Lazybones and the reference to the documentation and the contribution guidelines.About publishing the documentation
gh-pages
, that's why I've added thegh-pages plugin
. Once they are publish they should be available atpledbrook.github.io/lazybones
.ghPages
will be published executing the commandpublishGhPages
. It only requires to have a github api key stored in yourgradle.properties
accessible asgithub.token
templates.gradle
to add the condition of thepublushGhPages
. If you check the verification of the task type, I didn't use the class type because it turns out the task is createdon-the-fly
so I couln't do 'task instanceof SomeTypeTaskinstead I used
task.name == 'publishGhPages'`Problems I found:
I'm unable to pass integration tests. I have cloned a clean version of lazybones without any luck. When I checked the results of the tests it seems they are out-of-date because they're receiving different responses than the ones expected. I've never used
betamax
so maybe is something I haven't configured properly.Questions:
At the moment the
contribution guidelines
is saying any new feature should be documented in theREADME
. Should I change that kind of this now to point at the new documentation ? If so I would add a new commit to wrap all documentation changes from the original copied from theREADME
.Well, that's pretty much it. Don't worry if it takes you some time, I fully understand :)