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

Replace X placeholder with environment variable #1912

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

savq
Copy link

@savq savq commented Jan 16, 2025

The contributing docs that explain how to add and update a programming language use a placeholder X to refer to the name of the language. This commit updates the docs to use $PL as the placeholder instead.

Using $PL makes it easier to copy and run the code samples in the documentation, and $PL is more descriptive than simply $X.

Thanks for improving Semgrep Docs 😀

Please ensure

  • A subject matter expert (SME) reviews the content
  • A technical writer reviews the content or PR
  • This change has no security implications or else you have pinged the security team
  • Redirects are added if the PR changes page URLs
  • If you have changed any header tag links (doc/#this-kind-of-anchor), update all instances of that link

The contributing docs that explain how to add and update a programming
language use a placeholder `X` to refer to the name of the language.
This commit updates the docs to use `$PL` as the placeholder instead.

Using `$PL` makes it easier to copy and run the code samples in the
documentation, and `$PL` is more descriptive than simply `$X`.
Copy link

netlify bot commented Jan 16, 2025

Don't forget to add /docs at the end of the deploy preview site URL!

Name Link
🔨 Latest commit 17a0a04
🔍 Latest deploy log https://app.netlify.com/sites/semgrep-docs-prod/deploys/67896827b023d0000807a1af
😎 Deploy Preview https://deploy-preview-1912--semgrep-docs-prod.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@s-santillan
Copy link
Collaborator

@savq Thank you for the contribution - It has been added to the review queue!

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.

2 participants