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

Show 'latest' documentation for all package versions #4772

Closed
anangaur opened this issue Sep 28, 2017 · 6 comments
Closed

Show 'latest' documentation for all package versions #4772

anangaur opened this issue Sep 28, 2017 · 6 comments

Comments

@anangaur
Copy link
Member

Feature discussion issue: #2280

Today the markdown documentation is only per package version. I do not expect authors to edit their packages to include markdown documentation.

We should show the latest documentation on all package versions.

i.e.

  1. I edit my package version 2.1.0 with markdown documentation.
  2. I upload a new version 2.2.0 and then 3.0.0 versions of the package.

Expected: Both 2.2.0 and 3.1.0 should show me the documentation that i added for 2.1.0

Now if I edit 3.0.0 to change or add new documentation, all the newer versions from 3.0.0 onwards should start showing the new documentation.

@scottbommarito
Copy link
Contributor

What if users explicitly do not want to show documentation for future packages? How do they do this?

@anangaur
Copy link
Member Author

@scottbommarito

  1. Not a regular scenario. This is documentation and I do not see why this will change often.
  2. Even if it changes and some reasons the user does not want to show any documentation, may be we can add a gesture stating "Do not show any documentation".

But I will wait for users asking us this capability explicitly.

When we have the feature to incorporate this feature into pack, I would say this (issue) ask may be unnecessary.

@chenriksson chenriksson self-assigned this Oct 13, 2017
@anangaur
Copy link
Member Author

Based on discussion we had, we should make this change for more adoption as we do not expect users to provide the documentation everytime they update their package.

@joelverhagen
Copy link
Member

As mentioned on #4920, another option is:

@robertmuehsig, would a new version defaulting to the previous version's documentation be acceptable? More formally, when handling a new version upload, inherit the readme of a version less than the version being pushed, if any exists. This is just a suggest and might clash with plans I don't know about. If we go this route, we would have to choose between baking this in at upload time or just falling back in the package details view if the selected version has no readme.

@robertmuehsig, feel free to add your additional thoughts here. Customer input is always appreciated and will help us assess the priority of this feature request.

@robertmuehsig
Copy link
Contributor

Why not threat the documentation URL like the license URL or project site url and if you detect a GitHub URL just show the possible GitHub Readme.md.

@skofman1
Copy link
Contributor

We are starting to work on making markdown documentation as part of the package: https://github.com/NuGet/Home/wiki/Packaging-Documentation-within-the-nupkg
This calls for showing for each version the documentation that was uploaded with it.
Closing. Feel free to open if disagree.

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

6 participants