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 link to Package Authoring best practices to Package Upload page #8411

Closed
skofman1 opened this issue Feb 3, 2021 · 4 comments
Closed
Assignees

Comments

@skofman1
Copy link
Contributor

skofman1 commented Feb 3, 2021

Is your feature request related to a problem? Please describe.

It will make the page more discoverable to package authors.

Describe the solution you'd like

Add a link to this page: https://docs.microsoft.com/en-us/nuget/create-packages/package-authoring-best-practices

//cc @jcjiang

@skofman1 skofman1 added this to the Sprint 2021-02 milestone Feb 8, 2021
@jcjiang
Copy link

jcjiang commented Feb 11, 2021

image
Looking at the existing functionality, I feel the warning that pops up when a package does not have sufficient information is a good place to put the link. Maybe it can replace the existing link. I am wary of putting the link at the very top because it is less discoverable. What do people think?

@skofman1
Copy link
Contributor Author

I thinking changing the 'read more' link is a good idea, but the thing is, that the logic that pops-up this warning doesn't verify all the best practices in the doc.
What do you think about change the 'Read More' but also updating the text in the tab. We can add something like: "To learn how to author great packages read here".

image

@jcjiang
Copy link

jcjiang commented Feb 12, 2021 via email

@skofman1 skofman1 added the UI improvement Low hanging fruit UI improvement label Feb 12, 2021
@agr agr modified the milestones: Sprint 2021-03, Sprint 2021-04 Mar 22, 2021
@loic-sharma
Copy link
Contributor

Here are some links to the relevant code:

<p class="message">Your package file will be uploaded and hosted on the @(Config.Current.Brand) server (@(Config.Current.SiteRoot)).</p>

And:

We recommend that you fix these issues and upload a new package.
<a href="https://docs.microsoft.com/en-us/nuget/policies/nuget-faq#managing-packages-on-nugetorg" alt="Read more" aria-label="Read more about managing packages on nuget.org">Read more</a><br />

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants