New homepage, get-seek page, no About menu, new external link icon, other cleanups #44

PhilReedData · 2025-05-08T15:11:16Z

Replaces PR #39, addresses part of issue #42. Also adds external link icon eg Markdown {:.external} with inline SVG and CSS.

Homepage much cleaner, with clearly explained panels that change colour on mouse-over.

Get SEEK page also cleaner, replacing the 'About' top nav/sidebar item, with tiles.

Technical References renamed Technical Guide.

Simpler footer, less repetition.

Contacting Us page points users to the FAIRDOM Contact page.

Credits page is no longer in the menus.

Questions:

Is the choice of homepage tiles right?
Is the About text on the homepage right? I rewrote the Demo bit and added the In Use bit for context.
Does the credits page need to be reproduced on another site? Or is its presence in the repo good enough?
Does DataHub need the credits page? (They could re-add it to the footer menu.)
Does the Roadmap belong on a documentation site? Should it be relocated to the SEEK Website? Elsewhere?
Is the external link icon okay? If so, I will apply it across the whole site (currently only on the more 'surface' level pages).
What should we do with the Useful Links page? It is still in the footer. Is it that important to be accessed from footer of every page?
Are there any other pages to (re)include in the footer?
Is the homepage title "Welcome to the FAIRDOM-SEEK Documentation" okay? Suggested by Munazah.

PhilReedData · 2025-05-08T15:14:48Z

Home page panels use Bootstrap grid, they reflow on narrower screens.

Similar for the Get SEEK page, the new tiles.

stuzart

no need to manually add the .external class, which is error prone, and also remove text about virtual machines

stuzart · 2025-05-09T13:07:53Z

_sass/_custom_classes.scss

