diff --git a/_helper/.gitignore b/_helper/.gitignore new file mode 100644 index 0000000..159c1ab --- /dev/null +++ b/_helper/.gitignore @@ -0,0 +1,6 @@ +include-relationships.yml +.env +.bundle/ +vendor/ +_site/ +Gemfile.lock diff --git a/_helper/.whatsup.yml b/_helper/.whatsup.yml new file mode 100755 index 0000000..9a7b176 --- /dev/null +++ b/_helper/.whatsup.yml @@ -0,0 +1,30 @@ +# Parameters for a GitHub search query +--- +base_branch: main + +# The list of repositories to scan for pull requests +repos: + - AdobeDocs/commerce-services + +# Labels also will be used as a 'type' value in the output file +labels: + required: + - new-topic + - major-update + optional: + - technical + - feedback + - release-notes + +# Format of output file +output_format: + - yaml +# - markdown + +# The phrase that is used as a separator in the pull request description. +# All the lines that follows this phrase are captured as 'description' for this PR's entry in the resulted data file. +magic_word: whatsnew + +# An organization to check a contributor for membership. +# Values: 'true', 'false', empty if not configured. +# membership: AdobeDocs diff --git a/_helper/Gemfile b/_helper/Gemfile new file mode 100644 index 0000000..7768f90 --- /dev/null +++ b/_helper/Gemfile @@ -0,0 +1,9 @@ +# Copyright 2024 Adobe. All rights reserved. +# Licensed under the MIT License. See license.md for details. + +# frozen_string_literal: true + +source 'https://rubygems.org' + +gem 'adobe-comdox-exl-rake-tasks', git: 'https://github.com/commerce-docs/adobe-comdox-exl-rake-tasks', tag: 'v0.6.0' +gem 'whatsup_github', git: 'https://github.com/commerce-docs/whatsup_github', tag: 'v2.1.1' diff --git a/_helper/Rakefile b/_helper/Rakefile new file mode 100644 index 0000000..7dd5eef --- /dev/null +++ b/_helper/Rakefile @@ -0,0 +1,6 @@ +# frozen_string_literal: true + +require 'dotenv/load' + +# Load the Adobe Comdox EXL Rake Tasks gem +require 'adobe-comdox-exl-rake-tasks' diff --git a/_helper/_config.yml b/_helper/_config.yml new file mode 100644 index 0000000..4b1943d --- /dev/null +++ b/_helper/_config.yml @@ -0,0 +1,11 @@ +--- +repo: AdobeDocs/commerce-admin-developer +url: https://developer.adobe.com/commerce/admin-developer +exclude: + - Rakefile + - tmp + - Gemfile + - Gemfile.lock +kramdown: + smart_quotes: ["apos", "apos", "quot", "quot"] + syntax_highlighter: none diff --git a/_helper/_data/whats-new.yml b/_helper/_data/whats-new.yml new file mode 100644 index 0000000..6a0d0f5 --- /dev/null +++ b/_helper/_data/whats-new.yml @@ -0,0 +1,6 @@ +--- +title: What's new +description: This section contains the changes made in the last 60 days. We exclude + all minor updates, such as copy editing, from this list. +updated: Wed Nov 4 13:16:00 2026 +entries: [] diff --git a/_helper/templated/whats-new.html b/_helper/templated/whats-new.html new file mode 100644 index 0000000..1cea078 --- /dev/null +++ b/_helper/templated/whats-new.html @@ -0,0 +1,27 @@ +--- +--- +{%- assign whatsnew = site.data.whats-new %} +{{ whatsnew.description }} + +{%- assign this_days_ago = 60 | times: 86400 %} +{%- assign date_this_days_ago = "now" | date: "%s" | minus: this_days_ago %} +{%- assign entries = whatsnew.entries | sort: "date" | reverse %} +{%- assign has_recent_entries = false %} + +{%- for entry in entries %} +{%- assign entry_date_int = entry.date | date: "%s" | abs %} +{%- if entry_date_int > date_this_days_ago %} +{%- unless has_recent_entries %} + +| Description | Type | Date | +|---|---|---| +{%- endunless %} +{%- assign has_recent_entries = true %} +| {{ entry.description }} | {{ entry.type | replace: "-", " " | capitalize }} | [{{ entry.date | date: '%B %-e, %Y'}}]({{ entry.link }}) | +{%- endif %} +{%- endfor %} + +{%- unless has_recent_entries %} + +**No significant documentation updates so far.** +{%- endunless %} diff --git a/package.json b/package.json index 1f482d8..95b9ff1 100644 --- a/package.json +++ b/package.json @@ -7,6 +7,8 @@ "url": "https://github.com/AdobeDocs/commerce-admin-developer" }, "scripts": { + "helper:render": "cd _helper && bundle exec rake render", + "helper:whatsnew": "cd _helper && bundle exec rake whatsnew", "dev": "npx --yes --prefer-online github:AdobeDocs/adp-devsite-utils dev", "buildNavigation": "npx --yes --prefer-online github:AdobeDocs/adp-devsite-utils buildNavigation -v", "buildRedirections": "npx --yes --prefer-online github:AdobeDocs/adp-devsite-utils buildRedirections -v", @@ -26,6 +28,15 @@ "test": "npx --yes jest", "test:config": "npx --yes jest tests/config.test.js" }, + "lint": { + "skipRules": { + "check-frontmatter": { + "paths": [ + "src/pages/_includes" + ] + } + } + }, "engines": { "node": "^24.11.0" } diff --git a/src/pages/_includes/templated/whats-new.md b/src/pages/_includes/templated/whats-new.md new file mode 100644 index 0000000..f39ef51 --- /dev/null +++ b/src/pages/_includes/templated/whats-new.md @@ -0,0 +1,4 @@ + +This section contains the changes made in the last 60 days. We exclude all minor updates, such as copy editing, from this list. + +**No significant documentation updates so far.** diff --git a/src/pages/index.md b/src/pages/index.md index cdfd193..bf65e6c 100644 --- a/src/pages/index.md +++ b/src/pages/index.md @@ -50,3 +50,7 @@ Use these patterns to customize Admin user interfaces. ## Contributing to this documentation We encourage you to participate in our open documentation initiative. If you have suggestions, corrections, additions, or deletions for this documentation, check out the source on [GitHub](https://github.com/adobedocs/commerce-admin-developer), and open a pull request. + +## What's new + +