getsentry / getsentry/sentry

File Names Associated with Code Snippets

Open
#75,445 0 comments 1 reaction 0 assignees View on GitHub
Improvement
Dominant language
Python
Stars
44.8k
Forks
4.9k
Avg merge
22h 21m
Merged PRs (30d)
586

Description

### Problem Statement

It is a standard feature on many dev tool sites to add code snippets developers should add to their code. This should be copy paste friendly. Additionally the developers often need to know the file name for which that snippet belongs. (app.js, index.js, setting.py, urls.py etc)

### Solution Brainstorm

In our docs this is easily achieved, however in the Sentry product not. Also so not for our static-site pages, there will be another issue for that.

It should be possible to configure for the onboarding flows the typical file name(s) that the user should copy past the code snippets into

- [Angular Example](https://docs.sentry.io/platforms/javascript/guides/angular/)
- [Django Example](https://docs.sentry.io/platforms/python/integrations/django/)

### Product Area

Projects - Project Creation

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the Project Creation onboarding flows and the Angular and Django examples linked in the issue. Determine how onboarding code snippets are represented and where their target file names could be configured. Done means the product onboarding flows can show the appropriate file name(s) alongside copyable snippets, without changing static-site pages.

Written by the indexing model from the issue text.

Assessment

Tech stack
angular, django, javascript, python
Domain
developer-experience
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.