singularityware / singularityware.github.io

base documentation site for Singularity software
https://singularityware.github.io
27 stars 49 forks source link

Update for 2.4.5 release #181

Closed dtrudg closed 6 years ago

dtrudg commented 6 years ago

Hi @vsoch - I think this is all that's needed to have the site directing people to the new 2.4.5

Would you be able to review these for an update to the site? Thanks!

vsoch commented 6 years ago

yeah! Let me give it a quick look.

vsoch commented 6 years ago

The links to files look good - let's add links to both @jtriley and the two PRs mentioned so the user can follow easily to learn more. You should be able to use {{ site.repo }} to refer to the start of the github links, in case they change in the future.

vsoch commented 6 years ago

And congrats on the release! :muscle:

vsoch commented 6 years ago

Q: Why was @dctrud excited to go to the market? A: They were having a deal on ice cream! It was 2.4.5 :)

dtrudg commented 6 years ago

@vsoch - I think ^^ should do it.

vsoch commented 6 years ago

ok taking a look! The text looks spot on, just want to make sure!

vsoch commented 6 years ago

ah one more detail, and this is my fault because I just forgot about it (and one of my biggest pet peezes with websites!). The link icon that is being used says "this opens externally" but the links here don't, so you would want to add a class "no-after" to them, like this:

<a href="https://github.com/singularityware/singularity/pull/1387" class="no-after">1387</a>/<a class="no-after" href="https://github.com/singularityware/singularity/singularity/pull/1397">1397</a>

and for jtriley

<a href="https://github.com/jtriley" class="no-after">@jtriley</a>

OR if you want to keep the external link icon (and make it an external link, which is also a good idea) just add the target attribute to be _blank:

<a href="https://github.com/jtriley" target="_blank">@jtriley</a>
dtrudg commented 6 years ago

Hi @vsoch - I'm kinda confused about these link class requests. I wrote the new links in markdown, so I don't have the raw html to insert a class into, and I think the icons are correct for the links.

An external link is one on a different site/domain. not something that has target _blank.

External Links are hyperlinks that point at (target) any domain other than the domain the link exists on (source).

In layman's terms, if another website links to you, this is considered an external link to your site. Similarly, if you link out to another website, this is also considered an external link.

https://moz.com/learn/seo/external-link

These links are at GitHub, and we are lbl.gov so it's correct that they are external links. The '_blank' target isn't an external link... it's just to open a link (external or not) in a new window or tab.

vsoch commented 6 years ago

It's a link that opens in a new window. The html can render in the markdown file okay, give it a try! And the class already exists - I made it for this exact purpose :)

dtrudg commented 6 years ago

I completely disagree here - the definition of an external link is not one that opens in a new window. - it is one that links to a different domain. There has been convention on some sites to open external links in a new window, but that's not related to the distinction between an external or internal link.

Also - it is really weird to write raw HTML in markdown for links when there is markup for it.

I will make the change though to have the links target _blank though in the interests of getting this doc up ASAP.

dtrudg commented 6 years ago

Ok, cool - preference noted. I'm a 'more than 5 tabs open is oooof' kinda guy, and tend to dislike links targetting new windows unless I ask for it with Ctrl.

Fingers crossed the html is good now, so we can get the 2.4.5 reference up in the docs, since it's a security release. Cheers!

vsoch commented 6 years ago

Looks great @dctrud ! Thank you! http://singularity.lbl.gov/release-2-4-5

vsoch commented 6 years ago

oh and uh, if you ever see my computer, maybe don't look too closely at the number of tabs... image :)