search

sanity-io / sanity

Sanity Studio – Rapidly configure content workspaces powered by structured content
https://www.sanity.io
MIT License
5.33k stars 431 forks source link

`test-studio` project access instructions for contributors #4021

Open fritz-c opened 1 year ago

fritz-c commented 1 year ago

Is your feature request related to a problem? Please describe.

After cloning this repo and running the dev environment as described in CONTRIBUTING.md, it is unclear how I can view the projects containing sample data. Configuration exists here:

https://github.com/sanity-io/sanity/blob/d53a589f1526d8602f7678e67b10729a4fa7d933/dev/test-studio/sanity.config.ts#L86-L157

but attempts to authorize with those projects fail and I cannot see the data. As a temporarily solution I plugged in the ID for a sample project of my own, and added data where necessary, but I have to work around that change in git as I make commits, so it doesn't feel like the ideal solution.

Describe the solution you'd like I understand a publicly-editable Sanity project is not really realistic, so I'm not expecting changes to happen there, but I would like a setup that's friendlier to those outside of the Sanity organization. I think the project configuration parts should not be tracked by git. I think the CONTRIBUTING.md doc should more plainly lay out the steps for working with sample projects in test-studio.

In addition to that, if there were a readonly project from which we could somehow clone the data to our own, new contributors could avoid the work of creating their own sample data. I'm not sure if the time invested in such a solution could be justified, though.

Describe alternatives you've considered Nothing in particular.

Additional context

rexxars commented 1 year ago

Thanks for raising, this is definitely something we want to improve - we just need to find some time to do it :)