Quick start proposal
ClosedPublic

Authored by lbrabec on Jul 2 2014, 8:55 AM.

Details

Summary

Just a quick start page proposal... (wip)

Test Plan

make docs

Diff Detail

Repository
rLTRN libtaskotron
Lint
Lint Skipped
Unit
Unit Tests Skipped
lbrabec retitled this revision from to Quick start proposal.Jul 2 2014, 8:55 AM
lbrabec updated this object.
lbrabec edited the test plan for this revision. (Show Details)
lbrabec added a reviewer: kparal.
lbrabec updated this revision to Diff 505.Jul 2 2014, 10:29 AM
  • small changes
tflink added a comment.Jul 2 2014, 1:31 PM

Overall, I like the idea. Just some wordmongering suggestions.

Also, I wonder if the "Recipes" section would read easier if it was broken up a bit:

Recipes: Examples From Our Git
==============================

Running Rpmlint
---------------

`Rpmlint task source <https://bitbucket.org/fedoraqa/task-rpmlint>`_

::

  git clone https://bitbucket.org/fedoraqa/task-rpmlint.git

::

  runtask -i gourmet-0.16.0-2.fc20 -t koji_build -a x86_64 task-rpmlint/rpmlint.yml


Other Examples
--------------

`Rpmbuild <https://bitbucket.org/fedoraqa/task-rpmbuild>`_
...
docs/source/quickstart.rst
14

I think that using "Detailed install instructions" or "Full install instructions" here would be more clear

32

Similar to above, using something like "Full instructions on running tasks" or "more details on running tasks" would be more clear than just "docs detail"

66

"Detailed instructions on writing tasks"?

roshi added a comment.Jul 2 2014, 5:39 PM

I like the idea a lot. All good projects have a "Quickstart." I concur with @tflink's comments - makes it a bit more straight-forward. Looking forward to the finished product.

lbrabec updated this revision to Diff 508.Jul 3 2014, 8:59 AM
  • more descriptive links
tflink accepted this revision.Jul 3 2014, 11:18 AM

Looks good to me

This revision is now accepted and ready to land.Jul 3 2014, 11:18 AM
lbrabec closed this revision.Jul 3 2014, 11:46 AM
lbrabec updated this revision to Diff 516.

Closed by commit rLTRNd36c9198fdae (authored by @lbrabec).