chocolatey / package-validator

Windows service to validate packages conform to package standards
Apache License 2.0
31 stars 29 forks source link

Documentation needs links to Package Schema and Schema Examples #138

Open RickStrahl opened 8 years ago

RickStrahl commented 8 years ago

Since Chocolatey uses a custom NuGet flavor, there really needs to be a page that has the schema listed or at least an example file with all data filled in.

The Package admin page shows a number of useful hints, but it never shows the format of actual tags. Example - there's supposed the be an admin tag - what goes in that? True/False/0/1? Empty tag? No idea. Trying to find more info on the wiki is like finding a needle in a hay stack.

Ideally I'd like to see: Simple example of the tag used in the wiki topic. One or more sample .nuspec files that demonstrate correct usage of tags (with comments for what's required what's optional what's deprecated)

gep13 commented 8 years ago

@RickStrahl I think this a good suggestion, and definitely an area that can be improved. I am not sure that this is the right repo to raise this on, but I am sure that @ferventcoder will be able to confirm.

In the interim, have you seen the output from choco new? This has a sample nuspec and .ps1 files, that I think will have at least some of the things that you are looking for.

ferventcoder commented 8 years ago

Especially choco new in the beta version. It outputs a schema that looks like what you see at https://chocolatey.org/packages/default.template#files

ferventcoder commented 8 years ago

We could list this here, but we should also probably add the schema somewhere and actually have it available. MS doesn't actually publish schemas for NuGet (at least I have not been able to locate them), but perhaps we should.

AdmiringWorm commented 7 years ago

btw, the offical nuspec(nuget) file schema is available here: https://github.com/NuGet/NuGet.Client/blob/dev/src/NuGet.Core/NuGet.Packaging/compiler/resources/nuspec.xsd Unless I'm mistaken, that is the one that is currently used.

ferventcoder commented 7 years ago

Ah, well then. Here is Chocolatey's - https://github.com/chocolatey/nuget-chocolatey/blob/2.11_adds/src/Core/Authoring/nuspec.xsd