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

Switching out references of Iterative Studio to DVC Studio #4911

Merged
merged 5 commits into from
Oct 20, 2023
Merged

Conversation

jendefig
Copy link
Contributor

@jendefig jendefig commented Oct 10, 2023

This swaps out all the Iterative Studio references in the Docs with DVC Studio to correct branding discrepancies.

Happy Hacktoberfest! 🎃

@dberenbaum
Copy link
Contributor

@jendefig I think we also have a bunch of Studio mentions without Iterative/DVC. Do we want to change those also?

@jendefig
Copy link
Contributor Author

@jendefig I think we also have a bunch of Studio mentions without Iterative/DVC. Do we want to change those also?

Good point! Maybe. As a company we have a bad habit of calling it Studio. I think it's fair to say "Studio" in the rest of a paragraph as long as the first mention in every paragraph is "DVC Studio." If all of them are DVC Studio it might be conversationally annoying. An alternative would be to replace it with "the tool" in some places, but that feels awkward and not specific enough.

One question I had was regarding the "Studio access token" section here. I didn't change those references because I figured that would mean changes needed to be made in the platform. Should we change to "DVC Studio access token" on the platform? My feeling is yes, but that seems to open a can of worms more challenging than these changes in the docs so I left that one alone.

@tapadipti
Copy link
Contributor

Thanks @jendefig for making these changes.
I've added a commit with changes in 2 more places.

One question I had was regarding the "Studio access token" section

In the Studio user profile page, this field is called Studio Access Token. For DVC/DVCLive, it's called studio.token and DVC_STUDIO_TOKEN. Considering all this, I'd suggest not changing it in the docs for now. At some point, it would be good to sync the names.

@iterative/platform It looks like the only remaining part is the Self Hosting docs pages. These pages extensively use the name Studio (and not Iterative Studio, unlike the rest of the docs). Is it okay to replace the name Studio with DVC Studio in these pages or could it cause confusion to users (such as if the images are called "Studio" images)?

@tapadipti
Copy link
Contributor

@jendefig For the test failures, merging this PR should resolve it.

@jendefig
Copy link
Contributor Author

. Considering all this, I'd suggest not changing it in the docs for now. At some point, it would be good to sync the names.

Ok. Makes sense! 👍

@jendefig
Copy link
Contributor Author

@iterative/platform It looks like the only remaining part is the Self Hosting docs pages. These pages extensively use the name Studio (and not Iterative Studio, unlike the rest of the docs). Is it okay to replace the name Studio with DVC Studio in these pages or could it cause confusion to users (such as if the images are called "Studio" images)?

Oh. I see what you mean. I didn't find these because I searched for "Iterative Studio" to find the other. Yes, absolutely these should be changed. No one will ever find this content through a search with the headers this way. There are way to many things in our industry alone named Studio (Azure ML Studio, Label Studio, Sagemaker studio,...) let alone the rest of the world to ever find this content. Self-hosting Studio could be a ballet studio that gives members access any time they want. We need to have the brand tied into all of this.

@dberenbaum
Copy link
Contributor

In the Studio user profile page, this field is called Studio Access Token. For DVC/DVCLive, it's called studio.token and DVC_STUDIO_TOKEN. Considering all this, I'd suggest not changing it in the docs for now. At some point, it would be good to sync the names.

This was actually intentional. I believe all DVC environment variables start with DVC_ (since environment variables are global to the environment) and config options do not (since they are already inside DVC-specific config files). This is a common practice (for example, you can use env var AWS_PROFILE or use profile inside ~/.aws/config).

@jesper7
Copy link
Contributor

jesper7 commented Oct 11, 2023

https://github.com/orgs/iterative/teams/platform It looks like the only remaining part is the Self Hosting docs pages. These pages extensively use the name Studio (and not Iterative Studio, unlike the rest of the docs). Is it okay to replace the name Studio with DVC Studio in these pages or could it cause confusion to users (such as if the images are called "Studio" images)?

Yes, totally. Feel free to swap them out as part of this PR 👍

@dberenbaum
Copy link
Contributor

Yes, totally. Feel free to swap them out as part of this PR 👍

@jendefig Do you want to add this here or should we leave it out?

@tapadipti Is there anything else you feel needs to be updated in the PR?

@jendefig
Copy link
Contributor Author

Yes, totally. Feel free to swap them out as part of this PR 👍

@jendefig Do you want to add this here or should we leave it out?

@tapadipti Is there anything else you feel needs to be updated in the PR?

I've had to prioritize conference things. I will run a search on "Studio" and do those corrections in the next couple days.

@shcheklein shcheklein temporarily deployed to dvc-org-swap-names-b8quykogl2l October 20, 2023 06:05 Inactive
@shcheklein shcheklein temporarily deployed to dvc-org-swap-names-b8quykogl2l October 20, 2023 06:09 Inactive
@github-actions
Copy link
Contributor

github-actions bot commented Oct 20, 2023

Link Check Report

There were no links to check!

@tapadipti tapadipti mentioned this pull request Oct 20, 2023
@tapadipti
Copy link
Contributor

@jendefig merged the restyling changes, resolved conflicts, and created a new PR on top of this one. This new PR should address your comment I will run a search on "Studio" and do those corrections in the next couple days. I've requested your review on that PR.

@shcheklein shcheklein temporarily deployed to dvc-org-swap-names-b8quykogl2l October 20, 2023 07:13 Inactive
Copy link
Contributor Author

@jendefig jendefig left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🙏

@jendefig jendefig merged commit b821832 into main Oct 20, 2023
4 checks passed
@jendefig jendefig deleted the swap-names branch October 20, 2023 15:56
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.

5 participants