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

[dep] Upgrade theme to 0.5.4 #2243

Merged
merged 27 commits into from
Jul 26, 2023
Merged

[dep] Upgrade theme to 0.5.4 #2243

merged 27 commits into from
Jul 26, 2023

Conversation

@usta
Copy link
Member

usta commented Jan 8, 2023

@usta
Copy link
Member

usta commented Jan 8, 2023

btw congratz 👍 💯 🥇 🎉
image

@captn3m0
Copy link
Member Author

captn3m0 commented Feb 1, 2023

Updated the PR for RC4.0 (pushing in a bit)

Main changes:

Profile Measurements for RC4:

Build Process Summary:

PHASE TIME
RESET 0.0001
READ 0.2233
GENERATE 0.0003
RENDER 11.1685
CLEANUP 0.0368
WRITE 0.1094

Site Render Stats:

Filename Count Bytes Time
vendor/bundle/ruby/3.0.0/gems/just-the-docs-0.4.0.rc4/_layouts/default.html 201 11277.72K 8.237
vendor/bundle/ruby/3.0.0/gems/just-the-docs-0.4.0.rc4/_includes/head.html 201 1487.11K 4.534
vendor/bundle/ruby/3.0.0/gems/just-the-docs-0.4.0.rc4/_includes/components/sidebar.html 201 6889.12K 3.580
_includes/nav.html 201 6779.39K 2.607
_layouts/product.html 198 1693.86K 1.555
_includes/head_custom.html 201 1192.85K 0.729
sitemap.xml 1 61.40K 0.245
assets/js/zzzz-search-data.json 1 226.56K 0.062
vendor/bundle/ruby/3.0.0/gems/just-the-docs-0.4.0.rc4/_includes/vendor/anchor_headings.html 201 1764.98K 0.057
vendor/bundle/ruby/3.0.0/gems/just-the-docs-0.4.0.rc4/_includes/components/header.html 201 251.45K 0.022
_redirects 1 38.40K 0.017
_includes/ltslabel.html 2125 13.09K 0.017
vendor/bundle/ruby/3.0.0/gems/just-the-docs-0.4.0.rc4/_layouts/table_wrappers.html 201 11285.79K 0.015
vendor/bundle/ruby/3.0.0/gems/just-the-docs-0.4.0.rc4/_includes/icons/icons.html 201 796.54K 0.014
_headers 1 83.35K 0.011
vendor/bundle/ruby/3.0.0/gems/just-the-docs-0.4.0.rc4/_includes/components/aux_nav.html 201 149.77K 0.009
vendor/bundle/ruby/3.0.0/gems/just-the-docs-0.4.0.rc4/_includes/components/search_header.html 201 86.96K 0.006
vendor/bundle/ruby/3.0.0/gems/just-the-docs-0.4.0.rc4/_includes/components/footer.html 201 0.39K 0.005
vendor/bundle/ruby/3.0.0/gems/just-the-docs-0.4.0.rc4/_includes/components/breadcrumbs.html 201 0.98K 0.002
vendor/bundle/ruby/3.0.0/gems/just-the-docs-0.4.0.rc4/_includes/title.html 201 3.73K 0.002
feed.xml 1 0.43K 0.002
vendor/bundle/ruby/3.0.0/gems/just-the-docs-0.4.0.rc4/_includes/search_placeholder_custom.html 201 4.32K 0.002
vendor/bundle/ruby/3.0.0/gems/just-the-docs-0.4.0.rc4/_includes/footer_custom.html 201 0.00K 0.001
vendor/bundle/ruby/3.0.0/gems/just-the-docs-0.4.0.rc4/_includes/components/search_footer.html 201 7.26K 0.001
_layouts/schema.html 1 1.79K 0.001
vendor/bundle/ruby/3.0.0/gems/just-the-docs-0.4.0.rc4/_includes/nav_footer_custom.html 201 0.00K 0.001
vendor/bundle/ruby/3.0.0/gems/just-the-docs-0.4.0.rc4/_includes/icons/code_copy.html 201 262.63K 0.001
assets/js/just-the-docs.js 1 16.12K 0.001
vendor/bundle/ruby/3.0.0/gems/just-the-docs-0.4.0.rc4/_includes/css/just-the-docs.scss.liquid 3 0.60K 0.001
_includes/variables.html 1 0.00K 0.001
vendor/bundle/ruby/3.0.0/gems/just-the-docs-0.4.0.rc4/_includes/icons/expand.html 201 71.65K 0.001
assets/css/just-the-docs-dark.scss 1 0.20K 0.001
vendor/bundle/ruby/3.0.0/gems/just-the-docs-0.4.0.rc4/_includes/header_custom.html 201 0.00K 0.001
vendor/bundle/ruby/3.0.0/gems/just-the-docs-0.4.0.rc4/_includes/icons/document.html 201 83.62K 0.000
vendor/bundle/ruby/3.0.0/gems/just-the-docs-0.4.0.rc4/_includes/css/callouts.scss.liquid 3 0.17K 0.000
vendor/bundle/ruby/3.0.0/gems/just-the-docs-0.4.0.rc4/_includes/icons/link.html 201 89.70K 0.000
vendor/bundle/ruby/3.0.0/gems/just-the-docs-0.4.0.rc4/_includes/icons/menu.html 201 84.80K 0.000
vendor/bundle/ruby/3.0.0/gems/just-the-docs-0.4.0.rc4/_includes/icons/external_link.html 201 106.00K 0.000
vendor/bundle/ruby/3.0.0/gems/just-the-docs-0.4.0.rc4/_includes/icons/search.html 201 78.12K 0.000
CONTRIBUTING.md 1 17.82K 0.000
manifest.json 1 0.54K 0.000
assets/css/just-the-docs-default.scss 1 0.20K 0.000
browserconfig.xml 1 0.27K 0.000
assets/css/just-the-docs-light.scss 1 0.20K 0.000
_layouts/page.html 3 45.79K 0.000
products/ubuntu.md 1 1.90K 0.000
vendor/bundle/ruby/3.0.0/gems/just-the-docs-0.4.0.rc4/_includes/js/custom.js 1 0.00K 0.000
vendor/bundle/ruby/3.0.0/gems/just-the-docs-0.4.0.rc4/_includes/css/custom.scss.liquid 3 0.08K 0.000

