Skip to content
Permalink
Browse files

(doc) Update from wiki

  • Loading branch information...
gep13 committed Jun 19, 2019
1 parent 0fe2592 commit 4b95268e06f9ad74003a1f71326b31b5e5611330
Showing with 2 additions and 2 deletions.
  1. +1 −1 choco.wiki
  2. +1 −1 chocolatey/Website/Views/Documentation/CreatePackages.cshtml
Submodule choco.wiki updated from c6f064 to d2829e
@@ -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><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>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="https://www.jsdelivr.com/">jsDelivr</a>, <a href="https://staticaly.com/">Staticaly</a> and <a href="https://raw.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>

0 comments on commit 4b95268

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