Fix choco package issues

mp4096 commented 7 years ago

Ok, it seems like we missed some points and have some things to do:

Easy

[x] Summary (summary) is a short explanation of the software. Please include summary in the nuspec. -- duplicate the description for the time being.
[x] bugTrackerUrl - points to the location where issues and tickets can be accessed
[x] The nuspec has been enhanced to allow packageSourceUrl, pointing to the url where the package source resides. This is a strong guideline because it simplifies collaboration. Please add it to the nuspec.
[x] projectSourceUrl - points to the location of the underlying software source

BTW, what's the difference between package and project source URL? We need to dig into the choco wiki.

Not so easy

[x] Release Notes (releaseNotes) are a short description of changes in each version of a package. Please include releasenotes in the nuspec. NOTE: To prevent the need to continually update this field, providing a URL to an external list of Release Notes is perfectly acceptable.

Blocked

[ ] docsUrl - points to the location of the wiki or docs of the software
[x] The iconUrl should be added if there is one. Please correct this in the nuspec, if applicable.

Not applicable

[ ] mailingListUrl - points to the forum or email list group for the software

mp4096 commented 7 years ago

Well, this is almost done. I don't think we'll have website till 0.4.1, so I'll remove the milestone for now.

AdmiringWorm commented 7 years ago

BTW, what's the difference between package and project source URL? We need to dig into the choco wiki.

The difference is because usually the author of the software and the maintainer of the package isn't the same, so if the software is open source, the link to the repository (or to the page where the source can be downloaded from) would be added to the projectSourceUrl.

The packageSourceUrl is the source location of the package related files only (personally I prefer that the url includes the directory the package source is located in as well).

BTW, I recommend adding some more description to the choco package as well. Using for instance the description in the Readme.md file in this repo.

<description> Indentex is an indentation-based superset of LaTeX. An Indentex source file is more concise and visually less cluttered than an equivalent LaTeX file. Its indentation-based syntax was inspired by Python. Transpiling an Indentex source file yields a plain LaTeX file, which can be used further in your toolchain, sent to a publisher or your colleagues. </description>

In this case you could change to current description to be the summary instead, and then add the description I mentioned above.

BTW, the releaseNotes recommendation can be easily added by just adding a url to the Changelog file. ie

<releaseNotes>https://github.com/mp4096/indentex/blob/master/CHANGELOG.md</releaseNotes>

mp4096 commented 7 years ago

@AdmiringWorm Thanks! We've done it exactly as you suggested.

I have to update the description, however, seems like linebreaks in XML are preserved and the description looks not so good on the Chocolatey page.

AdmiringWorm commented 7 years ago

@mp4096 I had a quick look at the package, and as far as I can see everything looks good (I'll now more when the automated checks have ran).

Regarding the line breaks, I should probably have mentioned that hose are preserved. This have been mentioned to @ferventcoder in the past and most likely won't be changed anytime soon as it could affect existing package descriptions.

mp4096 commented 7 years ago

Cool!

I'm ok with line breaks, I think they're helpful when the description is long and needs to be structured.

mp4096 / indentex