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

Rename Hubs to Workspaces #2574

Merged
merged 7 commits into from
Apr 19, 2024
Merged

Rename Hubs to Workspaces #2574

merged 7 commits into from
Apr 19, 2024

Conversation

hugobarauna
Copy link
Member

I was talking to José, and I believe we should make a few nomenclature changes. This is probably the main one.

I talked to him, and he suggested only changing the text that is shown to the user instead of also changing the code.

Copy link

github-actions bot commented Apr 17, 2024

Uffizzi Preview deployment-50362 was deleted.

@@ -1192,7 +1192,7 @@ defmodule LivebookWeb.SessionLive.Render do
class="inline-flex items-center cursor-pointer gap-1 mt-1 text-sm text-gray-600 hover:text-gray-800 focus:text-gray-800"
aria-label={@data_view.hub.hub_name}
>
<span>in</span>
Copy link
Member Author

Choose a reason for hiding this comment

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

Before

CleanShot 2024-04-17 at 15 23 33

After

CleanShot 2024-04-17 at 15 19 02

CleanShot 2024-04-17 at 15 18 54

I changed that part because I don't think the relationship between a notebook and a workspace is that a "notebook" is "in" a "workspace".

A notebook is "in" a file system or "in" a GitHub repo, in my opinion.

I actually think a notebook "uses" a "workspace".

A workspace is basically a collection of configurations and resources:

  • secrets
  • file storages
  • deployment groups (if it's a teams workspace)
  • stamping secret key OR teams key

When we associate a notebook with a workspace, we allow that notebook to access the resources belonging to that workspace.

That's why I changed the "in" preposition here to something else.

That said, I didn't like how the aesthetics of the result ended up when I changed to "workspace" instead of "in". Specially for the default personal "My Workspace".

If you have any suggestions to improve the design or the text, I'm open to it.

Copy link
Member

Choose a reason for hiding this comment

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

Changing the wording sounds good to me.

I actually think a notebook "uses" a "workspace".

So perhaps "using 🏠 My Workspace"?

Another option would be to skip the prefix altogether, which I think is fine. @josevalim?

Copy link
Member Author

Choose a reason for hiding this comment

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

Aesthetically, I liked "using" better than "workspace".

Before

CleanShot 2024-04-17 at 15 55 14

CleanShot 2024-04-17 at 15 55 25

After

CleanShot 2024-04-17 at 15 57 04

CleanShot 2024-04-17 at 15 57 09

Copy link
Member Author

Choose a reason for hiding this comment

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

But now, I'm having second thoughts. Maybe we should keep the label "Workspace". It's easier to say to someone that is having any kind of doubt to "go to your notebook, at the top, you can change the workspace it's associated to".

So, another way could be:

  • the label is "Workspace"
  • the default name of the personal workspace is "Personal".

So, we would have:

Home

CleanShot 2024-04-17 at 16 02 48

Notebook associated with personal workspace

CleanShot 2024-04-17 at 16 02 59

Notebook associated with teams workspace

CleanShot 2024-04-17 at 16 03 06

That's my new preference.

Let's go this way, shall we?

Copy link
Member

Choose a reason for hiding this comment

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

Works for me, and I like "My Hub" -> "Personal" as it's more consistent with org names.

Copy link
Member Author

Choose a reason for hiding this comment

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

Done in bedee18

Copy link
Contributor

Choose a reason for hiding this comment

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

What about “using [v Personal] workspace”?

Copy link
Member Author

Choose a reason for hiding this comment

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

@josevalim nice idea!

Here are a few options.

But before, here's some context (the workspace names in the example):

CleanShot 2024-04-18 at 14 33 06

Option 1 (with "using", like you suggested)

CleanShot 2024-04-18 at 14 30 42

Option 2 (with "using", but chevron after "workspace")

CleanShot 2024-04-18 at 14 30 15

Option 3 (without "using")

CleanShot 2024-04-18 at 13 59 28

My preference

I prefer option 2:

CleanShot 2024-04-18 at 14 30 15

  • it looks like
  • it contains the word "using", so it clearly shows there's an association between the notebook and the workspace

Should we go with option 2?

@josevalim, what do you think?

Copy link
Contributor

Choose a reason for hiding this comment

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

What if we do "using ICON Personal CHEVRON workspace"?

Copy link
Member Author

Choose a reason for hiding this comment

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

What if we do "using ICON Personal CHEVRON workspace"?

I liked that. 👍

Here's what it looks like:

CleanShot 2024-04-19 at 16 28 20

CleanShot 2024-04-19 at 16 28 37

Done in 3ba93f1

I think now we're ready to merge. What do you think @josevalim ?

@@ -19,7 +19,7 @@ defmodule LivebookWeb.Hub.EditLive do
hub: nil,
counter: 0,
type: nil,
page_title: "Hub - Livebook",
page_title: "Workspace - Livebook",
Copy link
Contributor

Choose a reason for hiding this comment

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

There is an error message here to change "Hub deleted"

@josevalim
Copy link
Contributor

There are entries in these files. Search for "hub " or "Hub " (with space) in these files:

  • team_component.ex
  • edit_live.ex
  • file_system_list_component.ex
  • deployment_group_component.ex
  • secrets_list_component.ex

@hugobarauna
Copy link
Member Author

There are entries in these files. Search for "hub " or "Hub " (with space) in these files:

  • team_component.ex
  • edit_live.ex
  • file_system_list_component.ex
  • deployment_group_component.ex
  • secrets_list_component.ex

@josevalim

Good catch, thank you!

Done in 5c1db8e

Did you use the shell command to find those? I was doing ack -i "\bhub\b" lib/, but somehow, I missed the ones you found.

@josevalim
Copy link
Contributor

Did you use the shell command to find those?

@hugobarauna I searched for "hub "

@hugobarauna hugobarauna merged commit 7a16ce1 into main Apr 19, 2024
6 of 7 checks passed
@hugobarauna hugobarauna deleted the hb-hubs-to-workspaces branch April 19, 2024 20:40
spunkedy pushed a commit to spunkedy/livebook that referenced this pull request Apr 22, 2024
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.

3 participants