-
Notifications
You must be signed in to change notification settings - Fork 79
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
Sara/tec 198 create a developer friendly onboarding page in the docs #1848
Draft
s-santillan
wants to merge
7
commits into
main
Choose a base branch
from
sara/tec-198-create-a-developer-friendly-onboarding-page-in-the-docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from 3 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
de61877
initial commit onboarding
s-santillan aba99ee
begin writing example
s-santillan b0650f4
update name of file
s-santillan 5eac647
update examples
s-santillan 0065fc2
developing examples
s-santillan fd0eeed
update sections
s-santillan 43f44fa
finished fleshing out all sections for first doc
s-santillan File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
--- | ||
slug: developer-overview | ||
title: Semgrep for developers | ||
hide_title: true | ||
displayed_sidebar: scanSidebar | ||
description: tk | ||
tags: | ||
- tk | ||
--- | ||
|
||
# Semgrep for developers | ||
|
||
This guide is for developers who are using Semgrep in a team or organizational setting. Use Semgrep to: | ||
|
||
- Lint your code | ||
- Triage security issues | ||
- Automate code reviews among your peers | ||
- Follow security practices set by security engineers | ||
|
||
:::tip Developer and AppSec role | ||
- If you are a developer responsible for your **own** security program in personal projects, see the **Quickstart** and **Core deployment** docs. | ||
::: | ||
|
||
## Semgrep AppSec Platform | ||
|
||
Semgrep AppSec Platform, or Semgrep (**sem**antic **grep**), is a software suite for implementing and tracking security programs. AppSec engineers use Semgrep to detect, triage, and remediate findings. | ||
|
||
Developers primarily use Semgrep to scan for issues in their code. Issues detected by Semgrep are called **findings**. Semgrep performs static analysis and several other analyses to detect bugs, vulnerabilities in dependencies, and leaked secrets. | ||
|
||
Semgrep scans can be run in various environments, including popular IDEs, on your local machine, and in CI. | ||
|
||
## How Semgrep scans code | ||
|
||
Semgrep enables you to: | ||
|
||
- Search for code semantically | ||
- Codify those search parameters as a **rule** | ||
- Run the rule on every keystroke, commit, pull request, and merge | ||
|
||
Semgrep uses various program analyses to generate findings, similar to a linter. | ||
|
||
### Syntactic and semantic examples | ||
|
||
For example, you may want to ban the use of `==` in JavaScript and instead require `===` to avoid **type coercion**. | ||
|
||
|
||
A more complex example is detecting if unsanitized data is flowing from some source to a sink without sanitization. | ||
|
||
|
||
|
||
|
||
|
||
The following features ensure that Semgrep scans are fast and accurate: | ||
|
||
Semgrep is deterministic and transparent | ||
|
||
|
||
### Semgrep is customizable | ||
|
||
### Semgrep's approach to security: secure guardrails | ||
|
||
Your interactions with Semgrep may vary depending on your organization's deployment of Semgrep. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Is "docs" too casual for us?