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

Add Title field to the project files #218

Closed
jonnew opened this issue Aug 15, 2024 · 7 comments
Closed

Add Title field to the project files #218

jonnew opened this issue Aug 15, 2024 · 7 comments
Assignees
Labels
enhancement This feature already exists but could be improved
Milestone

Comments

@jonnew
Copy link
Member

jonnew commented Aug 15, 2024

Add a <title> field to the main and design packages so that their Nuget display name more user friendly

image

However, from @glopesdev

just a warning that NuGet does not respect the Title tag anymore and now just shows the unique package ID (I'm guessing to prevent impersonation). Not sure how their client API and the package manager will evolve in the future but this feature might not be guaranteed to remain in the future

@jonnew jonnew added the enhancement This feature already exists but could be improved label Aug 15, 2024
@jonnew jonnew added this to the 0.2.0 milestone Aug 15, 2024
@bparks13
Copy link
Member

What would be the ideal display name? Following the pattern in other <Title> tags shown here, we could name the base library "Bonsai Onix1 - Open Ephys" or some variation of that.

Similarly, for the Design library we can call it "Bonsai Onix1 Design Library - Open Ephys" or something like that.

@jonnew
Copy link
Member Author

jonnew commented Aug 16, 2024

I like those two options. I also like applying that schema to the rest of the packages.

@bparks13 bparks13 linked a pull request Aug 16, 2024 that will close this issue
@glopesdev
Copy link
Collaborator

I don't see how adding the word "Bonsai" in this case adds more information since the Title is already ignored by NuGet in general, and only used inside Bonsai package manager where people already expect all packages to be Bonsai packages.

Furthermore we are redesigning the package manager details page to address issues raised by @cjsha, and to increase consistency with NuGet we are emphasising package IDs over titles.

I can show you what it looks like next time we meet and we can discuss the pros and cons.

@cjsha
Copy link
Member

cjsha commented Aug 16, 2024

This is what glopesdev is referring to in the last comment btw.

If we're choosing between those two titles that bparks mentioned, I like the first one more basically because of glopes mentioned.

With that said, we refer to the package id OpenEphys.Onix1 all over the docs. We give people instructions what to look up and select in the package manager. And the package id shows up in Bonsai's module search bar. All this is to say I'm kinda ok with OpenEphys.Onix1 as the thing that people look for in package manager. The Title can be anything, but the package id is the package id, at least as far as I understand it. Imo, it's less ambiguous with little cost to readability.

@jonnew
Copy link
Member Author

jonnew commented Aug 16, 2024

The reason why the title might want to include Bonsai is because this is a bonsai package:

  • This information is no longer in our package name or namespace because we are trying to follow best practices for naming that
  • Our package is in the All package source, which is filled with nuget packages that have nothing to do with bonsai.
  • If our package showed in the Bonsai feed, or was properly filtered using tags (maybe this is coming) then i would agree with all this.

@jonnew
Copy link
Member Author

jonnew commented Aug 20, 2024

It looks like Title is basically be deprecated

  1. Focus on a standard description that starts with Bonsai library for... if its a Bonsai package
  2. Set the nuget package type (https://learn.microsoft.com/en-us/nuget/create-packages/set-package-type?tabs=dotnet). To do this, in the csproj' main put <PackageType>Dependency;BonsaiLibrary</PackageType>

@jonnew
Copy link
Member Author

jonnew commented Aug 22, 2024

Moved to #245

@jonnew jonnew closed this as completed Aug 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement This feature already exists but could be improved
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants