From e8f224c1beeb0f73725571debc88dd035b279a4f Mon Sep 17 00:00:00 2001 From: George <31376482+george-gca@users.noreply.github.com> Date: Fri, 17 May 2024 10:45:29 -0300 Subject: [PATCH 1/4] Changing Gemfile now triggers page build --- .github/workflows/deploy.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 4979e3efa96b..1c196258b156 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -12,6 +12,8 @@ on: - "**.liquid" - "**/*.md" - "**.yml" + - "Gemfile" + - "Gemfile.lock" - "!.github/workflows/axe.yml" - "!.github/workflows/broken-links.yml" - "!.github/workflows/deploy-docker-tag.yml" @@ -36,6 +38,8 @@ on: - "**.liquid" - "**/*.md" - "**.yml" + - "Gemfile" + - "Gemfile.lock" - "!.github/workflows/axe.yml" - "!.github/workflows/broken-links.yml" - "!.github/workflows/deploy-docker-tag.yml" From 066fc099bb110e9de5126ed3afc6bdf089ff39a9 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Fri, 17 May 2024 10:58:14 -0300 Subject: [PATCH 2/4] Bump rexml from 3.2.6 to 3.2.8 (#2423) Bumps [rexml](https://github.com/ruby/rexml) from 3.2.6 to 3.2.8.
Release notes

Sourced from rexml's releases.

REXML 3.2.8 - 2024-05-16

Fixes

REXML 3.2.7 - 2024-05-16

Improvements

Fixes

... (truncated)

Changelog

Sourced from rexml's changelog.

3.2.8 - 2024-05-16 {#version-3-2-8}

Fixes

3.2.7 - 2024-05-16 {#version-3-2-7}

Improvements

Fixes

... (truncated)

Commits

[![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=rexml&package-manager=bundler&previous-version=3.2.6&new-version=3.2.8)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) ---
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) You can disable automated security fix PRs for this repo from the [Security Alerts page](https://github.com/alshedivat/al-folio/network/alerts).
Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- Gemfile.lock | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/Gemfile.lock b/Gemfile.lock index edd35f318e66..48c266a996ec 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -166,7 +166,8 @@ GEM rb-fsevent (0.11.2) rb-inotify (0.10.1) ffi (~> 1.0) - rexml (3.2.6) + rexml (3.2.8) + strscan (>= 3.0.9) rouge (4.2.1) safe_yaml (1.0.5) sass-embedded (1.77.0-aarch64-linux-gnu) @@ -174,6 +175,7 @@ GEM sass-embedded (1.77.0-x86_64-linux-gnu) google-protobuf (>= 3.25, < 5.0) sax-machine (1.3.2) + strscan (3.1.0) terminal-table (3.0.2) unicode-display_width (>= 1.1.1, < 3) tzinfo (2.0.6) From d2853f28280657405a1383a2cda0fe28513ab93e Mon Sep 17 00:00:00 2001 From: George <31376482+george-gca@users.noreply.github.com> Date: Fri, 17 May 2024 13:33:02 -0300 Subject: [PATCH 3/4] Added lsi option to _config.yml --- _config.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/_config.yml b/_config.yml index 4f3a456326da..7e82abb6afda 100644 --- a/_config.yml +++ b/_config.yml @@ -130,6 +130,7 @@ bing_site_verification: # out your bing-site-verification ID (Bing Webmaster) blog_name: al-folio # blog_name will be displayed in your blog page blog_description: a simple whitespace theme for academics permalink: /blog/:year/:title/ +lsi: true # produce an index for related posts # Pagination pagination: From 8fe4bee5e6d241b80cbacc5183bfb3ca505b4f23 Mon Sep 17 00:00:00 2001 From: George <31376482+george-gca@users.noreply.github.com> Date: Fri, 17 May 2024 14:19:02 -0300 Subject: [PATCH 4/4] Remove lsi command (#2428) Removed lsi command from code since it was added to _config.yml --------- Signed-off-by: George Araujo --- .github/workflows/axe.yml | 2 +- .github/workflows/broken-links-site.yml | 2 +- .github/workflows/deploy.yml | 2 +- CUSTOMIZE.md | 2 +- FAQ.md | 2 +- INSTALL.md | 10 +++++----- bin/cibuild | 2 +- bin/deploy | 2 +- 8 files changed, 12 insertions(+), 12 deletions(-) diff --git a/.github/workflows/axe.yml b/.github/workflows/axe.yml index a745c7dc9bed..46d117fdb39e 100644 --- a/.github/workflows/axe.yml +++ b/.github/workflows/axe.yml @@ -45,7 +45,7 @@ jobs: run: | pip3 install --upgrade jupyter export JEKYLL_ENV=production - bundle exec jekyll build --lsi + bundle exec jekyll build - name: Purge unused CSS 🧹 run: | npm install -g purgecss diff --git a/.github/workflows/broken-links-site.yml b/.github/workflows/broken-links-site.yml index fae797c8977f..d85270fefced 100644 --- a/.github/workflows/broken-links-site.yml +++ b/.github/workflows/broken-links-site.yml @@ -33,7 +33,7 @@ jobs: run: | pip3 install --upgrade jupyter export JEKYLL_ENV=production - bundle exec jekyll build --lsi + bundle exec jekyll build - name: Purge unused CSS 🧹 run: | npm install -g purgecss diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 1c196258b156..046ee0de770b 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -81,7 +81,7 @@ jobs: run: | pip3 install --upgrade jupyter export JEKYLL_ENV=production - bundle exec jekyll build --lsi + bundle exec jekyll build - name: Purge unused CSS 🧹 run: | npm install -g purgecss diff --git a/CUSTOMIZE.md b/CUSTOMIZE.md index 19c260a109c3..7c63511904f7 100644 --- a/CUSTOMIZE.md +++ b/CUSTOMIZE.md @@ -40,7 +40,7 @@ The configuration file [\_config.yml](_config.yml) contains the main configurati > Note that the `url` and `baseurl` settings are used to generate the links of the website, as explained in the [install instructions](INSTALL.md). -All changes made to this file are only visible after you rebuild the website. That means that you need to run `bundle exec jekyll serve --lsi` again if you are running the website locally or push your changes to GitHub if you are using GitHub Pages. All other changes are visible immediately, you only need to refresh the page. +All changes made to this file are only visible after you rebuild the website. That means that you need to run `bundle exec jekyll serve` again if you are running the website locally or push your changes to GitHub if you are using GitHub Pages. All other changes are visible immediately, you only need to refresh the page. ## Modifying the CV information diff --git a/FAQ.md b/FAQ.md index 8ce3ef1dbda8..d6faca56df53 100644 --- a/FAQ.md +++ b/FAQ.md @@ -40,7 +40,7 @@ Make sure to correctly specify the `url` and `baseurl` paths in `_config.yml`. R #### My site doesn't work when I enable `related_blog_posts`. Why? -This is probably due to the [classifier reborn](https://github.com/jekyll/classifier-reborn) plugin, which is used to calculate related posts. If the error states `Liquid Exception: Zero vectors can not be normalized...` or `sqrt': Numerical argument is out of domain - "sqrt"`, it means that it could not calculate related posts for a specific post. This is usually caused by [empty or minimal blog posts](https://github.com/jekyll/classifier-reborn/issues/64) without meaningful words (i.e. only [stop words](https://en.wikipedia.org/wiki/Stop_words)) or even [specific characters](https://github.com/jekyll/classifier-reborn/issues/194) you used in your posts. Also, the calculus for similar posts are made for every `post`, which means every page that uses `layout: post`, including the announcements. To change this behavior, simply add `related_posts: false` to the front matter of the page you don't want to display related posts on. Another solution is to disable the lsi (latent semantic indexing) entirely by removing the `--lsi` flag in the code. Related issue: [#1828](https://github.com/alshedivat/al-folio/issues/1828). +This is probably due to the [classifier reborn](https://github.com/jekyll/classifier-reborn) plugin, which is used to calculate related posts. If the error states `Liquid Exception: Zero vectors can not be normalized...` or `sqrt': Numerical argument is out of domain - "sqrt"`, it means that it could not calculate related posts for a specific post. This is usually caused by [empty or minimal blog posts](https://github.com/jekyll/classifier-reborn/issues/64) without meaningful words (i.e. only [stop words](https://en.wikipedia.org/wiki/Stop_words)) or even [specific characters](https://github.com/jekyll/classifier-reborn/issues/194) you used in your posts. Also, the calculus for similar posts are made for every `post`, which means every page that uses `layout: post`, including the announcements. To change this behavior, simply add `related_posts: false` to the front matter of the page you don't want to display related posts on. Another solution is to disable the lsi (latent semantic indexing) entirely by setting the `lsi` flag to `false` in `_config.yml`. Related issue: [#1828](https://github.com/alshedivat/al-folio/issues/1828). #### When trying to deploy, it's asking for github login credentials, which github disabled password authentication and it exits with an error. How to fix? diff --git a/INSTALL.md b/INSTALL.md index 62ec84ade031..8b3992083bbc 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -3,8 +3,8 @@ - [Table of Contents](#table-of-contents) - [Installing and Deploying](#installing-and-deploying) - [Recommended Approach](#recommended-approach) - - [Local Setup on Windows](#local-setup-on-windows) - - [Local Setup using Docker (Recommended)](#local-setup-using-docker-recommended) + - [Local setup on Windows](#local-setup-on-windows) + - [Local setup using Docker (Recommended)](#local-setup-using-docker-recommended) - [Build your own docker image](#build-your-own-docker-image) - [Local Setup with Development Containers](#local-setup-with-development-containers) - [Local Setup (Legacy, no longer supported)](#local-setup-legacy-no-longer-supported) @@ -91,7 +91,7 @@ Assuming you have [Ruby](https://www.ruby-lang.org/en/downloads/) and [Bundler]( $ bundle install # assuming pip is your Python package manager $ pip install jupyter -$ bundle exec jekyll serve --lsi +$ bundle exec jekyll serve ``` To see the template running, open your browser and go to `http://localhost:4000`. You should see a copy of the theme's [demo website](https://alshedivat.github.io/al-folio/). Now, feel free to customize the theme however you like. After you are done, remember to **commit** your final changes. @@ -135,7 +135,7 @@ If you need to manually re-deploy your website to GitHub pages, go to Actions, c If you decide to not use GitHub Pages and host your page elsewhere, simply run: ```bash -$ bundle exec jekyll build --lsi +$ bundle exec jekyll build ``` which will (re-)generate the static webpage in the `_site/` folder. @@ -163,7 +163,7 @@ Firstly, from the deployment repo dir, checkout the git branch hosting your publ Then from the website sources dir (commonly your al-folio fork's clone): ```bash -$ bundle exec jekyll build --lsi --destination $HOME/repo/publishing-source +$ bundle exec jekyll build --destination $HOME/repo/publishing-source ``` This will instruct jekyll to deploy the website under `$HOME/repo/publishing-source`. diff --git a/bin/cibuild b/bin/cibuild index 14cfabea577c..d5c9e1956fe7 100755 --- a/bin/cibuild +++ b/bin/cibuild @@ -1 +1 @@ -bundle exec jekyll build --lsi +bundle exec jekyll build diff --git a/bin/deploy b/bin/deploy index 0bf8ed538e63..c72abbcc6474 100755 --- a/bin/deploy +++ b/bin/deploy @@ -93,7 +93,7 @@ git checkout -b $DEPLOY_BRANCH export JEKYLL_ENV=production # Build site -bundle exec jekyll build --lsi +bundle exec jekyll build # Purge unused css purgecss -c purgecss.config.js