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

Update connect scm instructions and improve readability #1970

Merged
merged 5 commits into from
Feb 13, 2025

Conversation

s-santillan
Copy link
Collaborator

@s-santillan s-santillan commented Feb 12, 2025

Thanks for improving Semgrep Docs 😀

Please ensure

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

This is an expansion of the original request.

  • The doc seems long because we have instructions per-provider. I opted to use tabs for this, especially because users don't need to see all the instructions, just those for their provider.
  • The UI changed so the steps changed. In particular:
    • Source Code Manager, Source Code Organizations are now all Source code managers
    • We now show all the SCMs under a drop-down box.
  • Clarified a bit about choosing accounts to install SCMs on because some folks may wonder "where did the other accounts come from?"
  • Removed some screenshots that change a lot, but did add the screenshot for viewing all accounts/orgs in a Semgrep deployment, because sometimes it's hard to visualize.

@s-santillan s-santillan self-assigned this Feb 12, 2025
Copy link

netlify bot commented Feb 12, 2025

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

Name Link
🔨 Latest commit 0a8e24a
🔍 Latest deploy log https://app.netlify.com/sites/semgrep-docs-prod/deploys/67ae4fe8a4f67d00087374f3
😎 Deploy Preview https://deploy-preview-1970--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 s-santillan marked this pull request as ready for review February 13, 2025 14:07
docs/deployment/connect-scm.md Show resolved Hide resolved
docs/deployment/connect-scm.md Outdated Show resolved Hide resolved
@s-santillan s-santillan merged commit af01a44 into main Feb 13, 2025
7 checks passed
@s-santillan s-santillan deleted the sara/tec-203-outdated-scm-tab-screenshot branch February 13, 2025 20:06
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