@captn3m0 captn3m0 changed the title [dep] Upgrade theme to 0.4.0.rc3 [dep] Upgrade theme to 0.4.0.rc4 Feb 1, 2023
@captn3m0
Copy link
Member Author

captn3m0 commented Feb 1, 2023

logo change

Switched to a full-image logo to avoid hack from https://github.com/endoflife-date/endoflife.date/pull/1900/files#diff-763ac3523acb81380882833d64791adae805b37ea3429ea95cb44b8f5c439593

image

image

Favicon Fixes

Dropped the ICO file, and redirect to the PNG file instead.

@captn3m0
Copy link
Member Author

captn3m0 commented Feb 1, 2023

Dropping the nav.html slightly increases the build times:

Filename Count Bytes Time
vendor/bundle/ruby/3.0.0/gems/just-the-docs-0.4.0.rc4/_layouts/default.html 202 8139.78K 15.662
vendor/bundle/ruby/3.0.0/gems/just-the-docs-0.4.0.rc4/_includes/components/sidebar.html 202 3652.73K 10.658
vendor/bundle/ruby/3.0.0/gems/just-the-docs-0.4.0.rc4/_includes/nav.html 202 3469.86K 9.620
vendor/bundle/ruby/3.0.0/gems/just-the-docs-0.4.0.rc4/_includes/head.html 202 1517.41K 4.885
_layouts/product.html 199 1722.59K 1.731
_includes/head_custom.html 202 1209.83K 0.787
sitemap.xml 1 61.71K 0.336

It's a tax of 7 seconds, but we don't have to maintain our own nav.html.

@captn3m0 captn3m0 force-pushed the jtd-4.0 branch 2 times, most recently from 87fde4d to f34c39b Compare February 1, 2023 08:11
@captn3m0
Copy link
Member Author

captn3m0 commented Feb 1, 2023

The new blockquote styling looks good enough, I think:

image

image

It's not great on pages without an icon, but its okay.

@marcwrobel
Copy link
Member

@marcwrobel marcwrobel added dependencies Pull requests that update a dependency file ruby Pull requests that update Ruby code labels Feb 8, 2023
@marcwrobel marcwrobel changed the title [dep] Upgrade theme to 0.4.0.rc4 [dep] Upgrade theme to 0.4.0 Feb 19, 2023
@marcwrobel
Copy link
Member

@captn3m0, I rebased the branch against master, upgraded jtd to 0.4.0 and upgrade the dependencies.

I quickly checked the result after that and, appart for the 3 Sass warning when the site is build, so far it looks good.

@marcwrobel
Copy link
Member

marcwrobel commented Feb 19, 2023

With most of (all ?) the absolute links replaced by relative one in jtd 0.4.0, the context.deploy-preview command in netlify.toml may be useless now (did not test).

