Docs and readme fixes
ClosedPublic
Actions

Authored by viorel on Jul 20 2016, 4:26 AM.

Details

Reviewers

kparal
tflink
jskladan

Commits

rLTRNab6af3121d89: docs: simplify installation instructions

Summary

Small changes while reviewing libtaskotron install guide as discussed with
@tflink. Typo fix in /var/tmp/taskotron

Test Plan

Build the docs:

cd docs
make html

Then view local static content.

Diff Detail

Repository

rLTRN libtaskotron

Lint

Automatic diff as part of commit; lint not applicable.

Unit

Automatic diff as part of commit; unit tests not applicable.

viorel retitled this revision from to Docs and readme fixes.Jul 20 2016, 4:26 AM

viorel updated this object.

viorel edited the test plan for this revision. (Show Details)

viorel added a reviewer: tflink.

viorel added a subscriber: tflink.

Looks good, thank you!

This revision is now accepted and ready to land.Jul 20 2016, 5:27 AM

Thanks for helping with this! I'd remove the updates-testing section, but apart from that, it looks good.

docs/source/quickstart.rst
5–6	Why should we recommend people to enable `updates-testing` by default? We can mention that there can be something in `updates-testing`, sure, but I wouldn't do that as part of the initial instructions. It can be a note somewhere. But by default, we should recommend stable versions, and if people want unstable ones, they can always check out libtaskotron from git (which is described elsewhere).
13–15	I'd move this paragraph above the command, I think it's a more natural reading flow.
readme.rst
91	Nice catch!

Moved installation text before command as suggested by @kparal in comment 21-23

docs/source/quickstart.rst
5–6	I see the point in not leaving `updates-testing` enabled by default so perhaps `--enablerepo=updates-testing` would be more appropriate? As to pointing the user to testing repo, previous documentation referenced Copr since that's where the package was, now it's in testing. We can (and should) update the docs as soon as the RPM lands in stable?

docs/source/quickstart.rst
13–16	It looks like marking it as "Done" doesn't record the actual lines. So here it is "done" commit c0d3db218343

docs/source/quickstart.rst
5–6	Package stay in updates-testing just for a short time. As a matter of fact, libtaskotron is already in stable repos today :-) So people don't need to enable any repos, just install.

This revision now requires changes to proceed.Jul 21 2016, 7:43 AM

Moved installation text before command as suggested by @kparal in
As suggested by @kparal: install from stable repo

docs/source/quickstart.rst
5–6	Yes indeed, here's commit c5fd73780a46 to celebrate!

Closed by commit rLTRNab6af3121d89: docs: simplify installation instructions (authored by viorel, committed by kparal). · Explain WhyJul 22 2016, 8:44 AM

This revision was automatically updated to reflect the committed changes.

Looks great. Pushed. Thanks a lot for submitting the diff.

Revision Contents

			Path	Packages
M			docs/source/index.rst (23 lines)
M			docs/source/quickstart.rst (27 lines)
M			readme.rst (2 lines)

Diff	ID	Base	Description	Created	Lint	Unit
Base			Base
Diff 1	2392	d228b62		Jul 20 2016, 4:25 AM	★	★
Diff 2	2396	d228b62	- Moved installation text before command as suggested by @kparal in comment	Jul 21 2016, 5:44 AM	★	★
Diff 3	2398	d228b62	- Moved installation text before command as suggested by @kparal in	Jul 21 2016, 1:34 PM	★	★
Diff 4	2407	c63b7fc	rLTRNab6af3121d892c185dd3ddcb13d86eeddbe6c21a	Jul 22 2016, 8:43 AM	★	★

