-
Notifications
You must be signed in to change notification settings - Fork 227
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
doc: Add fq usage guide solving part of FRA pcap-challenge-2021-09 #73
base: master
Are you sure you want to change the base?
Conversation
@Doctor-love have this idea of adding a few guides on how to use fq in practice, what do you think? what is lacking, more jq more fq? tricks? weird langauge? not sure what is a good style also, now i used "we" and avoided "you". |
c3ef765
to
ac15c52
Compare
Personally, I think this is pretty awesome! Shows the power of fq and the jq language - guess most people don't know much more than basic queries. I say more! |
Mayhaps use generated SVGs in examples to show off the highlighting and making it easier to follow? |
But harder to copy-paste... hmm. |
Ah good idea. Maybe ok to now be able to copy/paste from them? wonder how it would look if only the output is SVG and let the command above be plain old markdown? Was it ok to follow? i think it might go a bit too fast at the end currently, will try break that up a bit. |
I don't think it would hurt to explain the syntax and functions more, but this is a good start - a few TODOs left to fix. |
👍 will try add more about that I would also like to add some guide that is more about digging into unknown or partially unknown binary. Let me know if you have some ideas. Thinking something like decoding exif from a unknown image format etc. Also a guide about digging into broken files would be nice. Something else you think could be a common usage case? |
Both the ideas you mention sounds interesting - especially broken files. I would guess that the biggest hurdle for people is to even know where to start with fq, considering the vast amount of jq functions and similar - perhaps try to structure a guide that covers the basics and becomes progressively more advanced, the actual problem that is solved in the guide could be more or less synthetic. |
So maybe a pure jq guide would be good? could also maybe include some CLI stuff? |
jq from fq's perspective, yeah :-) |
be3a5bb
to
e0b2db6
Compare
Small tweak: perhaps a git mv to fix spelling in filename of "doc/guides/fra-pcap-challange-2021-09/README.md" |
e0b2db6
to
f6f48cb
Compare
f6f48cb
to
96f0f1f
Compare
96f0f1f
to
b6c6ff5
Compare
b6c6ff5
to
10a3f5b
Compare
10a3f5b
to
eaa0972
Compare
eaa0972
to
bfcaa63
Compare
No description provided.