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

DYN-2240 #10155

Merged
merged 2 commits into from
Nov 27, 2019
Merged

DYN-2240 #10155

merged 2 commits into from
Nov 27, 2019

Conversation

reddyashish
Copy link
Contributor

@reddyashish reddyashish commented Nov 21, 2019

Purpose

This PR is to make simplify the terminology used in the workspace dependency extension.

Task: https://jira.autodesk.com/browse/DYN-2240

Screen Shot 2019-11-26 at 2 57 36 PM

Looking for suggestions.

Declarations

Check these if you believe they are true

  • The codebase is in a better state after this PR
  • Is documented according to the standards
  • The level of testing this PR includes is appropriate
  • User facing strings, if any, are extracted into *.resx files
  • All tests pass using the self-service CI.
  • Snapshot of UI changes, if any.
  • Changes to the API follow Semantic Versioning and are documented in the API Changes document.

Reviewers

@DynamoDS/dynamo

@mjkkirschner
Copy link
Member

mjkkirschner commented Nov 21, 2019

@reddyashish @Amoursol I don't think we should include the name package in this extension - right now it only supports packages of course - here is my reasoning:

  1. The intention is for this extension/feature to handle more dependency types than packages - like zero touch, custom nodes, hosts themselves (like core Revit library), etc.
  2. The name now includes PackageManager .... that seems like a confusing overload of the same name as the Dynamo package manager, as most users simply refer to it as package manager

what do you guys think of Workspace Requirements? or Requirements Manager or Required Libraries?

@reddyashish have you also looked through the tooltips and messages?

@reddyashish
Copy link
Contributor Author

reddyashish commented Nov 21, 2019

@mjkkirschner Yes, I agree with you. Sol has suggested the name "Workspace Manager" but I was thinking we can make it more clear. Required Libraries looks like a good choice but I was hoping the work "Workspace" to be included as these are specifically for each workspace.

Also regarding the tooltips, there is only one tooltip message for the refresh icon which says "Click to recalculate workspace dependencies". I will change this accordingly once we finalize the name for the extension

@mjkkirschner
Copy link
Member

@reddyashish - what about Required Workspace Libraries? or Referenced Workspace Libraries?

@mjkkirschner
Copy link
Member

@kronz might have some thoughts as well.

@QilongTang
Copy link
Contributor

QilongTang commented Nov 22, 2019

@reddyashish @mjkkirschner @Amoursol @kronz How about simply Workspace References, Reference is a widely used term already and Visual Studio use it as well for listing what current coding project is depending on in order to build and work. I would like to also limit the name as short as possible and as catchy as possible for future workshops and answer bar duty. My 2 cents.

Also, I vote against required libraries because it is not always 100% accurate, for example, if the graph is referencing a custom node from a package which is built on a bunch of default nodes, the user could still remove such required reference and build it by themselves. So I believe technically it is not really required but referenced to make the process simpler.

@mjkkirschner
Copy link
Member

mjkkirschner commented Nov 22, 2019

@QilongTang I like Workspace References as well because it can include any reference type if we want to extend it further in the future and the name still makes sense. (ie file references, cloud references, single nodes, libraries etc)

@reddyashish
Copy link
Contributor Author

I am good with Workspace References as well unless someone has a better suggestion. Will change it to this.

@kronz
Copy link
Contributor

kronz commented Nov 22, 2019

FWIW, you might look at what similar functionality is called in our host applications. For instance, Revit has "Manage Links", Autocad has a "Data Link Manager", although "Manager" is problematic with the name collision with the PM. Could also check with HIG folks if there is a standardizing language (Tom Vollaro would be a good person to start with"

@reddyashish
Copy link
Contributor Author

Changed the extension name to Workspace References and triggered a self serve run.

@reddyashish
Copy link
Contributor Author

Self-serve CI passed with no failures.

@QilongTang
Copy link
Contributor

LGTM

@QilongTang QilongTang added the LGTM Looks good to me label Nov 27, 2019
@reddyashish reddyashish merged commit b3ba589 into DynamoDS:master Nov 27, 2019
@reddyashish
Copy link
Contributor Author

Will cherry-pick this to 2.5 as well.

reddyashish added a commit to reddyashish/Dynamo that referenced this pull request Nov 27, 2019
* DYN-2240

* Addressing some comments

(cherry picked from commit b3ba589)
reddyashish added a commit that referenced this pull request Nov 28, 2019
* DYN-2240

* Addressing some comments

(cherry picked from commit b3ba589)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
LGTM Looks good to me
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants