-
Notifications
You must be signed in to change notification settings - Fork 20
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
Docs: Add quickstart user guide #265
Docs: Add quickstart user guide #265
Conversation
a263cd3
to
b2a7231
Compare
b2a7231
to
4a6f42c
Compare
guides/quickstart.md
Outdated
After making this change, the analyzer no longer produces a report. There are many ways to | ||
address reports, the important thing is to modify the code so that the Source can no longer | ||
reach the Sink. For example, you may wish to define a "Sanitizer" function that removes the | ||
password, making the `auth` struct safe to log. See [the documentation](../configuration/README.md) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Authentication
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are you referring to auth
? I think I prefer auth
here, because that is IMO the most specific label, being the name of the variable in the example. WDYT?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It says 'making the auth
struct safe to log.' But there is no auth
struct there is an Authentication
struct.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In my understanding, the auth
variable is a struct
of type Authentication
. I see your point, though. The sanitizer would work with values of type Authentication
.
I've reworded it. WDYT?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am thinking do we really need the line
For example, you may wish to define ...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it's good to make a nod to it here. Sources, Sinks and Sanitizers are (in my understanding) the 3 core concepts to understand for levee. Sources and Sinks are more fundamental, which is why they get most of the attention in this guide. But I think Sanitizers should at least get a mention.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks pretty good. I've got a handful of nits, but this is a good addition.
Thank you for your comments! PTAAL. |
I've changed the config to use I'm marking this PR a draft until that's merged. (Currently, using |
This PR adds a user guide that shows how to configure and run the analyzer. The intent is to provide a "quickstart" tutorial that allows users to quickly grasp how they can start applying the analyzer.