Improving Shipkit documentation

[wwilk]

It would be good to start improving the documentation of new Shipkit features. Let's gather them here:

• [ ] Creating a short screencast with audio, presenting how to get started with Shipkit. Similar to the one that we presented on Confitura and JUGs.

• [ ] Copy-paste getting started guide from medium article to wiki page on GitHub

• [x] Writing an article (along with Wiki page) about VersionUpgrade functionality

• [x] Writing a doc for ReleaseNeededPlugin

• [x] Writing a doc for ComparePublicationsPlugin

• [ ] Writing a doc for GradlePortalPublishingPlugin

• [x] Detailed sequence diagram

@mockito/shipkit-developers Please add other things/ideas that need to be documented!

[mockitoguy]

Nice ticket, thank you!

An idea for screencast: https://github.com/mockito/shipkit-bootstrap/wiki/Shipkit-Test-Drive-in-4-steps

[StefMa]

I just want to list all "locations" of the current documentation:

• medium
• ShipKit bootstrap
• Getting-Started markdown

Yep. I think that is all 🙃

Whatever. I think we should define how and where to add the documentation. Because ShipKit is (or will be) a really big thing I recommend to split it up into two parts:

• A nice "getting started" (few lines of code) into the README. It should include really the basic setup so that ShipKit runs. E.g. you can init it. This section should also refer to...
• A GitHub-Page which includes the whole doc.

I would recommend to create the documentation based on markdown. Using jekyll for example...

[mockitoguy]

I would love Shipkit to have Medium blog-style page.