+//   content: "↗️";
+//}
+/* Add an indicator after external links that'll open in a new window. */
+.external::after {


depending on what version of boostrap we're using, might be able to use the glyphicon-new-window, content: '\e164', or import them separately.

https://github.com/twbs/bootstrap-sass/blob/master/assets/stylesheets/bootstrap/_glyphicons.scss#L202

if it doesn't work leave it like this

I tried, I couldn't get these classes to show any icons (glyphicon-new-window or related).

We have Bootstrap 5.3.3 (the latest ETT version, anyway). Strangely I can get some new features to work (eg link-opacity) but not icon-link. https://getbootstrap.com/docs/5.3/helpers/icon-link/

stuzart · 2025-05-09T13:10:26Z

contacting-us.md


-## Contact FAIRDOM
+For any questions and suggestions related to FAIRDOM projects, tools, standards and events please visit the [FAIRDOM contact us page](https://fair-dom.org/contact){:.external}.


there is some javascript that detects external links that should open in a new window. This could add the .external class for consistency - https://github.com/seek4science/seek-documentation/blob/main/assets/js/main.js#L19

That's much better. I've now replaced all the explicit mention of .external with one more line of javascript that adds the class where you suggested.

stuzart · 2025-05-09T13:12:33Z

index.md

    <div class="col d-grid">
-        <a role="button" class="btn py-3 fs-4 section-title" href="{{ site.baseurl }}/help/user-guide/api"><b>API Introduction</b></a>
+        <a role="button" class="btn py-3 fs-4 section-title" href="{{ site.baseurl }}/get-seek"><h3 class=""><i class="fa-solid fa-magnifying-glass-chart fa-1x"></i> Get FAIRDOM-SEEK</h3>
+        <p>Find out how to install FAIRDOM-SEEK on your own machine or as a virtual machine.</p>


drop the text or as a virtual machine

kdp-cloud

It looks very nice! I just added a couple of remarks, mainly on the home page and contact-us page.

kdp-cloud · 2025-05-12T05:56:56Z

index.md

@@ -1,85 +1,48 @@
 ---
 sidebar: false
-title: FAIRDOM-SEEK Documentation
+title: Welcome to the FAIRDOM-SEEK Documentation


I'm not a big fan of the long title. On a mobile screen, it becomes easily a two line title.

kdp-cloud · 2025-05-12T05:58:50Z

index.md

-<i class="fa-solid fa-flask-vial fa-1x"></i> <i class="fa-solid fa-magnifying-glass-chart fa-1x"></i>
- About FAIRDOM-SEEK
-</h2>
+## About FAIRDOM-SEEK


I would remove the subtitle. I think it's fine if this paragraph is directly folowing the site title.

Suggested change

## About FAIRDOM-SEEK

I agree, it would look better without this subtitle. The consequence is that the page navigation (right side) becomes just one item, 'Getting started' (or whatever text we change that subheading to). Is that okay?

Alternative, remove both subheadings... but then the page becomes full width, no left sidebar, no right page nav. I think we need something on one side. Any other ideas, anybody?

kdp-cloud · 2025-05-12T06:09:08Z

contacting-us.md

 redirect_from: "/contacting_us.html"
 ---

-<i class="fa-solid fa-envelopes-bulk fa-5x"></i>
+We have a number of ways you can contact us.


I think there's too little content on this topic to have its own page. Can we incorporate this on another page? Maybe the Home page? Or maybe the user guide's index page, under 'Contributing'?

Let's see... Currently, we have a link to the contact-us page in the following places:

Footer on every page

help/user-guide/create-sample-type

tech/contributing

tech/contributing-to-seek

tech/reporting-bugs-and-features

tech/contributing-to-pages

cookies.html

...and the contact-us page itself

And the contact-us page in this PR contains two blocks:

Contact the FAIRDOM community --> fair-dom.org/contact

Report bugs and feature requests --> tech/reporting-bugs-and-features

The second block is circular and may be unnecessary, so yes, maybe we can just have the first block somewhere else. I think the most suitable place is tech/contributing since we already have a little more overlap there (the email address is repeated, for example). So how would that look?

Page Change

Footer on every page replace link to fair-dom.org/contact

help/user-guide/create-sample-type replace link to fair-dom.org/contact

tech/contributing add paragraph and link to fair-dom.org/contact

tech/contributing-to-seek replace link to fair-dom.org/contact

tech/reporting-bugs-and-features replace link to fair-dom.org/contact

tech/contributing-to-pages replace link to fair-dom.org/contact

cookies.html Page to be removed

contact-us Page redirect to fair-dom.org/contact

I'm going back and forth a bit with this one! Perhaps discuss at tech call? (Sorry I can't be there this week, I'm in Scotland). I would prefer to have this decided/agreed before I do the work.

floradanna · 2025-05-12T15:43:51Z

Is the choice of homepage tiles right?
Is the About text on the homepage right? I rewrote the Demo bit and added the In Use bit for context.

Mostly OK for me. Just one remark: for "Getting FAIRDOM-SEEK". The tile description only mentions how to install the software, while the actual page then also tells you that you can use a deployed instance; it needs to be coherent. Then about this, the sentence should be just "... use one of the public instance + link to https://fair-dom.org/fairdom-in-use/ " (no specific mention of FAIRDOMHub).

Does the credits page need to be reproduced on another site? Or is its presence in the repo good enough?

I am not sure. It seems a bit of a mix of things SEEK uses (java tools...) and projects that use SEEK (WorkflowHub). It seems to belong to the FAIRDOM-SEEK website or in About FAIRDOM-SEEK.

Does DataHub need the credits page? (They could re-add it to the footer menu.)

Since all DataHub development is in FAIRDOM-SEEK, I'd say we would not need a custom credit page, we can use the FAIRDOM-SEEK one. For listing projects that use FAIRDOM-SEEK as DataHub, we would use the FAIRDOM website or DataHub About page or something.

Does the Roadmap belong on a documentation site? Should it be relocated to the SEEK Website? Elsewhere?

The FAIRDOM-SEEK website seems the most appropriate place. Maybe having a link to that from this doc.

Is the external link icon okay? If so, I will apply it across the whole site (currently only on the more 'surface' level pages).

OK

What should we do with the Useful Links page? It is still in the footer. Is it that important to be accessed from footer of every page?

I do not think so. Useful links sound like "miscellaneous", so not very important. Could this links be placed in the right sections? Or maybe Quick start or something, somewhere. Not sure.

Are there any other pages to (re)include in the footer?

There are many internal links to the documentation. Maybe a link to the SEEK GitHub repo or SEEK slack channel?

Is the homepage title "Welcome to the FAIRDOM-SEEK Documentation" okay? Suggested by Munazah.

Maybe a bit too long. FAIRDOM-SEEK Documentation should be enough.

floradanna · 2025-05-12T16:27:10Z

In general, when in doubts we could go back to the purpose of each resource:

FAIRDOM-SEEK = SEEK4Science = software website: to promote the software, build trust, and convince users to adopt and/or contribute to it (purpose, benefits, features, how to cite it, links to installation guide, demo, contribute-governance etc)
FAIR-DOM = an extended "About us of FAIRDOM-SEEK" (about the team, mission, history, impact, join etc)
FAIRDOM-SEEK Documentation = info on how to install (for developers), configure (for admins), use (user guide) and troubleshoot, Contributing Docs etc

PhilReedData added 7 commits May 8, 2025 10:21

Footer- reduce items

67cd6f3

remove graphics from page tops

4dab2cb

rename Technical Reference to Technical Guide

d3b9aa6

Update contact and credit pages

bd9e4a6

remove the About sidebar, update Get SEEK

ec0bd94

Refreshed home page

e9a3d4f

Add icon for external links

0624b9a

PhilReedData requested review from stuzart and kdp-cloud May 8, 2025 15:11

PhilReedData mentioned this pull request May 8, 2025

Revamp Home; Remove About sidebar; Redirect contact and get pages #39

Closed

Improve Get SEEK tiles design

6149eaf

stuzart requested changes May 9, 2025

View reviewed changes

kdp-cloud requested changes May 12, 2025

View reviewed changes

PhilReedData added 4 commits May 12, 2025 08:14

Remove VM from tile on homepage

f9aed55

Take out "welcome to", overly long homepage title (esp on mobile)

340ba65

Remove about sidebar from (obsolete) cookies page

55264f3

Replace explicit external link in MD with JS line

aba4137

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New homepage, get-seek page, no About menu, new external link icon, other cleanups #44

New homepage, get-seek page, no About menu, new external link icon, other cleanups #44

PhilReedData commented May 8, 2025 •

edited

Loading

PhilReedData commented May 8, 2025 •

edited

Loading

stuzart left a comment

stuzart May 9, 2025

PhilReedData May 12, 2025

stuzart May 9, 2025

PhilReedData May 12, 2025

stuzart May 9, 2025

kdp-cloud left a comment

kdp-cloud May 12, 2025

kdp-cloud May 12, 2025

PhilReedData May 12, 2025

kdp-cloud May 12, 2025

PhilReedData May 12, 2025 •

edited

Loading

floradanna commented May 12, 2025

floradanna commented May 12, 2025


		## Contact FAIRDOM
		For any questions and suggestions related to FAIRDOM projects, tools, standards and events please visit the [FAIRDOM contact us page](https://fair-dom.org/contact){:.external}.

Page	Change
Footer on every page	replace link to `fair-dom.org/contact`
`help/user-guide/create-sample-type`	replace link to `fair-dom.org/contact`
`tech/contributing`	add paragraph and link to `fair-dom.org/contact`
`tech/contributing-to-seek`	replace link to `fair-dom.org/contact`
`tech/reporting-bugs-and-features`	replace link to `fair-dom.org/contact`
`tech/contributing-to-pages`	replace link to `fair-dom.org/contact`
`cookies.html`	Page to be removed
`contact-us`	Page redirect to `fair-dom.org/contact`

New homepage, get-seek page, no About menu, new external link icon, other cleanups #44

Are you sure you want to change the base?

New homepage, get-seek page, no About menu, new external link icon, other cleanups #44

Conversation

PhilReedData commented May 8, 2025 • edited Loading

PhilReedData commented May 8, 2025 • edited Loading

stuzart left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kdp-cloud left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

PhilReedData May 12, 2025 • edited Loading

Choose a reason for hiding this comment

floradanna commented May 12, 2025

floradanna commented May 12, 2025

PhilReedData commented May 8, 2025 •

edited

Loading

PhilReedData commented May 8, 2025 •

edited

Loading

PhilReedData May 12, 2025 •

edited

Loading