git-scm.com icon indicating copy to clipboard operation
git-scm.com copied to clipboard

Added in instructions for installing gitk

Open Yash-Singh1 opened this issue 5 years ago • 7 comments

Closes #1489

This pull request refers to #1489: Downloading Git does not automatically download gitk on apt-based systems. Requested by @peff Added in a new section inside the https://git-scm.com/download/linux page.

Yash-Singh1 avatar Aug 09 '20 21:08 Yash-Singh1

I fixed the header type for Mageia. Also, is there any way to fix the problem where the code blocks are auto-wrapping and going off the screen: Screenshot from 2020-08-10 12-46-26

Yash-Singh1 avatar Aug 10 '20 19:08 Yash-Singh1

I'm not sure if organizing this into two separate lists is as good as just annotating the existing list:

  • it means we mention each OS twice, which makes the page much longer

  • we have two really long similar-looking lists, which makes it easy to accidentally scroll from one to the other and not realize you've done so

  • I imagine most people would find their OS of choice and read the instructions for it, never realizing that if they kept looking they'd find more details

Would it make sense to just do a single liner, something like this:

diff --git a/app/views/downloads/download_linux.html.erb b/app/views/downloads/download_linux.html.erb
index 29f6c991..3f52ccf9 100644
--- a/app/views/downloads/download_linux.html.erb
+++ b/app/views/downloads/download_linux.html.erb
@@ -10,12 +10,17 @@
   The latest version is
   <%= link_to @latest.name, "https://www.kernel.org/pub/software/scm/git/git-#{@latest.name}.tar.gz"%>.
 
+  Note that on many platforms, the `gitk` viewer ships as a separate
+  package; the instructions below include it but installing it is
+  optional.
+
   <h3>Debian/Ubuntu</h3>
   <p>For the latest stable version for your release of Debian/Ubuntu</p>
   <code># apt-get install git</code>
   <p>For Ubuntu, this PPA provides the latest stable upstream Git version</p>
   <code># add-apt-repository ppa:git-core/ppa</code>
   <code># apt update; apt install git</code>
+  <code># apt install gitk</code>
   
   <h3>Fedora</h3>
   <code># yum install git</code> (up to Fedora 21)<br>

(with a similar update for each of the other OS blocks)?

peff avatar Aug 11 '20 09:08 peff

Sure that is a good idea. Above the code block saying:

<code># apt install gitk</code>

Should we have a message like the following:

<p>Optionally, if you would also like to install gitk, then run the following:</p>

To inform the user that the next command will install gitk.

Yash-Singh1 avatar Aug 11 '20 16:08 Yash-Singh1

Should we have a message like the following:

<p>Optionally, if you would also like to install gitk, then run the following:</p>

To inform the user that the next command will install gitk.

My thinking was that the block at the top would explain that for all of the individual OS's below, and we wouldn't have to repeat it (and thus we could avoid making the already-long list even longer). But it should only be one extra line per OS to say "To install gitk:", so maybe that's not too bad.

peff avatar Aug 12 '20 14:08 peff

I don't see any suggestions, reviews, or conflicts currently on this pull request. Is there a reason that the merge is being delayed? I have added all the commits that I need to.

Yash-Singh1 avatar Aug 13 '20 15:08 Yash-Singh1

I don't see any suggestions, reviews, or conflicts currently on this pull request. Is there a reason that the merge is being delayed? I have added all the commits that I need to.

Sorry @Yash-Singh1 , but sometimes we can't look at PRs immediately. Between daily job, personal life, vacations, and other tasks, some days we don't simply have the time to look at PRs in the same day. Still, we try to be fast to give feedback :)

thank you for your contributions so far, helping improving the website and documentation! 🥇

(I made some small comments)

pedrorijo91 avatar Aug 13 '20 18:08 pedrorijo91

No problem. I thought that you guys were thinking that I was still putting in commits earlier.

Yash-Singh1 avatar Aug 13 '20 22:08 Yash-Singh1