Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Unix installation instructions. #146

Conversation

deansher
Copy link

Two main goals:

  • Help the user decide which installation process to use.
  • Help them understand how nightlies fit into the process.

<section class="content text-centered center-banner">
<h1 class="section-heading">
<i class="far fa-moon fa-2x" aria-hidden="true"></i>
Want a nightly build?
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why delete this?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because it parachutes the reader into detailed information about nightlies with no context on how to use them.

Also, it pulls more detailed information of interest to a much narrower audience -- the existence of the nightlies -- up to a much higher-level decision that is important to the entire audience.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In fact, as I reflect on this more, even a majority of the small group who want to know about nightlies won't initially care about browsing the list of compiled nightlies, because at first they will just use choosenim devel. In most cases, presenting a user who wants nightlies with an attractive button-link to the list of compiled nightlies at the very top of their mental decision tree will steer them down the wrong path for their needs.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've built the site with your changes, and without this the download section looks quite empty :(

with no context on how to use them

Maybe this link can then take users to an another page with that context and explanations how to use them?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A majority of users are using nightly builds of Nim. It's important to let people know they exist.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the feedback -- I agree! Let me know what you think about this latest commit.

I added content on the Download menu landing page to explain the available builds and to frame the operating-system choice.

This required a tiny bit of scss work, at which point I became frustrated that the Download menu choice pointed to a file called install.md with css class install. I changed that to download.md with css class download. (I stayed with the "install" terminology on the os-specific pages because at that point we really do start talking about installation. That terminology transition seems sensible to me.)

jekyll/install_unix.md Outdated Show resolved Hide resolved
jekyll/install_unix.md Outdated Show resolved Hide resolved
<div class="center">
<a class="pure-button"
href="https://github.com/nim-lang/nightlies/releases">
Browse Nightly Sources
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are binaries, no?

your needs:

* If you just want to use the stable version of Nim, you may find it simplest
to use your system's package manager.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe it is the simplest, but it is the surest way to install an outdated version of Nim.
E.g. I'm on Manjaro Linux, which is Arch derivative, which should have fairly recent stuff, and the version offered there is v0.18.0 (in few days it will be one year since it was released).

I would definitely add a note about the possibility of outdated version, and I'd like to remove it from the first place in the list. (The current version has "Installation using package managers" section in the last place)

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good points! Done.


* If you want to easily switch between versions of Nim,
including switching between the stable version and the development
nightlies, you may prefer ``choosenim``.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd like to see every bullet point having a link to the section about it.

E.g.

... [system's package manager](#Installation-using-package-managers)
... [``choosenim``](#Installation-using-choosenim)
...  [manual installation from source](#Manual-installation-from-source)

EDIT:
These links seem to be working on my markdown preview, but not on the site.... :/

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

<section class="content text-centered center-banner">
<h1 class="section-heading">
<i class="far fa-moon fa-2x" aria-hidden="true"></i>
Want a nightly build?
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've built the site with your changes, and without this the download section looks quite empty :(

with no context on how to use them

Maybe this link can then take users to an another page with that context and explanations how to use them?

@deansher
Copy link
Author

In my latest commit, I have done my best to incorporate all feedback up to this point.

@dom96 dom96 force-pushed the master branch 2 times, most recently from 9b17d93 to 7bdd2e1 Compare June 4, 2019 21:26
@deansher deansher closed this Feb 17, 2021
@dom96
Copy link
Contributor

dom96 commented Feb 18, 2021

Sad that we didn't end up incorporating this :/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants