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

Jekyll Conversion #42

Merged
merged 25 commits into from
Sep 1, 2023
Merged

Jekyll Conversion #42

merged 25 commits into from
Sep 1, 2023

Conversation

finglis
Copy link
Contributor

@finglis finglis commented Aug 31, 2023

Conversion of the current landing page to Jekyll.
This involves extracting the main content from the html to markdown files.

Things that need sorted before merge:
done - QA links (by me)
done - README- Should I add instructions/navigation of where to find what in the folder structure for future people looking to edit something? additionally full running local reqs?
done - License - this is currently the autogenerated. Name needs changed and content checked - I'm not sure if this is the correct one.

Side notes:
The plug-in folder containing liquify can be deleted since liquify isn't supported in github pages but could potentially one day.
Should we want a content file for each component on the page it would require a _data folder to store these and the files inside cant be .md (yml, JSON etc supported though).

@alanocallaghan
Copy link
Contributor

Should I add instructions/navigation of where to find what in the folder structure for future people looking to edit something?

General layout would be good, but it would probably suffice to say this is a jekyll site and link to the docs wherever they discuss folder structure.

additionally full running local reqs?

Possibly good to link people to rbenv or rvm (though I've developed a strong dislike of rvm) at least, once you have a decently new version of ruby then bundler should take over. Having said that the jekyll docs describe a way of setting up that I would definitely not recommend so maybe best to be more detailed.

@finglis
Copy link
Contributor Author

finglis commented Aug 31, 2023

As someone who has followed the Jekyll documentation to set up then I am possibly not the best person to advise there... but I've updated the README with notes on rbenv and rvm should people care about their ruby set up. Any edits welcome.

@finglis
Copy link
Contributor Author

finglis commented Aug 31, 2023

Ready to merge otherwise as I've sorted the other things on the todo list that I can do now...

I need to check the js script to detect users platform is correct which is more a test of github pages responding to the new structure so to be done after merge.

@alanocallaghan
Copy link
Contributor

Worth saying I just looked at the ubuntu instructions for ruby, I think the windows and macos ones looked fairly sensible

@alanocallaghan
Copy link
Contributor

alanocallaghan commented Aug 31, 2023

The commented header include itself includes a comment, so you get the tail end of a comment under the top release banner. If I click the X on the top banner I see a "-->" in the middle of the page. I'd tend towards removing unused includes rather than commenting them out.

Running htmlproofer I see a bunch of broken links, mostly from missing/empty variables.

For the Links check, the following failures were found:

* At ./_site/index.html:65:

  'a' tag is missing a reference (this is the default download link, from page.download_button_default)

* At ./_site/index.html:96:

  'a' tag is missing a reference (this is the release notes, from page.latest_releases_version)

* At ./_site/index.html:159: 
 
  'a' tag is missing a reference (left button)

* At ./_site/index.html:160:

  'a' tag is missing a reference (right button)

For the Links > External check, the following failures were found:

* At ./_site/index.html:131:

  External link https://twitter.com/petebankhead/status/1295965136646176768?s=20%20t=ETG2R8JKrhtT-kSZdW-Cnw failed (status code 302)

* At ./_site/index.html:226:

  External link https://twitter.com/qupath failed (status code 302)


HTML-Proofer found 6 failures!

Lines 159 and 160 are for the slide navigation buttons; I don't know enough HTML to make a dropin replacement for the a tags, but if I make them buttons it looks okay, and with a bit of CSS should look fine?

Can ignore the twitter errors, probably just trying to redirect to x.com or something insane like that

Gemfile Outdated Show resolved Hide resolved
Gemfile Outdated Show resolved Hide resolved
assets/js/main.js Outdated Show resolved Hide resolved
qupath.github.io.gemspec Outdated Show resolved Hide resolved
_includes/header.html Outdated Show resolved Hide resolved
Copy link
Contributor

@alanocallaghan alanocallaghan left a comment

Choose a reason for hiding this comment

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

Just need webrick to run a server, otherwise looks great

Gemfile Show resolved Hide resolved
@alanocallaghan alanocallaghan mentioned this pull request Sep 1, 2023
Copy link
Member

@petebankhead petebankhead left a comment

Choose a reason for hiding this comment

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

Looks good!

@petebankhead petebankhead merged commit 463af3e into qupath:main Sep 1, 2023
@finglis finglis deleted the Jekyll-update branch December 13, 2023 16:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants