sentry-docs icon indicating copy to clipboard operation
sentry-docs copied to clipboard
verified publisher icon getsentry

Missing documentation for valid platform names

Open gk-drw opened this issue 3 years ago • 9 comments

Environment

SaaS (https://sentry.io/)

Version

No response

Link

No response

DSN

No response

Steps to Reproduce

The documentation does not list valid platforms. The model validation is performed by checking whether there is a file named integration-docs/platform-name.json (integrationdocs.py, project.py) but this is never surfaced into the documentation

Expected Result

Documentation contains a list of valid platform values

Actual Result

Documentation does not contain them.

gk-drw avatar Jan 24 '23 14:01 gk-drw

Assigning to @getsentry/support for routing, due by (sfo). ⏲️

getsantry[bot] avatar Jan 24 '23 14:01 getsantry[bot]

Routing to @getsentry/app-frontend for triage, due by (sfo). ⏲️

getsantry[bot] avatar Jan 31 '23 21:01 getsantry[bot]

By valid platform names, where in the documentation is that missing?

hubertdeng123 avatar Feb 03 '23 20:02 hubertdeng123

I'm seeing https://docs.sentry.io/platforms/

hubertdeng123 avatar Feb 03 '23 20:02 hubertdeng123

Sorry, I meant the API documentation i.e. what are valid platform strings for https://docs.sentry.io/api/projects/update-a-project/

gk-drw avatar Feb 13 '23 11:02 gk-drw

pinging @hubertdeng123

gk-drw avatar Feb 27 '23 15:02 gk-drw

Unsure exactly which team owns this, @lizokm would you happen to know who owns the API?

hubertdeng123 avatar Feb 27 '23 18:02 hubertdeng123

Unfortunately no one really does at the moment.

lizokm avatar Feb 28 '23 21:02 lizokm

got it, I know Chad is doing some teams cleanup this quarter so I'm going to put this on the backlog until then

hubertdeng123 avatar Feb 28 '23 22:02 hubertdeng123