Skip to content
Permalink
Browse files

(doc) Update from wiki

  • Loading branch information...
gep13 committed Jun 16, 2019
1 parent a4cfe49 commit 0fe2592251d6816d4038f29d2c6c20f030065474
Submodule choco.wiki updated from 2489f6 to c6f064
@@ -221,7 +221,7 @@ chocolateyInstall or chocolateyUninstall scripts.</p>
<p>If there is an icon which is suitable for your package, you can specify it in the <code>&lt;iconUrl&gt;</code> tag in the nuspec. But there are a few things you should consider:</p>
<ul>
<li><strong>Avoid hotlinking icons from sites where you don&#39;t have control over the file.</strong> If you have a packages repository (recommended), use your own copy of the icon and put it there.</li>
<li>For the <strong>icon URLs it is recommended to use <a href="https://cdn.rawgit.com/" class="uri">https://cdn.rawgit.com/</a> (production links).</strong> Rawgit is a CDN service that permits you to serve files hosted in a repository on GitHub. Keep in mind that cdn.rawgit.com caches files permanently. Therefore it&#39;s best to use a specific tag or commit URL, not a branch URL.</li>
<li><strong>Use a static CDN for icon URLs that permits you to serve files hosted in a repository on GitHub.</strong> Some CDN services cache files permanently and it&#39;s therefore best to use a specific tag or commit URL, not a branch URL. While we don&#39;t make any recommendations about specific services, the more popular ones used by maintainers are <a href="@Url.RouteUrl(RouteName.Docs, new { docName = "jsdelivr.com" })">jsDelivr</a>, <a href="@Url.RouteUrl(RouteName.Docs, new { docName = "staticaly.com" })">Staticaly</a> and <a href="@Url.RouteUrl(RouteName.Docs, new { docName = "githack.com" })">Githack</a>.</li>
<li><strong>Avoid using GitHub raw links</strong> (<a href="https://raw.githubusercontent.com/" class="uri">https://raw.githubusercontent.com/</a>...). They are not intended to be used as CDN.</li>
<li><strong>Use the software&#39;s icon if one is available, not the logo.</strong> This blog post explains the difference between logos and icons: <a href="http://blog.designcrowd.com/article/353/differences-between-logos-and-icons" class="uri">http://blog.designcrowd.com/article/353/differences-between-logos-and-icons</a>. If the software of your package doesn&#39;t have an icon, but a logo with text and an image, you can extract the image with your favorite image editor and use that as package icon. An example is <a href="https://chocolatey.org/packages/mysql">MySQL&#39;s dolphin</a>.</li>
<li><strong>Use package icons with at least 128 pixels in width or height</strong> if available. However, avoid very high resolutions, because this would only unnecessarily increase the page load time. If there are only icons with less than 128 pixels available, choose the icon with the highest resolution you can find without upscaling it. Don&#39;t use low resolution favicons as package icons.</li>
@@ -101,7 +101,7 @@
<li>Trial software should include the #trial tag. (will become a requirement in Feb 2016)</li>
<li>Software that requires a license should include a tag #license. (will become a requirement in Feb 2016)</li>
<li>LicenseUrl is nearly a requirement. The only reason it sits in guidelines is that not all software has a url out there containing its license information. We request that in those cases they point to the url for the FOSS license of the software, if they have an open license.</li>
<li>We really want to see the IconUrl being used, and some moderators want to see it being used properly, using the rawgit CDN. However it is a guideline, and something to note for a maintainer to fix up next time, not currently. Some software doesn&#39;t have a proper icon.</li>
<li>We really want to see the IconUrl being used, and some moderators want to see it being used properly, using the jsDelivr, Staticaly, or Githack CDN. However it is a guideline, and something to note for a maintainer to fix up next time, not currently. Some software doesn&#39;t have a proper icon.</li>
<li>Suggest description get really filled out and they take full advantage of the use of markdown.</li>
<li>Summary is important, but it doesn&#39;t show up on the package page.</li>
<li>Tags could always use suggestions to add.</li>

0 comments on commit 0fe2592

Please sign in to comment.
You can’t perform that action at this time.