🔍 Map & Data Library tutorials search portal

This repository is the codebase for a javascript based website that serves as a search interface for the Map & Data Library Tutorials.

It is built using Jekyll and hosted on GitHub Pages.

🚀 Features

• Faceted search: Users can filter search results by categories such as software, topic, workshop series, etc.
• Data-driven: The tutorials data is stored in a YAML file, making it easy to update and maintain
• Responsive design: The site is designed to be responsive and works well on both desktop and mobile devices
• Static site: The site is a static site generated by Jekyll, allowing hosting on GitHub Pages for free
• Open source: The codebase is open source and available on GitHub

📄 Updating tutorials data

See the instructions for updating the tutorials data.

🏗️ Development

Site structure

• The main layout file is located at _layouts/minimal_search.html.
• The tutorials data is stored in the _data/guides.yml file.
• The site configuration is in the _config.yml file.
• The homepage is located at page.md and uses the minimal_search layout, powering the search interface.

Testing the site locally

To test the site locally, you need to have Ruby and Bundler installed.

1. Clone the repository:

git clone https://github.com/MDLutoronto/tutorials-search.git

2. Navigate to the repository directory:

cd tutorials-search

3. Install the dependencies and serve the site with live reload:

bundle install && bundle exec jekyll serve --livereload --port 4000

4. Open your web browser and go to http://localhost:4000/tutorials-search/ to view the site.

🐛 Deployment bug fix

If the deployment in GitHub Actions keeps looping the following messages:

...
Current status: deployment_queued
Getting Pages deployment status...
...

Unpublishing and republishing the site

A way to fix is is to go to the repository's Settings > Pages, unpublish the site by clicking the Unpublish site button, then republish it by clicking the Save button.

Changing the source temporarily

Another way to fix it is to change the source of the GitHub Pages deployment temporarily:

1. Cancel the current deployment if it's still in progress.
2. Go to the repository's Settings > Pages. Find the Source under the Build and deployment section, change it to Deploy from a branch
3. Wait for a few seconds, then change it back to GitHub Actions.
4. Retrigger the deployment by pushing a new commit, or re-running the workflow under the Actions > Deploy Jekyll site to Pages.

✏️ Author

Initial code developed by Ken Lui, Data Curation Specialist at the Map & Data Library at the University of Toronto.

📜 License

GNU GPLv3