@marcwrobel marcwrobel changed the title [dep] Upgrade theme to 0.4.0 [dep] Upgrade theme to 0.4.1 Feb 24, 2023
@marcwrobel
Copy link
Member

Rebased against master and upgraded to jtd 0.4.1.

@captn3m0, I think it's good enough for being merged after an extensive review. Do you think some more work is needed ?

@captn3m0
Copy link
Member Author

captn3m0 commented Feb 24, 2023 via email

@marcwrobel marcwrobel marked this pull request as ready for review February 24, 2023 16:00
@marcwrobel
Copy link
Member

FYI I already did a quick review and didn't had anything to say.

The only thing I thought of was the build time increase, but from what I can see that can't be avoided without modifying the theme itself, so LGTM.

Copy link
Member Author

@captn3m0 captn3m0 left a comment

Choose a reason for hiding this comment

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

The build times are still on the higher side, but still manageable.
Going ahead and merging ✔️
Thanks a lot @marcwrobel for keeping at it.

@captn3m0 captn3m0 merged commit 552bd98 into master Jul 26, 2023
6 checks passed
@captn3m0 captn3m0 deleted the jtd-4.0 branch July 26, 2023 05:13
@marcwrobel marcwrobel mentioned this pull request Jul 30, 2023
@marcwrobel
Copy link
Member

marcwrobel commented Aug 1, 2023

Next minor version should fix the build time issue with just-the-docs/just-the-docs#1244. On my computer:

  • current jtd build time: 65s
  • next jtd build time: 45s
  • next jtd build time (without activation.scss.liquid): 20s

Test ran with the following modifications:

diff --git c/Gemfile i/Gemfile
index 406df285..e6a584c5 100644
--- c/Gemfile
+++ i/Gemfile
@@ -14,6 +14,8 @@ group :jekyll_plugins do
   gem 'jekyll-seo-tag'
   gem 'jekyll-last-modified-at'
   gem 'jemoji'
+  gem "jekyll-remote-theme"
+  gem "jekyll-include-cache"
 end
 
 # Windows does not include zoneinfo files, so bundle the tzinfo-data gem
diff --git c/Gemfile.lock i/Gemfile.lock
index 3ae1e94c..3cc841d0 100644
--- c/Gemfile.lock
+++ i/Gemfile.lock
@@ -46,9 +46,16 @@ GEM
       webrick (~> 1.7)
     jekyll-feed (0.17.0)
       jekyll (>= 3.7, < 5.0)
+    jekyll-include-cache (0.2.1)
+      jekyll (>= 3.7, < 5.0)
     jekyll-last-modified-at (1.3.0)
       jekyll (>= 3.7, < 5.0)
       posix-spawn (~> 0.3.9)
+    jekyll-remote-theme (0.4.3)
+      addressable (~> 2.0)
+      jekyll (>= 3.5, < 5.0)
+      jekyll-sass-converter (>= 1.0, <= 3.0.0, != 2.0.0)
+      rubyzip (>= 1.3.0, < 3.0)
     jekyll-sass-converter (3.0.0)
       sass-embedded (~> 1.54)
     jekyll-seo-tag (2.8.0)
@@ -91,6 +98,7 @@ GEM
       ffi (~> 1.0)
     rexml (3.2.5)
     rouge (4.1.2)
+    rubyzip (2.3.2)
     safe_yaml (1.0.5)
     sass-embedded (1.64.1)
       google-protobuf (~> 3.23)
@@ -110,7 +118,9 @@ DEPENDENCIES
   icalendar (~> 2.7)
   jekyll (~> 4.3.2)
   jekyll-feed (~> 0.17)
+  jekyll-include-cache
   jekyll-last-modified-at
+  jekyll-remote-theme
   jekyll-seo-tag
   jekyll-timeago
   jemoji
diff --git c/_config.yml i/_config.yml
index 5751f3be..68a28b53 100644
--- c/_config.yml
+++ i/_config.yml
@@ -14,11 +14,13 @@ plugins:
   - jekyll-timeago
   - jekyll-seo-tag
   - jekyll-last-modified-at
+  - jekyll-remote-theme
+  - jekyll-include-cache
   - jemoji
 
 
 # just-the-docs settings, see https://just-the-docs.com/
-theme: just-the-docs
+remote_theme: pdmosses/just-the-docs@nav-fix
 nav_sort: case_insensitive
 
 # https://just-the-docs.com/docs/configuration/#search
diff --git c/_includes/css/activation.scss.liquid i/_includes/css/activation.scss.liquid
new file mode 100644
index 00000000..e69de29b

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file ruby Pull requests that update Ruby code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants