The summary of this issue doesn't quite explain the problem. There are a number of issues with the examples guides and tutorials, and this issue I am using to record and capture them, in attempt to figure out how to fix the problems:
- The examples, guides and tutorials are scattered and duplicated.
is a duplication of
(This example has been moved in the "new" version of the docs, but the duplication remains.)
- The documentation at
https://github.com/caskdata/cdap-apps/tree/develop/Wise (a README.rst)
is not the same as
when they should be identical. Ideally, "tutorial2" should be generated from the README.rst...
- Of the four tutorials, only the first (Wise) is written as a tutorial; the others are just the github page with instructions. These should be made the same, especially since the github page takes you to the develop branch, which might not be appropriate for a particular CDAP release.
- There is an additional "basic" tutorial1 (see above); however, to claim it takes two hours is laughable. We should probably remove it and replace it with the others as tutorials.
- One thought is to have the Application Repo have READMEs that give basic building and running instructions, and for each App there be a separate tutorial that pulls these in and extends them.
These suggestions are not final, in that as I work on this I will probably come up with other ideas and suggestions.