Commit	Tree	Parents	Author	Summary	Date
c5fd73780a46	8f4e8fb24c9f	c0d3db218343	Viorel Tabara	- As suggested by @kparal: install from stable repo	Jul 21 2016, 1:28 PM
c0d3db218343	efcd7ddb5efe	da670de33675	Viorel Tabara	- Moved installation text before command as suggested by @kparal in D943:23-21	Jul 21 2016, 5:41 AM
da670de33675	ce5c2bcc9c47	06089c8247e1	Viorel Tabara	Docs and readme fixes (Show More…)	Jul 20 2016, 4:22 AM
06089c8247e1	7dedcf4d7d2a	d228b620f491	Viorel Tabara	- Updated repo location and instructions to reflect that libtaskotron is now in… (Show More…)	Jul 20 2016, 3:33 AM

Diff 2407

View Options

docs/source/index.rst

Show First 20 Lines • Show All 59 Lines • ▼ Show 20 Line(s)
60		60
61	A Taskotron task is made up of :ref:`taskotron-directives` which control what	61	A Taskotron task is made up of :ref:`taskotron-directives` which control what
62	can be done in a task. See the list of available :ref:`taskotron-directives`	62	can be done in a task. See the list of available :ref:`taskotron-directives`
63	to learn more about what is currently available.	63	to learn more about what is currently available.
64		64
65		65
66	.. _install-libtaskotron:	66	.. _install-libtaskotron:
67		67
68	Install Libtaskotron	68	Installing libtaskotron
69	====================	69	=======================
70		70
71	In order to run any tasks locally, libtaskotron must first be installed. While	71	Refer to :doc:`quickstart` guide.
72	not currently in the main Fedora repositories, it is available in a side repo
73	which is updated as new versions are released. To enable this repo::
74		72
75	sudo curl https://copr.fedorainfracloud.org/coprs/tflink/taskotron/repo/fedora-23/tflink-taskotron-fedora-23.repo \
76	-o /etc/yum.repos.d/tflink-taskotron-fedora-23.repo
77
78	.. TODO - replace this link with a non-copr repo that's more stable over time
79
80	The easiest way to get started is to install ``libtaskotron-core`` and all of the
81	other modules with::
82
83	sudo dnf -y install libtaskotron
84
85	Since the ``runtask`` command writes into system-wide locations on the filesystem,
86	any user who runs it will need to be added to the ``taskotron`` group with the command::
87
88	sudo usermod -aG taskotron <user>
89		73
		74	.. _libtaskotron-modules:
90		75
91	libtaskotron modules	76	libtaskotron modules
92	--------------------	77	--------------------
93		78
94	As functionality has been added to libtaskotron, we've started breaking up that	79	As functionality has been added to libtaskotron, we've started breaking up that
95	functionality into modules to increase flexibility and shrink the minimal	80	functionality into modules to increase flexibility and shrink the minimal
96	install profile. Each module is packaged separately for easy installation.	81	install profile. Each module is packaged separately for easy installation.
97		82
▲ Show 20 Lines • Show All 78 Lines • Show Last 20 Lines

View Options

docs/source/quickstart.rst

1	=====================	1		=====================
2	Taskotron Quick Start	2		Taskotron Quick Start
3	=====================	3		=====================
4		4
5		5
6	Add repo
7	========
8
9	::
10
11	sudo curl https://copr.fedorainfracloud.org/coprs/tflink/taskotron/repo/fedora-23/tflink-taskotron-fedora-23.repo \
12	-o /etc/yum.repos.d/tflink-taskotron-fedora-23.repo
13
14
15	Install	6		Install
			kparalUnsubmitted Not Done Why should we recommend people to enable `updates-testing` by default? We can mention that there can be something in `updates-testing`, sure, but I wouldn't do that as part of the initial instructions. It can be a note somewhere. But by default, we should recommend stable versions, and if people want unstable ones, they can always check out libtaskotron from git (which is described elsewhere).
			viorelAuthorUnsubmitted Not Done I see the point in not leaving `updates-testing` enabled by default so perhaps `--enablerepo=updates-testing` would be more appropriate? As to pointing the user to testing repo, previous documentation referenced Copr since that's where the package was, now it's in testing. We can (and should) update the docs as soon as the RPM lands in stable?
			kparalUnsubmitted Not Done Package stay in updates-testing just for a short time. As a matter of fact, libtaskotron is already in stable repos today :-) So people don't need to enable any repos, just install.
			viorelAuthorUnsubmitted Not Done Yes indeed, here's commit c5fd73780a46 to celebrate!
