Dark-Alex-17/kapow
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
737 Commits 1 Branch 0 Tags
1cb328646e8a4c7878c8acfc423ad6010cc2faa9
Commit Graph

114 Commits

Author SHA1 Message Date
pancho horrillo
1cb328646e doc: markup ping as program role 
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
 2019-12-11 12:16:41 +01:00
pancho horrillo
8742ee9667 doc: markup ls as command role 
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
 2019-12-11 11:44:32 +01:00
pancho horrillo
45de867b2d doc: markup jq as program role 
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
 2019-12-11 11:43:04 +01:00
pancho horrillo
4d2f0af941 doc: markup curl as program role 
See ¹.

¹: https://www.sphinx-doc.org/en/1.5/markup/inline.html#role-program

Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
 2019-12-11 11:43:04 +01:00
pancho horrillo
3bed9924d5 doc: make example script downloadable 
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@bbva.com>
 2019-12-11 10:45:48 +01:00
Roberto Abdelkader Martínez Pérez
5364b31603 Come on, you have to write some code... :) 2019-12-11 08:24:42 +01:00
pancho horrillo
375cf7e912 doc: fix title 2019-12-11 03:37:19 +01:00
pancho horrillo
ec4143393a doc: tweak code-block language to activate syntax highlighting 2019-12-11 03:35:12 +01:00
pancho horrillo
b1d0e9c92f doc: use valid language in code-blocks 
See ¹ for the valid values.

¹: https://www.sphinx-doc.org/en/1.5/markup/code.html#directive-code-block
 2019-12-11 03:23:56 +01:00
pancho horrillo
9436548d7b doc: normalize code-block type 2019-12-11 03:13:28 +01:00
pancho horrillo
c974e7787e doc: tweak code-block to fix render glitch at readthedocks.io 2019-12-11 03:10:55 +01:00
pancho horrillo
deceadcc49 doc: misc fixes 2019-12-11 02:49:37 +01:00
pancho horrillo
e6cb0f1fa6 doc: fix typo and rst style fixes 
As per the official docs¹, we should use ``code`` instead of :samp:`code`,
since we are not enhancing variables inside.

:samp:
A piece of literal text, such as code. Within the contents, you can use curly
braces to indicate a “variable” part, as in file. For example, in :samp:`print
1+{variable}`, the part variable would be emphasized.

If you don’t need the “variable part” indication, use the standard ``code``
instead.

¹: https://www.sphinx-doc.org/en/1.5/markup/inline.html#role-samp
 2019-12-11 02:37:56 +01:00
pancho horrillo
16639ba44b doc: style fixes 2019-12-11 02:32:52 +01:00
pancho horrillo
37025211b1 doc: style fixes 2019-12-11 02:06:31 +01:00
pancho horrillo
ef838c4a25 doc: style fix 2019-12-10 18:23:23 +01:00
pancho horrillo
ba6006fdf5 doc: fix typo 2019-12-10 18:15:29 +01:00
pancho horrillo
a9328fe706 doc: consistent naming of pow files 2019-12-10 18:10:31 +01:00
pancho horrillo
ae68cf8fed doc: tutorial style fixes 2019-12-10 18:01:54 +01:00
pancho horrillo
99167e8627 doc: tutorial background story fixes 2019-12-10 16:19:06 +01:00
pancho horrillo
cbacacf8e1 doc: tutorial background story fixes 2019-12-10 16:15:40 +01:00
pancho horrillo
b4bc08f491 doc: typos and style fixes 2019-12-10 16:09:35 +01:00
Roberto Abdelkader Martínez Pérez
84e481f78f Fix nonworking examples 2019-12-10 15:13:29 +01:00
Roberto Abdelkader Martínez Pérez
62570048af Use tabs in HEREDOC blocks 2019-12-10 14:43:51 +01:00
Roberto Abdelkader Martínez Pérez
deb94f1b49 Fix tutorial examples 2019-12-10 12:34:13 +01:00
Roberto Abdelkader Martínez Pérez
5291084c8c Download and chmod instructions for tutorial backup script 2019-12-10 12:15:44 +01:00
Roberto Abdelkader Martínez Pérez
0848dc212c Fake backup script to be used together with the tutorial. 2019-12-10 12:13:05 +01:00
pancho horrillo
bb4aa1a00f doc: normalize style of Kapow!, to be shown italicized 
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
 2019-12-10 10:34:39 +01:00
Roberto Abdelkader Martínez Pérez
7dc1d5db21 Add index.rst to side panel 2019-12-10 09:59:01 +01:00
Roberto Abdelkader Martínez Pérez
27569cf50c Review examples against option substitution. 
Co-authored-by: pancho horrillo <pedrofelipe.horrillo@bbva.com>
 2019-12-10 09:11:57 +01:00
pancho horrillo
166c767317 doc: add section on security and misc fixes 
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
 2019-12-05 18:30:35 +01:00
Roberto Abdelkader Martínez Pérez
73ede15929 Install binary always as 'kapow' 2019-12-03 09:02:27 +01:00
pancho horrillo
8248627f04 doc: misc fixes 
Co-authored-by: Luis Saiz <luis.saiz@bbva.com>
 2019-11-29 12:57:45 +01:00
luissaiz
b3d4bffdf5 doc: fix typos (#96) 
Misuse of "lets".

Co-authored-by: Luis Saiz <luis.saiz@bbva.com>
 2019-11-29 12:08:06 +01:00
luissaiz
b0c8b74e63 Update index.rst (#97) 2019-11-29 11:56:14 +01:00
pancho horrillo
2e1455cb61 Revert "Update quickstart.rst" 
This reverts commit 7fab8ae529.
 2019-11-29 10:20:40 +01:00
luissaiz
7fab8ae529 Update quickstart.rst 2019-11-29 09:48:10 +01:00
pancho horrillo
f1bdc99267 doc: drop dangling link 2019-11-28 10:44:53 +01:00
pancho horrillo
53b326cb7b doc: style fixes, example code fixes and clarifications 2019-11-27 16:07:23 +01:00
Héctor Hurtado
9cd5591490 Some minor fixes in tutorial 2019-11-27 11:50:02 +01:00
Héctor Hurtado
6fe92ede28 Fix some formatting bugs 'The Project' section 2019-11-27 10:37:54 +01:00
Héctor Hurtado
e29c56067b Fix some formatting bugs 'The Project' section 2019-11-27 10:19:21 +01:00
Héctor Hurtado
a3832977e4 Fix some formatting bugs 'The Project' section 2019-11-27 10:15:55 +01:00
Héctor Hurtado
d3489d1b4b Fix some formatting bugs 'The Project' section 2019-11-27 10:08:10 +01:00
Héctor Hurtado
1e0ba8d7e8 Fix some typos in 'The Project' section 2019-11-27 10:05:57 +01:00
Héctor Hurtado
3f62a833cd Fix some typos in 'The Project' section 2019-11-27 10:04:46 +01:00
Héctor Hurtado
da693d32b8 Fix some typos in 'The Project' section 2019-11-27 10:02:35 +01:00
Héctor Hurtado
aacbd3388a Fix some typos in 'The Project' section 2019-11-27 10:00:22 +01:00
Héctor Hurtado
65e41405ef Fix some typos in 'The Project' section 2019-11-27 09:09:08 +01:00
Héctor Hurtado
4f2c8f3468 Fix some typos in 'The Project' section 2019-11-27 08:53:50 +01:00