GNOME Bugzilla – Bug 779994
Improve download page for Windows
Last modified: 2017-04-24 10:28:08 UTC
Created attachment 347861 [details] [review] proposed patch with pacman commands to run to setup the environment The current GTK+ download page for Windows users is difficult for pure Windows users to understand, as it's really UNIX-ish. They need a bit more guidance to be able to setup a working environment using MSYS2.
Review of attachment 347861 [details] [review]: Looks really good. Thanks!
Review of attachment 347861 [details] [review]: Just some small comments on visuals: ::: download/windows.php @@ +6,3 @@ <h2><a name="Download">Download for Windows</a></h2> +<p>Note: These instructions are intended for developpers wanting to develop applications based on GTK+, not for end-users.</p> typo: "developers" @@ +29,3 @@ +<tt>pacman -S mingw-w64-x86_64-gtk3</tt> + +<h4>Step 3 (recommended): Install GTK+ core applications</h4> <tt> is not styled on the site currently, so it gets the normal proportionally spaced font. Also, <tt> lines end up running right into following paragraphs/headings and breaking the look of the document. I'll upload an example screenshot shortly. I won't immediately suggest fixes for this as I haven't done CSS for HTML since years ago. @@ +81,3 @@ +<li>expat</li> +<li>libpng</li> +<li>zlib</li> missing closing tag </ul>
Created attachment 349181 [details] broken styling on <tt> spans: no monospace font or bottom margin
Review of attachment 347861 [details] [review]: even more cosmetic comments ::: download/windows.php @@ +19,3 @@ +<p>The easiest way to install GTK+ and its dependencies in binary form is through the <a href="https://msys2.github.io/">MSYS2</a> project. MSYS2 provides a UNIX-like development environment for Windows. It provides packages for many software applications and libraries, including the GTK+ stack. These packages are installed using the <a href="https://github.com/msys2/msys2/wiki/MSYS2-installation#iv-general-package-management">pacman package manager</a>.</p> + +<p>Note: in the following steps, we'll assume you're using a 64-bits Windows. Therefore, the package names include the <tt>x86_64</tt> architecture identifier. If you're using a 32-bits Windows, please adapt the instructions below using the <tt>i686</tt> architecture identifier.</p> The convention is to say 64- or 32-bit, singular. I would say "a N-bit version of Windows". @@ +31,3 @@ +<h4>Step 3 (recommended): Install GTK+ core applications</h4> +<p><strong>Glade</strong> is a GUI designer for GTK+. It lets you design your GUI and export it in XML format. +You can then import your GUI from your code using the <tt>GtkBuilder</tt> API. Read the <tt>GtkBuilder</tt> section in GTK+ manual for more information.</p> I'd say "the GTK+ manual". Also, it might be nice if we could link directly to resources like the Glade and GTK+/GtkBuilder reference docs when they are mentioned. @@ +39,3 @@ +<tt>pacman -S mingw-w64-x86_64-devhelp</tt> + +<h4>Step 4 (optional): Install the python bindings</h4> Python should be capitalised throughout. Is Python now the default recommendation, with C being an afterthought? That's implied by this order of sections.
Thanks for reviewing and committing! Looks like I broke XHTML validation though. I'm looking at it first, then I'll try to fix the styling issues.
Yeah, the missing </ul> at the bottom alone would do that, and maybe there are other tweaks required for valid XHTML that I didn't notice yet.
Created attachment 349232 [details] [review] fixes 1/4
Created attachment 349233 [details] [review] fixes 2/4
Created attachment 349234 [details] [review] fixes 3/4
Created attachment 349235 [details] [review] fixes 4/4
Please check these patches. The last one fixes the 'ul' XHTML issue, the others are for styling/spelling issues.
The contents look good to me. Thanks! Since all of these patches seems to be a clear improvement, I've pushed them. I just made some small tweaks to the commit messages for better consistency: * Use the same structure "download/windows: [Do whatever]" for all subject lines * Include URL of this bug, like the 1st commit, rather than quoting the number. Thanks for the work! (Personally, I'm a huge fan of MSYS2 and have used it with GTK+ nearly effortlessly, so it's great to see that becoming a _kinda_ 'official' recommendation!)
Thanks for the review and the commit ! I've seen the page now looks good, but it seems it still isn't valid XHTML. I couldn't use the w3c validator on source as it's generated. I'm reopening, and will try to save the generated XHTML and test validity on that, then I'll propose another patch.
Right, yeah. It's the <ul>s within <p>aragraphs at (rendered) lines 220 and 230. I did check this, but only in the sense that the footer claimed "Valid XHTML and CSS", and I should've realised that wasn't actually checked at runtime :)
Created attachment 350030 [details] [review] Final patch to fix XHTML compliance Hopefully the last patch. I've modified the generated page to check agains the W3C validator, it seems to be the last bit needed.
Comment on attachment 350030 [details] [review] Final patch to fix XHTML compliance Thanks again! I've pushed that. Btw, as a final cosmetic detail, it looks better to upload patches with their subject line as the attachment Description. If you've never tried git-bz, I can't recommend it enough! It handles all that boring stuff for us. Check it out here: https://blog.fishsoup.net/2008/11/16/git-bz-bugzilla-subcommand-for-git/
Thanks for committing this. I've already used git-bz in the past, but haven't set it up on may Windows environment, so thanks for the wakeup call :).