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

54 Commits

Author SHA1 Message Date
Roberto Abdelkader Martínez Pérez
0ffb28c3d6 chore: test documentation (#145) 
* chore: Test documentation

* docs: fix broken links
 2020-12-30 16:59:22 +01:00
pancho horrillo
26fa12c871 doc: drop mentions to .pow files ($deity REST their soul) 
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
 2020-12-24 14:03:49 +01:00
Héctor Hurtado
eb4dbeadb9 Add references to mTLS configuration of proposed servers. 
Fixes #100
 2020-08-24 12:44:19 +02:00
Héctor Hurtado
d0e08815f7 Add example documentation to use built in HTTPS/mTLS support 2020-08-18 13:07:47 +02:00
pancho horrillo
a311da0d87 doc: drop shebang lines in .pow files 
For now, Kapow! treats .pow files as shell scripts, not executables.
See https://github.com/BBVA/kapow/issues/62
 2020-06-11 20:04:11 +02:00
pancho horrillo
77b358e3c8 doc: style fixes 2020-06-11 19:48:47 +02:00
pancho horrillo
09b6d54487 doc: wording and style fixes 2020-06-11 19:45:57 +02:00
Roberto Abdelkader Martínez Pérez
a178d19360 doc: Debugging bash example 2020-04-22 10:26:29 +02:00
Héctor Hurtado
45a577a547 Fix typo in documentation 2020-04-21 10:40:36 +02:00
Héctor Hurtado
1e276ab4cf Complete documentation with an explanation of set -x in script tricks 2020-04-20 10:38:54 +02:00
Héctor Hurtado
248f7d1fcc Added stderr output management to jaillover. 
Added Spawn support for stderr redirection.
Added --debug option to server cmd.
Added debug information to documentation.
Finnished script logger.
 2020-04-20 10:18:16 +02:00
pancho horrillo
4b82a2e418 docs: style fixes 2020-02-24 15:13:53 +01:00
César Gallego Rodríguez
42329a6f56 kapow! tidy server example 2020-02-24 14:56:21 +01:00
Roberto Abdelkader Martínez Pérez
64653d6d79 doc: Examples of running Kapow! behind a proxy with HTTPS. Closes #100. 2019-12-20 12:43:07 +01:00
Roberto Abdelkader Martínez Pérez
3cfc7e21ba doc: Put examples into categories. Parameter injection example moved to security concerns instead (#101) 2019-12-19 16:32:56 +01:00
Roberto Abdelkader Martínez Pérez
01726df4e8 doc: Restructure to allow better latex rendering 2019-12-16 11:00:36 +01:00
pancho horrillo
3bb0205ad1 doc: style fixes 2019-12-13 15:14:35 +01:00
pancho horrillo
2847073519 doc: drop explicit :tech: role 2019-12-13 15:10:17 +01:00
pancho horrillo
dea72cbe3a doc: style fixes and links 2019-12-13 15:08:02 +01:00
pancho horrillo
45de5a55e8 doc: style fixes 2019-12-13 12:35:48 +01:00
pancho horrillo
b9f42bc458 doc: fix code style in titles 
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
 2019-12-11 18:18:05 +01:00
pancho horrillo
f57df90347 doc: fix broken link 
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
 2019-12-11 18:17:46 +01:00
pancho horrillo
e78af66c12 doc: markup ping as command role, not program role 
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
 2019-12-11 17:56:28 +01:00
pancho horrillo
ecaea23d40 doc: markup stdin as tech role 
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
 2019-12-11 16:05:55 +01:00
pancho horrillo
ab615e2276 doc: markup :any: role as default role, which is now :tech: (custom) 
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
 2019-12-11 15:59:27 +01:00
pancho horrillo
cb5ba7db43 doc: markup {User,Control,Data} HTTP Interface as role any 
Also markup localhost:8080 as code, for consistency.

Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
 2019-12-11 14:41:14 +01:00
pancho horrillo
11383d456a doc: markup JSON as any role (part II) 
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
 2019-12-11 13:17:55 +01:00
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
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
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
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
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
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
pancho horrillo
8248627f04 doc: misc fixes 
Co-authored-by: Luis Saiz <luis.saiz@bbva.com>
 2019-11-29 12:57:45 +01:00
luissaiz
b0c8b74e63 Update index.rst (#97) 2019-11-29 11:56:14 +01:00
pancho horrillo
53b326cb7b doc: style fixes, example code fixes and clarifications 2019-11-27 16:07:23 +01:00
pancho horrillo
530fad17c9 doc: fix typo 2019-11-27 07:53:56 +01:00
cr0hn
cfbb2ef6cb Merged greet-json & upload examples 2019-11-22 12:15:33 +01:00
cr0hn
4c2ff45a84 Merge remote-tracking branch 'origin/master' 
# Conflicts:
#	docs/source/examples/index.rst
 2019-11-22 12:00:02 +01:00
cr0hn
d52137bce8 typos & new examples 2019-11-22 11:59:21 +01:00
pancho horrillo
24cc530a0e doc: add missing quotes in example 
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
 2019-11-21 13:12:19 +01:00
pancho horrillo
8f876ba7db doc: fix a couple of typos and drop spurious whitespace 2019-11-21 10:36:46 +01:00