Differential D174

Quick start proposal
ClosedPublic
Actions

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

Details

Reviewers
kparal
roshi
tflink
Maniphest Tasks
T239: Verify Documentation and User-Friendly Defaults for libtaskotron
Commits
rLTRNd36c9198fdae: Quick start in docs
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).

Revision Contents

PathPackages
Mdocs/source/index.rst (1 line)
AMdocs/source/quickstart.rst (94 lines)

Diff 516

View Options

docs/source/index.rst

Show All 17 Lines
18the interfaces. 18​the interfaces.
19 19​
20Contents 20​Contents
21-------- 21​--------
22 22​
23.. toctree:: 23​.. toctree::
24 :maxdepth: 1 24​ :maxdepth: 1
25 25​
26​ quickstart
26 writingtasks 27​ writingtasks
27 taskyaml 28​ taskyaml
28 library 29​ library
29 devguide 30​ devguide
30 directives/list_of_directives_modules 31​ directives/list_of_directives_modules
31 32​
32 33​
33 34​
▲ Show 20 Lines • Show All 87 Lines • Show Last 20 Lines
View Options

docs/source/quickstart.rst

  • This file was added.
1​=====================
2​Taskotron Quick Start
3​=====================
4​
5​
6​Add repo
7​========
8​
9​::
10​
11​ sudo wget http://copr-fe.cloud.fedoraproject.org/coprs/tflink/taskotron/repo/fedora-20-i386/tflink-taskotron-fedora-20-i386.repo -O /etc/yum.repos.d/tflink-taskotron-fedora-20-i386.repo
12​
13​
14​Install
tflinkUnsubmitted
Not Done

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

15​=======
16​
17​::
18​
19​ sudo yum install libtaskotron
20​
21​`Detailed install instructions <index.html#install-libtaskotron>`_
22​
23​
24​Run
25​===
26​
27​::
28​
29​ runtask -i <item> -t <type> -a <arch> <yaml recipe>
30​
31​`More details on running tasks <index.html#running-tasks>`_
32​
tflinkUnsubmitted
Not Done

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"

33​
34​Recipes: General Syntax
35​=======================
36​
37​.. code-block:: yaml
38​
39​ name: name of recipe
40​ desc: slow cooked beef short ribs
41​ maintainer: chef
42​
43​ input:
44​ args:
45​ - arg1 # supported args:
46​ - arg2 # arch, koji_build, bodhi_id, koji_tag
47​
48​ environment:
49​ rpm:
50​ - dependency1 # not checked in current version
51​ - dependency2 # only for human reference
52​
53​ task:
54​ - name: preheat the oven
55​ directivename: # e.g. koji, bodhi, python, ...
56​ arg1: value1
57​ arg2: ${some_variable} # e.g. input arg
58​ export: firststep_output # export usable as input arg of next directive
59​
60​ - name: next step of recipe
61​ nextdirectivename:
62​ arg1: ${firststep_output}
63​
64​`Detailed instructions on writing tasks <writingtasks.html#creating-a-new-task>`_
65​
66​
tflinkUnsubmitted
Not Done

"Detailed instructions on writing tasks"?

67​Recipes: Examples From Our Git
68​==============================
69​
70​Running Rpmlint
71​---------------
72​
73​`Rpmlint <https://bitbucket.org/fedoraqa/task-rpmlint>`_
74​
75​::
76​
77​ git clone https://bitbucket.org/fedoraqa/task-rpmlint.git
78​
79​::
80​
81​ runtask -i gourmet-0.16.0-2.fc20 -t koji_build -a x86_64 task-rpmlint/rpmlint.yml
82​
83​
84​Other Examples
85​--------------
86​
87​
88​`Rpmbuild <https://bitbucket.org/fedoraqa/task-rpmbuild>`_
89​
90​`Example bodhi <https://bitbucket.org/fedoraqa/task-examplebodhi>`_
91​
92​`Example reporting <https://bitbucket.org/fedoraqa/task-example_reporting>`_
93​
94​Check `our git <https://bitbucket.org/fedoraqa>`_ for more.