diff --git a/.github/dependabot.yml b/.github/dependabot.yml index fc3044f7..47a3860f 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -1,6 +1,13 @@ -version: 2 +--- +# Dependabot configuration +# Reference: https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file +version: 2 updates: + - package-ecosystem: "github-actions" # See documentation for possible values + directory: "/" # Location of package manifests + schedule: + interval: "weekly" - package-ecosystem: "pip" directory: "/" schedule: diff --git a/.github/workflows/mega-linter.yml b/.github/workflows/mega-linter.yml index 88d5e20c..19f12bdb 100644 --- a/.github/workflows/mega-linter.yml +++ b/.github/workflows/mega-linter.yml @@ -23,7 +23,7 @@ jobs: steps: # Git Checkout - name: Checkout Code - uses: actions/checkout@v4 + uses: actions/checkout@v6 with: # Checkout the HEAD of the PR instead of the merge commit. ref: ${{ github.event.pull_request.head.sha }} @@ -38,7 +38,7 @@ jobs: id: ml # You can override MegaLinter flavor used to have faster performances # More info at https://megalinter.io/flavors/ - uses: oxsecurity/megalinter@v7 + uses: oxsecurity/megalinter@v9.4.0 env: # All available variables are described in documentation: # https://megalinter.io/configuration/ diff --git a/.lycheeignore b/.lycheeignore new file mode 100644 index 00000000..23337559 --- /dev/null +++ b/.lycheeignore @@ -0,0 +1 @@ +^https:\/\/alimonitor\.cern\.ch\/ diff --git a/.mega-linter.yml b/.mega-linter.yml index c6244860..7f81d38b 100644 --- a/.mega-linter.yml +++ b/.mega-linter.yml @@ -1,6 +1,6 @@ --- # Configuration file for Mega-Linter -# See all available variables at https://oxsecurity.github.io/megalinter/configuration/ and in linters documentation +# See all available variables at http://megalinter.io/latest/configuration/ and in linters documentation APPLY_FIXES: all # all, none, or list of linter keys DEFAULT_BRANCH: master # Usually master or main @@ -8,6 +8,7 @@ ENABLE: # If you use ENABLE variable, all other languages/formats/tooling-format - ACTION - BASH - CPP + - JSON - MARKDOWN - SPELL - YAML diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 00000000..6f74dae6 --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,28 @@ +--- +# See https://pre-commit.com for more information +# See https://pre-commit.com/hooks.html for more hooks +repos: + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v6.0.0 + hooks: + - id: end-of-file-fixer + - id: check-json + - id: check-yaml + - id: trailing-whitespace + - repo: https://github.com/pre-commit/mirrors-clang-format + rev: v21.1.7 # clang-format version + hooks: + - id: clang-format + - repo: https://github.com/cpplint/cpplint + rev: 2.0.2 + hooks: + - id: cpplint + - repo: https://github.com/igorshubovych/markdownlint-cli + rev: v0.47.0 + hooks: + - id: markdownlint-fix + - repo: https://github.com/tcort/markdown-link-check + rev: v3.14.2 + hooks: + - id: markdown-link-check + args: [-q] diff --git a/CPPLINT.cfg b/CPPLINT.cfg index e050d1df..7f7d3c35 100644 --- a/CPPLINT.cfg +++ b/CPPLINT.cfg @@ -1 +1 @@ -filter=-build/c++11,-build/namespaces,-readability/fn_size,-readability/todo,-runtime/references,-whitespace/blank_line,-whitespace/braces,-whitespace/comments,-whitespace/line_length,-whitespace/semicolon,-whitespace/todo +filter=-build/c++11,-build/namespaces,-readability/fn_size,-readability/todo,-runtime/references,-whitespace/blank_line,-whitespace/braces,-whitespace/comments,-whitespace/indent_namespace,-whitespace/line_length,-whitespace/semicolon,-whitespace/todo diff --git a/Gemfile b/Gemfile index 8a923ff1..80739d06 100644 --- a/Gemfile +++ b/Gemfile @@ -3,3 +3,5 @@ source "https://rubygems.org" # source "https://gems.ruby-china.com" gemspec gem "github-pages", group: :jekyll_plugins + +gem "webrick", "~> 1.9" diff --git a/README.md b/README.md index 403bdf51..dc878573 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -# O2 Analysis Framework Documentation +# ALICE O2 Analysis Framework Documentation -Welcome to the documentation page of the O2 analysis framework! Please use the links below to navigate quickly to the content you're looking for. +Welcome to the documentation page of the ALICE O2 analysis framework! Please use the links below to navigate quickly to the content you're looking for. {% include horizontalcontents.html %} diff --git a/_config.yml b/_config.yml index 9490ba2b..077ca48a 100644 --- a/_config.yml +++ b/_config.yml @@ -1,5 +1,5 @@ -title: ALICE O2 documentation -description: ALICE O2 Data Analysis Framework documentation project +title: ALICE O2 Analysis Framework Documentation +description: ALICE O2 Analysis Framework Documentation project theme: null diff --git a/_includes/common/core/_hlist.liquid b/_includes/common/core/_hlist.liquid index b9a80b36..c11a601d 100644 --- a/_includes/common/core/_hlist.liquid +++ b/_includes/common/core/_hlist.liquid @@ -8,7 +8,7 @@ {%- assign dir = site_pages | where: "url", workdir | first %} -{% if dir.title != "Documentation home" %} +{% if dir.title != "Home" %}

{{ dir.title | default: dir.url }}

{% endif %} @@ -18,8 +18,3 @@ {% endif %} {%- for workdir in workdir_dirs %}{% include common/core/_hlist.liquid %}{% endfor -%} - - - - - diff --git a/_includes/common/rest/title.liquid b/_includes/common/rest/title.liquid index e25d8e4a..ddc8217e 100644 --- a/_includes/common/rest/title.liquid +++ b/_includes/common/rest/title.liquid @@ -1,8 +1,6 @@ {%- case page.url -%} {%- when "/" -%} - {%- assign title = site.title - | append: " · " - | append: site.description | truncate: 110 -%} + {%- assign title = site.title -%} {%- when "/search.html" -%} {%- assign title = __.search | default: "Search" | append: " · " diff --git a/_includes/templates/sidebar.liquid b/_includes/templates/sidebar.liquid index f643190a..7fe304b0 100644 --- a/_includes/templates/sidebar.liquid +++ b/_includes/templates/sidebar.liquid @@ -2,8 +2,8 @@