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.

Sign up for GitHub

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 "Studio" to "DVC Studio" in titles #5131

Merged
merged 2 commits into from
Dec 20, 2023
Merged

Update "Studio" to "DVC Studio" in titles #5131

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
290e1dd
Update "Studio" to "DVC Studio" in titles
julieg18 Dec 17, 2023
f8e4034
Merge branch 'main' into studio-to-dvc-studio
julieg18 Dec 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion extension/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1509,7 +1509,7 @@
},
{
"id": "dvc.views.studio",
"name": "Studio",
"name": "DVC Studio",
"when": "dvc.commands.available && dvc.project.available"
},
{
Expand Down
6 changes: 3 additions & 3 deletions webview/src/setup/components/App.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -820,7 +820,7 @@ describe('App', () => {
const experiments = screen.getByText('Experiments')
expect(experiments).toBeInTheDocument()
expect(screen.queryByText(experimentsText)).not.toBeInTheDocument()
const studio = screen.getByText('Studio')
const studio = screen.getByText('DVC Studio')
expect(studio).toBeInTheDocument()
expect(screen.queryByText(studioButtonText)).not.toBeInTheDocument()
})
Expand All @@ -836,7 +836,7 @@ describe('App', () => {
}
})
mockPostMessage.mockClear()
const studio = screen.getByText('Studio')
const studio = screen.getByText('DVC Studio')
expect(studio).toBeInTheDocument()
expect(screen.queryByText(studioButtonText)).not.toBeInTheDocument()
const dvc = screen.getByText('DVC')
Expand All @@ -858,7 +858,7 @@ describe('App', () => {
}
})
mockPostMessage.mockClear()
const studio = screen.getByText('Studio')
const studio = screen.getByText('DVC Studio')
expect(studio).toBeInTheDocument()
expect(screen.getByText(studioButtonText)).toBeInTheDocument()
const dvc = screen.getByText('DVC')
Expand Down
2 changes: 1 addition & 1 deletion webview/src/setup/components/App.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,7 @@ export const App: React.FC = () => {
</SetupContainer>
<SetupContainer
sectionKey={SetupSection.STUDIO}
title="Studio"
title="DVC Studio"
icon={getStudioStatusIcon(!!cliCompatible, isStudioConnected)}
>
<Studio
Expand Down
2 changes: 1 addition & 1 deletion webview/src/setup/components/studio/Connect.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ export const Connect: React.FC<PropsWithChildren> = ({ children }) => {
<EmptyState isFullScreen={false}>
<div>
<h1>
Connect to <a href={DEFAULT_STUDIO_URL}>Studio</a>
Connect to <a href={DEFAULT_STUDIO_URL}>DVC Studio</a>
</h1>
{children}
<p>
Expand Down
2 changes: 1 addition & 1 deletion webview/src/setup/components/studio/Settings.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ export const Settings: React.FC<
return (
<EmptyState isFullScreen={false}>
<div>
<h1>Studio Settings</h1>
<h1>DVC Studio Settings</h1>
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I updated title-like text but I'm not sure if we should be referring to DVC Studio everywhere. Other places:

  • in Command Pallete commands
  • link description in experiments table
  • toasts
  • description tooltip in setup

Copy link
Member

Choose a reason for hiding this comment

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

can you please share screenshots to review those places?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sure! Here are other places where we mention "Studio":

image image image image image image

Copy link
Member

Choose a reason for hiding this comment

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

I don't have a strong opinion on this tbh. I think it's clear from the context already. @jendefig wdyt? :)

Copy link

Choose a reason for hiding this comment

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

I think maybe as a rule of thumb, any place it's by itself or first appearing, the instance should say "DVC Studio." If there are follow-up sentences/messaging in the same place/area it's ok to say just "Studio."

In @julieg18 instances above top to bottom:

  1. DVC Studio
  2. DVC Studio
  3. Studio is fine
  4. DVC Studio
  5. DVC Studio
  6. Studio references in the lower text are fine because the header already says "DVC Studio"

{children}
<div className={styles.studioSettings}>
<div className={styles.checkboxWrapper}>
Expand Down
Loading