16	=======	7		=======
17		8
18	::	9		Install ``libtaskotron-core`` and all of its modules::
19		10
20	sudo dnf -y install libtaskotron	11		sudo dnf -y install libtaskotron
21		12
22	This will install libtaskotron-core and all of its modules, see `detailed	13		See :ref:`libtaskotron-modules` for more information on installing individual
23	install instructions <index.html#install-libtaskotron>`_ for more information	14		modules.
24	on installing individual modules.
25		15
			kparalUnsubmitted Done I'd move this paragraph above the command, I think it's a more natural reading flow.
26	Since the ``runtask`` command writes into system-wide locations on the filesystem,	16		Since the ``runtask`` command writes into system-wide locations on the
			viorelAuthorUnsubmitted Not Done It looks like marking it as "Done" doesn't record the actual lines. So here it is "done" commit c0d3db218343
27	any user who runs it will need to be added to the ``taskotron`` group with the command::	17		filesystem, any user who runs it will need to be added to the ``taskotron``
		18		group with the command::
28		19
29	sudo usermod -aG taskotron <user>	20		sudo usermod -aG taskotron <user>
30		21
		22		.. Note::
		23		The user must log out and back in in order for the new group assignment to
		24		take effect.
		25
31		26
32	Run	27		Run
33	===	28		===
34		29
35	::	30		::
36		31
37	runtask -i <item> -t <type> -a <arch> <yaml formula>	32		runtask -i <item> -t <type> -a <arch> <yaml formula>
38		33
▲ Show 20 Lines • Show All 67 Lines • Show Last 20 Lines

View Options

readme.rst

Show First 20 Lines • Show All 82 Lines • ▼ Show 20 Line(s)
83	directories. First, create a ``taskotron`` group if you don't have it already,	83		directories. First, create a ``taskotron`` group if you don't have it already,
84	and add your user to it (you'll need to re-login afterwards)::	84		and add your user to it (you'll need to re-login afterwards)::
85		85
86	getent group taskotron \|\| sudo groupadd taskotron	86		getent group taskotron \|\| sudo groupadd taskotron
87	sudo usermod -aG taskotron <user>	87		sudo usermod -aG taskotron <user>
88		88
89	Now create the directories with proper permissions::	89		Now create the directories with proper permissions::
90		90
91	sudo install -d -m 775 -g taskotron /var/tmp/tasktron /var/log/taskotron \	91		sudo install -d -m 775 -g taskotron /var/tmp/taskotron /var/log/taskotron \
			kparalUnsubmitted Not Done Nice catch!
92	/var/cache/taskotron /var/lib/taskotron /var/lib/taskotron/artifacts \	92		/var/cache/taskotron /var/lib/taskotron /var/lib/taskotron/artifacts \
93	/var/lib/taskotron/images	93		/var/lib/taskotron/images
94		94
95	If you're going to run tasks using disposable VM machines, you'll also	95		If you're going to run tasks using disposable VM machines, you'll also
96	need to install `testcloud <https://github.com/Rorosha/testcloud>`_ (while	96		need to install `testcloud <https://github.com/Rorosha/testcloud>`_ (while
97	being in the same virtualenv)::	97		being in the same virtualenv)::
98		98
99	git clone https://github.com/Rorosha/testcloud.git	99		git clone https://github.com/Rorosha/testcloud.git
▲ Show 20 Lines • Show All 167 Lines • Show Last 20 Lines

Docs and readme fixesClosedPublicActions

Details

Diff Detail

Revision Contents

Diff 2407

docs/source/index.rst

docs/source/quickstart.rst

readme.rst

Docs and readme fixes
ClosedPublic
Actions