Dark-Alex-17/kapow
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: tutorial style fixes

Browse Source
This commit is contained in:
pancho horrillo
2019-12-10 18:01:29 +01:00
parent 94b284f625
commit ae68cf8fed
6 changed files with 233 additions and 211 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/source/tutorial/tutorial03.rst
+25 -24
View File
@@ -3,43 +3,44 @@ We need to filter
**Senior**
Hi guy! How're you doing this morning? I've got a new challenge from our
Hiya! How're you doing this morning? I've got a new challenge from our
grateful mates.
As time goes on from the last rotation the size of the log file gets bigger.
Furthermore, they want to limit the output of the file to pick only some
records and only from the end of the file. We need to do something to help
them as they waste a lot of time reviewing the output.
As time goes on from the last log rotation, the size of the log file gets
bigger and bigger. Furthermore, they want to limit the output of the file to
pick only some records, and only from the end of the file. We need to do
something to help them as they are wasting a lot of time reviewing the output.
**Junior**
My two cents is that this time is going to be more of a deep bash knowledge.
Do you agree?
I have a feeling that this is going to entail some serious *bash-foo*. What
do you think?
**Senior**
By sure, but in addition to some good shell plumbing we're going to squeeze
Sure! But in addition to some good shell plumbing we're going to squeeze
*Kapow!*'s superpowers a litle bit more to get a really good solution.
Can you take a look at *Kapow!*'s documentation to see if something can be done?
Can you take a look at *Kapow!*'s documentation to see if something can be
done?
**Junior**
I've seen in the documentation and there is a way to get access to the data
comming in the request. Do you think we can use this to let them choose how
I've read in the documentation that there is a way to get access to the data
coming in the request. Do you think we can use this to let them choose how
to do the filtering?
**Senior**
Sounds great! How we have lived without *Kapow!* all this time?
Sounds great! How have we lived without *Kapow!* all this time?
As they requested, we can offer them with a parameter to filter the registers
they want to pick and another parameter to limit the output size in lines.
As they requested, we can offer them a parameter to filter the registers
they want to pick, and another parameter to limit the output size in lines.
**Junior**
Sounds that will be enough. Now we have to make some modifications to our
last endpoint definition to add this new feature. Let's start working...
Sounds about right. Now we have to make some modifications to our last
endpoint definition to add this new feature. Let's get cracking!
**Senior**
@@ -51,20 +52,20 @@ We need to filter
| tail -n "$(kapow get /request/params/lines)" \
| kapow set /response/body'
It looks a bit weird but we'll have time to re-styling later. Please make
some tests on your laptop before to publish on the *Corporate Server*.
Remember to send them an example URL with the parameters the can use to
filter.
It looks a bit weird, but we'll have time to revise the style later. Please
make some tests on your laptop before we publish it on the *Corporate Server*.
Remember to send them an example URL with the parameters they can use to
filter and limit the amount of lines they get.
**Junior**
Ok, Should look like this, isn't it?
OK, should look like this, doesn't it?
.. code-block:: console
$ curl http://localhost:8080/db/backup_logs?filter=rows%20inserted&lines=200
$ curl 'http://localhost:8080/db/backup_logs?filter=rows%20inserted&lines=200'
**Senior**
Exactly. Another great day helping the company to advance. Let's go for a
beer for celebrating!
Exactly. Another great day helping the company advance. Let's go grab a
beer to celebrate!