From 2dc150abfc3219529ae9f3879762b8f18cbb0bb6 Mon Sep 17 00:00:00 2001 From: Ivan Mikheykin Date: Tue, 25 Apr 2023 17:32:46 +0300 Subject: [PATCH] fix: speedup docs development - Fix werf compose up. - Use jekyll_base image (as in werf/website). - Remove assets.precompile - lead to errors with updated Jekyll and sprockets. - Use include-cached plugin to render sidebar. - Change js to activate sidebar item. Signed-off-by: Ivan Mikheykin --- docs/DEVELOPMENT.md | 10 ++-- docs/Gemfile.lock | 2 +- docs/_config.yml | 1 + docs/_includes/sidebar.html | 7 ++- docs/_includes/sidebar_entry.html | 13 ++---- docs/_layouts/default.html | 15 ++++-- docs/_layouts/sidebar.html | 10 +++- docs/docker-compose.yml | 20 ++++---- docs/werf.yaml | 77 ++++++++++++++++++++----------- 9 files changed, 95 insertions(+), 60 deletions(-) diff --git a/docs/DEVELOPMENT.md b/docs/DEVELOPMENT.md index d7b272358d..204c88cdba 100644 --- a/docs/DEVELOPMENT.md +++ b/docs/DEVELOPMENT.md @@ -9,16 +9,20 @@ ___ #### Variant 1 -- Install [werf](http://werf.io/installation.html). +Run `jekyll serve` with --watch option to test changes in "real time". + +- Install [werf](http://werf.io/installation.html). - Run: ```shell - werf compose up + werf compose up jekyll_base --dev ``` -- Wait (approximately 60 seconds) for the message "Server running..." from the `en_1` and `ru_1` containers. +- Wait (approximately 60 seconds) for the message "done in X.XXX seconds" from the `docs-en-1` and `docs-ru-1` containers. - Check the English version is available on [https://localhost](http://localhost), and the Russian version on [http://ru.localhost](https://ru.localhost) (add `ru.localhost` record in your `/etc/hosts` to access the Russian version of the site). #### Variant 2 (slower) +Run fully built 'web' image. + - Install [werf](http://werf.io/installation.html). - Run (add `--follow --docker-compose-command-options="-d"` if necessary): ```shell diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock index 96b6fe2d0c..e42b01283d 100644 --- a/docs/Gemfile.lock +++ b/docs/Gemfile.lock @@ -49,7 +49,7 @@ GEM typhoeus (~> 1.3) yell (~> 2.0) http_parser.rb (0.8.0) - i18n (1.12.0) + i18n (1.13.0) concurrent-ruby (~> 1.0) jekyll (4.3.2) addressable (~> 2.4) diff --git a/docs/_config.yml b/docs/_config.yml index fdbd9d4874..89ba94e8a8 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -45,6 +45,7 @@ highlighter: rouge plugins: - jekyll-assets + - jekyll-include-cache markdown: kramdown kramdown: diff --git a/docs/_includes/sidebar.html b/docs/_includes/sidebar.html index 6d63d7ca37..ef23dd4123 100644 --- a/docs/_includes/sidebar.html +++ b/docs/_includes/sidebar.html @@ -1,13 +1,12 @@ -{%- assign sidebar = site.data.sidebars[page.sidebar].entries[page.lang] %} +{%- assign sidebar = site.data.sidebars[include.sidebar].entries[include.lang] %} +
- - diff --git a/docs/_includes/sidebar_entry.html b/docs/_includes/sidebar_entry.html index fa7e892b54..a52e32ab4d 100644 --- a/docs/_includes/sidebar_entry.html +++ b/docs/_includes/sidebar_entry.html @@ -1,14 +1,13 @@ {%- assign entry = include.entry %} {%- assign folder_entry_class = include.folder_entry_class %} {%- assign item_entry_class = include.item_entry_class %} -{%- assign data_attr = include.data_attr %} {%- if entry.hot == true %} {%- assign item_entry_class = item_entry_class | append: ' sidebar__item_hot' %} {%- endif %} {%- if entry.f %} -
  • +
  • {{ entry.title }}{{ entry.url }}
      {%- for entry in entry.f %} @@ -18,12 +17,8 @@ {%- elsif entry.external_url %}
    • {{entry.title}}
      • -{%- elsif page.url == entry.url %} -
    • {{entry.title}}
      • +{%- elsif include.is_404 %} +
    • {{entry.title}}
      • {%- else %} - {%- if page.name == '404.md' %} -
    • {{entry.title}}
      • - {% else %} -
    • {{entry.title}}
      • - {%- endif %} +
    • {{entry.title}}
      • {%- endif %} diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html index 4434e3ff3c..e42ff194b1 100644 --- a/docs/_layouts/default.html +++ b/docs/_layouts/default.html @@ -31,11 +31,15 @@ $("#mysidebar").navgoco('toggle', true); }); - const parents = $('[data-parent]'); - - parents.each((_, parent) => { - $("#mysidebar").navgoco('toggle', true, $($(parent).children('[data-index]')).attr('data-index')); - }) + // Activate page item in sidebar and expands its ancestors. + let page_url='{{ page.url }}'; + let active_item = $(`#mysidebar li[data-page-url="${page_url}"]`); + active_item.addClass('active'); + active_item.parents('li') + .addClass('active') + .each((_, parent) => { + $("#mysidebar").navgoco('toggle', true, $($(parent).children('[data-index]')).attr('data-index')); + }); }); @@ -44,6 +48,7 @@ $('[data-toggle="tooltip"]').tooltip() }) + {%- if page.datatable == true %} diff --git a/docs/_layouts/sidebar.html b/docs/_layouts/sidebar.html index 6bbc6b0bc3..c10bdd0a20 100644 --- a/docs/_layouts/sidebar.html +++ b/docs/_layouts/sidebar.html @@ -6,7 +6,15 @@ {%- include nav-breadcrumbs.html %}
      - {%- include sidebar.html %} + {% comment %} Use page relative path for caching: ../.. or ../../.. {% endcomment %} + {%- assign page_rel_path = "/" %} + {%- assign is_404 = false %} + {%- if page.name == '404.md' %} + {%- assign is_404 = true %} + {%- else %} + {%- assign page_rel_path = page.url | true_relative_url | remove: page.url %} + {%- endif %} + {%- include_cached sidebar.html sidebar=page.sidebar lang=page.lang is_404=is_404 page_rel_path=page_rel_path %}
      {{ content }} diff --git a/docs/docker-compose.yml b/docs/docker-compose.yml index 50669f036c..ce3278d770 100644 --- a/docs/docker-compose.yml +++ b/docs/docker-compose.yml @@ -2,25 +2,25 @@ version: "3.9" services: en: - image: $WERF_ASSETS_DOCKER_IMAGE_NAME - working_dir: "/srv/jekyll-data" + image: $WERF_JEKYLL_BASE_DOCKER_IMAGE_NAME + working_dir: "/app" environment: JEKYLL_ENV: "dev" command: bash -c " - chmod -R o+w /srv/jekyll-data/ && - jekyll serve --disable-disk-cache --config _config.yml --destination /tmp/_site -P 80" + chmod -R o+w /app/ && + jekyll serve --disable-disk-cache --config _config.yml --destination /tmp/_site -P 80 --profile --trace --watch" volumes: - - "./:/srv/jekyll-data/" + - "./:/app/:cached" ru: - image: $WERF_ASSETS_DOCKER_IMAGE_NAME - working_dir: "/srv/jekyll-data" + image: $WERF_JEKYLL_BASE_DOCKER_IMAGE_NAME + working_dir: "/app" environment: JEKYLL_ENV: "dev" command: bash -c " - chmod -R o+w /srv/jekyll-data/ && - jekyll serve --config _config.yml,_config_ru.yml --destination /tmp/_site -P 80" + chmod -R o+w /app/ && + jekyll serve --disable-disk-cache --config _config.yml,_config_ru.yml --destination /tmp/_site -P 80 --profile --trace --watch" volumes: - - "./:/srv/jekyll-data/" + - "./:/app/:cached" depends_on: - en diff --git a/docs/werf.yaml b/docs/werf.yaml index ab5c2f726d..4bb9b864e3 100644 --- a/docs/werf.yaml +++ b/docs/werf.yaml @@ -2,33 +2,56 @@ project: werfio-ng configVersion: 1 --- -image: assets +image: jekyll_base from: jekyll/builder:4.2.0 -fromCacheVersion: 20220110 -ansible: - install: - - shell: | - export PATH=/usr/jekyll/bin/:$PATH - gem update bundler - - name: "Install Dependencies" - shell: bundle install - args: - executable: /bin/bash - chdir: /app/docs +fromCacheVersion: 20230421 +git: + - add: /docs + to: /app/docs + owner: jekyll + group: jekyll + includePaths: + - Gemfile + - Gemfile.lock + stageDependencies: + setup: ["**/*"] +shell: + setup: + - export PATH=/usr/jekyll/bin/:$PATH + - gem update bundler + - echo "Install Dependencies ..." + - cd /app/docs && bundle install + +--- +image: assets +fromImage: jekyll_base +shell: beforeSetup: - - file: - path: "{{`{{ item }}`}}" - state: directory - mode: 0777 - with_items: - - /app/_site/main/ - - /app/_site/ru/ - - shell: | - JEKYLL_ENV=production jekyll build -s /app/docs -d /app/_site/main/ --config /app/docs/_config.yml - JEKYLL_ENV=production jekyll build -s /app/docs -d /app/_site/ru/ --config /app/docs/_config.yml,/app/docs/_config_ru.yml - args: - executable: /bin/bash - chdir: /app/docs + - mkdir -p /app/_site/main/ + - chmod 777 /app/_site/main/ + - mkdir -p /app/_site/ru/ + - chmod 777 /app/_site/ru/ + - cd /app/docs + - bundle exec jekyll --version + - export JEKYLL_ENV="production" + + - bundle info bundler + - bundle info sprockets + - bundle info jekyll + + - cat _config.yml + + - echo "Build 'en' ..." + - bundle exec jekyll build -s /app/docs -d /app/_site/main/ --config /app/docs/_config.yml --profile --trace + + - echo "Build 'ru' ..." + - bundle exec jekyll build -s /app/docs -d /app/_site/ru/ --config /app/docs/_config.yml,/app/docs/_config_ru.yml --profile --trace + + - echo "Assets in 'en':" + - ls -la /app/_site/main/assets || true + + - echo "Assets in 'ru':" + - ls -la /app/_site/ru/assets || true git: - add: /docs to: /app/docs @@ -50,8 +73,8 @@ git: - Gemfile.lock - "*.xml" stageDependencies: - install: ['Gemfile','Gemfile.lock'] - beforeSetup: '**/*' + beforeSetup: + - '**/*' --- image: web from: nginx:stable-alpine