Skip to content
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

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

wader
Copy link
Owner

@wader wader commented Jan 11, 2022

No description provided.

@wader
Copy link
Owner Author

wader commented Jan 11, 2022

@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".

@wader wader force-pushed the guides-fra-pcap-challange-2021-09 branch 4 times, most recently from c3ef765 to ac15c52 Compare January 11, 2022 23:25
@Doctor-love
Copy link
Collaborator

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!

@Doctor-love
Copy link
Collaborator

Mayhaps use generated SVGs in examples to show off the highlighting and making it easier to follow?

@Doctor-love
Copy link
Collaborator

Mayhaps use generated SVGs in examples to show off the highlighting and making it easier to follow?

But harder to copy-paste... hmm.

@wader
Copy link
Owner Author

wader commented Jan 12, 2022

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.

@Doctor-love
Copy link
Collaborator

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.

@wader
Copy link
Owner Author

wader commented Jan 12, 2022

👍 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?

@Doctor-love
Copy link
Collaborator

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.

@wader
Copy link
Owner Author

wader commented Jan 12, 2022

So maybe a pure jq guide would be good? could also maybe include some CLI stuff?

@Doctor-love
Copy link
Collaborator

So maybe a pure jq guide would be good? could also maybe include some CLI stuff?

jq from fq's perspective, yeah :-)

@wader wader force-pushed the guides-fra-pcap-challange-2021-09 branch 4 times, most recently from be3a5bb to e0b2db6 Compare January 23, 2022 16:23
@Doctor-love
Copy link
Collaborator

Small tweak: perhaps a git mv to fix spelling in filename of "doc/guides/fra-pcap-challange-2021-09/README.md"

@wader wader force-pushed the guides-fra-pcap-challange-2021-09 branch from e0b2db6 to f6f48cb Compare January 24, 2022 08:56
@Doctor-love Doctor-love marked this pull request as draft February 7, 2022 16:11
@wader wader force-pushed the guides-fra-pcap-challange-2021-09 branch from f6f48cb to 96f0f1f Compare March 9, 2022 20:36
@wader wader force-pushed the guides-fra-pcap-challange-2021-09 branch from 96f0f1f to b6c6ff5 Compare May 28, 2022 17:55
@wader wader force-pushed the guides-fra-pcap-challange-2021-09 branch from b6c6ff5 to 10a3f5b Compare July 25, 2022 19:41
@wader wader force-pushed the guides-fra-pcap-challange-2021-09 branch from 10a3f5b to eaa0972 Compare August 19, 2022 08:00
@wader wader force-pushed the guides-fra-pcap-challange-2021-09 branch from eaa0972 to bfcaa63 Compare November 2, 2022 18:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants