Skip to content

Migrate docs to asciidoctor #177

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

mariogarcia
Copy link

Things to bear in mind:

About the documentation

  • I've copied everything in the README, CONTRIBUTING.md and in the Wiki pages to the asciidoctor pages.
  • I've kept the README with an introduction about Lazybones and the reference to the documentation and the contribution guidelines.

About publishing the documentation

  • Documentation is meant to be published as gh-pages, that's why I've added the gh-pages plugin. Once they are publish they should be available at pledbrook.github.io/lazybones.
  • ghPages will be published executing the command publishGhPages. It only requires to have a github api key stored in your gradle.properties accessible as github.token
  • I've modified the templates.gradle to add the condition of the publushGhPages. If you check the verification of the task type, I didn't use the class type because it turns out the task is created on-the-fly so I couln't do 'task instanceof SomeTypeTaskinstead I usedtask.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 the README. 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 the README.

Well, that's pretty much it. Don't worry if it takes you some time, I fully understand :)

Ultimately, be aware that the maintainers don't have much time to dedicate to
processing pull requests, so the less work they have to do the more likely and
quickly they can merge those pull requests in.

Copy link
Owner

Choose a reason for hiding this comment

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

For future reference, you shouldn't remove this file as GitHub links to it when someone submits a pull request. I'll try to resurrect it locally and push the changes.

@pledbrook
Copy link
Owner

Thanks for this contribution! It's very much appreciated. I'm currently trying to sync it with a new feature added with another pull request. Once I'm happy with the implementation of the new feature and the user guide, I'll push the changes.

@mariogarcia
Copy link
Author

I've just read this. I'll do the changes asap.

@mariogarcia mariogarcia force-pushed the migrate_docs_to_asciidoctor branch from b36525f to af2aeb5 Compare September 30, 2016 21:20
@mariogarcia mariogarcia force-pushed the migrate_docs_to_asciidoctor branch from eb58eb3 to 9dd088f Compare September 30, 2016 21:26
@mariogarcia
Copy link
Author

mariogarcia commented Sep 30, 2016

Ok, I've recovered CONTRIBUTING.md from the master branch I had, before creating this one.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants