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

Sara/tec 198 create a developer friendly onboarding page in the docs #1848

Draft
wants to merge 14 commits into
base: main
Choose a base branch
from

Conversation

s-santillan
Copy link
Collaborator

Thanks for improving Semgrep Docs 😀

Please ensure

  • A subject matter expert (SME) reviews the content
  • A technical writer reviews the content or PR

@s-santillan s-santillan self-assigned this Nov 15, 2024
@s-santillan s-santillan marked this pull request as draft November 15, 2024 04:28
Copy link

netlify bot commented Nov 15, 2024

Deploy Preview for semgrep-docs-prod failed. Why did it fail? →

Name Link
🔨 Latest commit 312f716
🔍 Latest deploy log https://app.netlify.com/sites/semgrep-docs-prod/deploys/6742dcccf7f4350008bfeceb

- 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.
Copy link
Collaborator Author

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?

The following example is a simplified Semgrep rule that detects possible cross-site scripting vulnerabilities:


```yaml showLineNumbers
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This 3rd example doesn't have an embedditor (it requires log in to view the rule). How do we feel about that? I could also convert the other two previous examples into plain YAML / source code rather than use the embedditor.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

1 participant