From d370e04047ebd969a2c16761d5a6240bd93f8699 Mon Sep 17 00:00:00 2001 From: Dmytro Kagirov Date: Sun, 22 Oct 2023 18:50:36 +0200 Subject: [PATCH 1/7] Version picker added to the docs Signed-off-by: Dmytro Kagirov --- .../workflows/docs-add-version-picker.yaml | 90 ++++++++++++ .github/workflows/docs.yaml | 3 + book.toml | 7 +- docs/website_files/README.md | 5 + docs/website_files/theme/index.hbs | 12 ++ docs/website_files/version-picker.css | 78 +++++++++++ docs/website_files/version-picker.js | 131 ++++++++++++++++++ docs/website_files/version.js | 1 + 8 files changed, 326 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/docs-add-version-picker.yaml create mode 100644 docs/website_files/version-picker.css create mode 100644 docs/website_files/version-picker.js create mode 100644 docs/website_files/version.js diff --git a/.github/workflows/docs-add-version-picker.yaml b/.github/workflows/docs-add-version-picker.yaml new file mode 100644 index 000000000000..168c15dbc513 --- /dev/null +++ b/.github/workflows/docs-add-version-picker.yaml @@ -0,0 +1,90 @@ +name: Add Version Picker (RUN ONCE) + +on: + workflow_dispatch: + +jobs: + add-version-picker: + name: Add Version Picker + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + + - name: Configure Git + run: | + git config user.email "action@synapse.bot.com" + git config user.name "Action Bot" + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + + - name: Setup mdbook + uses: peaceiris/actions-mdbook@adeb05db28a0c0004681db83893d56c0388ea9ea # v1.2.0 + with: + mdbook-version: '0.4.17' + + - name: Copy files to release branches + run: | + for version in "v1.95" "v1.94" "v1.93" "v1.92" "v1.91.0" "v1.91" "v1.90" "v1.89" "v1.88" "v1.87" "v1.86" "v1.85" "v1.84" "v1.83" "v1.82" "v1.81" "v1.80" "v1.79" "v1.78" "v1.77" "v1.76" "v1.75" "v1.74" "v1.73" "v1.72" "v1.71" "v1.70" "v1.69" "v1.68" "v1.67" "v1.66" "v1.65" "v1.64" "v1.63" "v1.62" "v1.61" "v1.60" "v1.59" "v1.58" "v1.57" "v1.56" "v1.55" "v1.54" "v1.53" "v1.52" "v1.51" "v1.50" "v1.49" "v1.48" "v1.47" "v1.46" "v1.45" "v1.44" "v1.43" "v1.42" "v1.41" "v1.40" "v1.39" "v1.38" "v1.37" + do + git fetch + git checkout -b release-$version origin/release-$version + + git checkout develop -- ./book.toml + git checkout develop -- ./docs/website_files/version-picker.js + git checkout develop -- ./docs/website_files/version-picker.css + git checkout develop -- ./docs/website_files/README.md + + echo "window.SYNAPSE_VERSION = '$version';" > ./docs/website_files/version.js + + # Adding version-picker element to index.hbs + awk '/ {{/if}} +
+
+
+ + +
+ +
    + +
+
+

{{ book_title }}

diff --git a/docs/website_files/version-picker.css b/docs/website_files/version-picker.css new file mode 100644 index 000000000000..95018345cb19 --- /dev/null +++ b/docs/website_files/version-picker.css @@ -0,0 +1,78 @@ +.version-picker { + display: flex; + align-items: center; +} + +.version-picker .dropdown { + width: 130px; + max-height: 29px; + margin-left: 10px; + display: inline-block; + border-radius: 4px; + border: 1px solid var(--theme-popup-border); + position: relative; + font-size: 13px; + color: var(--fg); + height: 100%; + text-align: left; +} +.version-picker .dropdown .select { + cursor: pointer; + display: block; + padding: 5px 2px 5px 15px; +} +.version-picker .dropdown .select > i { + font-size: 10px; + color: var(--fg); + cursor: pointer; + float: right; + line-height: 20px !important; +} +.version-picker .dropdown:hover { + border: 1px solid var(--theme-popup-border); +} +.version-picker .dropdown:active { + background-color: var(--theme-popup-bg); +} +.version-picker .dropdown.active:hover, +.version-picker .dropdown.active { + border: 1px solid var(--theme-popup-border); + border-radius: 2px 2px 0 0; + background-color: var(--theme-popup-bg); +} +.version-picker .dropdown.active .select > i { + transform: rotate(-90deg); +} +.version-picker .dropdown .dropdown-menu { + position: absolute; + background-color: var(--theme-popup-bg); + width: 100%; + left: -1px; + right: 1px; + margin-top: 1px; + border: 1px solid var(--theme-popup-border); + border-radius: 0 0 4px 4px; + overflow: hidden; + display: none; + max-height: 300px; + overflow-y: auto; + z-index: 9; +} +.version-picker .dropdown .dropdown-menu li { + font-size: 12px; + padding: 6px 20px; + cursor: pointer; +} +.version-picker .dropdown .dropdown-menu { + padding: 0; + list-style: none; +} +.version-picker .dropdown .dropdown-menu li:hover { + background-color: var(--theme-hover); +} +.version-picker .dropdown .dropdown-menu li.active::before { + display: inline-block; + content: "✓"; + margin-inline-start: -14px; + width: 14px; +} \ No newline at end of file diff --git a/docs/website_files/version-picker.js b/docs/website_files/version-picker.js new file mode 100644 index 000000000000..8a89dbc6a993 --- /dev/null +++ b/docs/website_files/version-picker.js @@ -0,0 +1,131 @@ + +const dropdown = document.querySelector('.version-picker .dropdown'); +const dropdownMenu = dropdown.querySelector('.dropdown-menu'); + +fetchVersions(dropdown, dropdownMenu).then(() => { + initializeVersionDropdown(dropdown, dropdownMenu); +}); + +/** + * Initialize the dropdown functionality for version selection. + * + * @param {Element} dropdown - The dropdown element. + * @param {Element} dropdownMenu - The dropdown menu element. + */ +function initializeVersionDropdown(dropdown, dropdownMenu) { + // Toggle the dropdown menu on click + dropdown.addEventListener('click', function () { + this.setAttribute('tabindex', 1); + this.classList.toggle('active'); + dropdownMenu.style.display = (dropdownMenu.style.display === 'block') ? 'none' : 'block'; + }); + + // Remove the 'active' class and hide the dropdown menu on focusout + dropdown.addEventListener('focusout', function () { + this.classList.remove('active'); + dropdownMenu.style.display = 'none'; + }); + + // Handle item selection within the dropdown menu + const dropdownMenuItems = dropdownMenu.querySelectorAll('li'); + dropdownMenuItems.forEach(function (item) { + item.addEventListener('click', function () { + dropdownMenuItems.forEach(function (item) { + item.classList.remove('active'); + }); + this.classList.add('active'); + dropdown.querySelector('span').textContent = this.textContent; + dropdown.querySelector('input').value = this.getAttribute('id'); + + window.location.href = changeVersion(window.location.href, this.textContent); + }); + }); +}; + +/** + * This function fetch the available versions from a GitHub repository + * and inserts them into the version picker. + * + * @param {Element} dropdown - The dropdown element. + * @param {Element} dropdownMenu - The dropdown menu element. + * @returns {Promise>} A promise that resolves with an array of available versions. + */ +function fetchVersions(dropdown, dropdownMenu) { + return new Promise((resolve, reject) => { + window.addEventListener("load", () => { + + fetch("https://api.github.com/repos/matrix-org/synapse/git/trees/gh-pages", { + cache: "force-cache", + }).then(res => + res.json() + ).then(resObject => { + const excluded = ['dev-docs', 'v1.80.0', 'v1.69.0']; + const tree = resObject.tree.filter(item => item.type === "tree" && !excluded.includes(item.path)); + const versions = tree.map(item => item.path).sort(sortVersions); + + // Create a list of
  • items for versions + versions.forEach((version) => { + const li = document.createElement("li"); + li.textContent = version; + li.id = version; + + if (window.SYNAPSE_VERSION === version) { + li.classList.add('active'); + dropdown.querySelector('span').textContent = version; + dropdown.querySelector('input').value = version; + } + + dropdownMenu.appendChild(li); + }); + + resolve(versions); + + }).catch(ex => { + console.error("Failed to fetch version data", ex); + reject(ex); + }) + }); + }); +} + +/** + * Custom sorting function to sort an array of version strings. + * + * @param {string} a - The first version string to compare. + * @param {string} b - The second version string to compare. + * @returns {number} - A negative number if a should come before b, a positive number if b should come before a, or 0 if they are equal. + */ +function sortVersions(a, b) { + // Put 'develop' and 'latest' at the top + if (a === 'develop' || a === 'latest') return -1; + if (b === 'develop' || b === 'latest') return 1; + + const versionA = (a.match(/v\d+(\.\d+)+/) || [])[0]; + const versionB = (b.match(/v\d+(\.\d+)+/) || [])[0]; + + // Handle versions without a version number (e.g., 'develop' and 'latest') + if (!versionA) return 1; + if (!versionB) return -1; + + return versionB.localeCompare(versionA); +} + +/** + * Change the version in a URL path. + * + * @param {string} url - The original URL to be modified. + * @param {string} newVersion - The new version to replace the existing version in the URL. + * @returns {string} The updated URL with the new version. + */ +function changeVersion(url, newVersion) { + const parsedURL = new URL(url); + const pathSegments = parsedURL.pathname.split('/'); + + // Modify the version + pathSegments[2] = newVersion; + + // Reconstruct the URL + parsedURL.pathname = pathSegments.join('/'); + + return parsedURL.href; +} \ No newline at end of file diff --git a/docs/website_files/version.js b/docs/website_files/version.js new file mode 100644 index 000000000000..9065afcdbfc2 --- /dev/null +++ b/docs/website_files/version.js @@ -0,0 +1 @@ +window.SYNAPSE_VERSION = "latest"; \ No newline at end of file From 1a287b01d9d4b3b383e04e50148afe561c381c95 Mon Sep 17 00:00:00 2001 From: Dmytro Kagirov Date: Sun, 22 Oct 2023 20:24:16 +0200 Subject: [PATCH 2/7] changelog added Signed-off-by: Dmytro Kagirov --- changelog.d/16533.doc | 1 + 1 file changed, 1 insertion(+) create mode 100644 changelog.d/16533.doc diff --git a/changelog.d/16533.doc b/changelog.d/16533.doc new file mode 100644 index 000000000000..d2172bded45f --- /dev/null +++ b/changelog.d/16533.doc @@ -0,0 +1 @@ +Added version picker for Synapse documentation. Contributed by @Dmytro27Ind \ No newline at end of file From f58a48c2f05edf6e43d04244ca7d901cba0d50c8 Mon Sep 17 00:00:00 2001 From: Dmytro Kagirov Date: Sun, 19 Nov 2023 15:24:08 +0100 Subject: [PATCH 3/7] v1.96 added to github action Signed-off-by: Dmytro Kagirov --- .github/workflows/docs-add-version-picker.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/docs-add-version-picker.yaml b/.github/workflows/docs-add-version-picker.yaml index 168c15dbc513..e20bef5dab7e 100644 --- a/.github/workflows/docs-add-version-picker.yaml +++ b/.github/workflows/docs-add-version-picker.yaml @@ -25,7 +25,7 @@ jobs: - name: Copy files to release branches run: | - for version in "v1.95" "v1.94" "v1.93" "v1.92" "v1.91.0" "v1.91" "v1.90" "v1.89" "v1.88" "v1.87" "v1.86" "v1.85" "v1.84" "v1.83" "v1.82" "v1.81" "v1.80" "v1.79" "v1.78" "v1.77" "v1.76" "v1.75" "v1.74" "v1.73" "v1.72" "v1.71" "v1.70" "v1.69" "v1.68" "v1.67" "v1.66" "v1.65" "v1.64" "v1.63" "v1.62" "v1.61" "v1.60" "v1.59" "v1.58" "v1.57" "v1.56" "v1.55" "v1.54" "v1.53" "v1.52" "v1.51" "v1.50" "v1.49" "v1.48" "v1.47" "v1.46" "v1.45" "v1.44" "v1.43" "v1.42" "v1.41" "v1.40" "v1.39" "v1.38" "v1.37" + for version in "v1.96" "v1.95" "v1.94" "v1.93" "v1.92" "v1.91.0" "v1.91" "v1.90" "v1.89" "v1.88" "v1.87" "v1.86" "v1.85" "v1.84" "v1.83" "v1.82" "v1.81" "v1.80" "v1.79" "v1.78" "v1.77" "v1.76" "v1.75" "v1.74" "v1.73" "v1.72" "v1.71" "v1.70" "v1.69" "v1.68" "v1.67" "v1.66" "v1.65" "v1.64" "v1.63" "v1.62" "v1.61" "v1.60" "v1.59" "v1.58" "v1.57" "v1.56" "v1.55" "v1.54" "v1.53" "v1.52" "v1.51" "v1.50" "v1.49" "v1.48" "v1.47" "v1.46" "v1.45" "v1.44" "v1.43" "v1.42" "v1.41" "v1.40" "v1.39" "v1.38" "v1.37" do git fetch git checkout -b release-$version origin/release-$version @@ -67,7 +67,7 @@ jobs: git fetch git branch gh-pages origin/gh-pages - for version in "v1.95" "v1.94" "v1.93" "v1.92" "v1.91.0" "v1.91" "v1.90" "v1.89" "v1.88" "v1.87" "v1.86" "v1.85" "v1.84" "v1.83" "v1.82" "v1.81" "v1.80" "v1.79" "v1.78" "v1.77" "v1.76" "v1.75" "v1.74" "v1.73" "v1.72" "v1.71" "v1.70" "v1.69" "v1.68" "v1.67" "v1.66" "v1.65" "v1.64" "v1.63" "v1.62" "v1.61" "v1.60" "v1.59" "v1.58" "v1.57" "v1.56" "v1.55" "v1.54" "v1.53" "v1.52" "v1.51" "v1.50" "v1.49" "v1.48" "v1.47" "v1.46" "v1.45" "v1.44" "v1.43" "v1.42" "v1.41" "v1.40" "v1.39" "v1.38" "v1.37" + for version in "v1.96" "v1.95" "v1.94" "v1.93" "v1.92" "v1.91.0" "v1.91" "v1.90" "v1.89" "v1.88" "v1.87" "v1.86" "v1.85" "v1.84" "v1.83" "v1.82" "v1.81" "v1.80" "v1.79" "v1.78" "v1.77" "v1.76" "v1.75" "v1.74" "v1.73" "v1.72" "v1.71" "v1.70" "v1.69" "v1.68" "v1.67" "v1.66" "v1.65" "v1.64" "v1.63" "v1.62" "v1.61" "v1.60" "v1.59" "v1.58" "v1.57" "v1.56" "v1.55" "v1.54" "v1.53" "v1.52" "v1.51" "v1.50" "v1.49" "v1.48" "v1.47" "v1.46" "v1.45" "v1.44" "v1.43" "v1.42" "v1.41" "v1.40" "v1.39" "v1.38" "v1.37" do git checkout release-$version From e8961d34698cc966ad947006cd60ff59ce941b2c Mon Sep 17 00:00:00 2001 From: Dmytro Kagirov Date: Wed, 29 Nov 2023 16:15:55 +0100 Subject: [PATCH 4/7] v1.97 added Signed-off-by: Dmytro Kagirov --- .github/workflows/docs-add-version-picker.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/docs-add-version-picker.yaml b/.github/workflows/docs-add-version-picker.yaml index e20bef5dab7e..b00d6336b370 100644 --- a/.github/workflows/docs-add-version-picker.yaml +++ b/.github/workflows/docs-add-version-picker.yaml @@ -25,7 +25,7 @@ jobs: - name: Copy files to release branches run: | - for version in "v1.96" "v1.95" "v1.94" "v1.93" "v1.92" "v1.91.0" "v1.91" "v1.90" "v1.89" "v1.88" "v1.87" "v1.86" "v1.85" "v1.84" "v1.83" "v1.82" "v1.81" "v1.80" "v1.79" "v1.78" "v1.77" "v1.76" "v1.75" "v1.74" "v1.73" "v1.72" "v1.71" "v1.70" "v1.69" "v1.68" "v1.67" "v1.66" "v1.65" "v1.64" "v1.63" "v1.62" "v1.61" "v1.60" "v1.59" "v1.58" "v1.57" "v1.56" "v1.55" "v1.54" "v1.53" "v1.52" "v1.51" "v1.50" "v1.49" "v1.48" "v1.47" "v1.46" "v1.45" "v1.44" "v1.43" "v1.42" "v1.41" "v1.40" "v1.39" "v1.38" "v1.37" + for version in "v1.97" "v1.96" "v1.95" "v1.94" "v1.93" "v1.92" "v1.91.0" "v1.91" "v1.90" "v1.89" "v1.88" "v1.87" "v1.86" "v1.85" "v1.84" "v1.83" "v1.82" "v1.81" "v1.80" "v1.79" "v1.78" "v1.77" "v1.76" "v1.75" "v1.74" "v1.73" "v1.72" "v1.71" "v1.70" "v1.69" "v1.68" "v1.67" "v1.66" "v1.65" "v1.64" "v1.63" "v1.62" "v1.61" "v1.60" "v1.59" "v1.58" "v1.57" "v1.56" "v1.55" "v1.54" "v1.53" "v1.52" "v1.51" "v1.50" "v1.49" "v1.48" "v1.47" "v1.46" "v1.45" "v1.44" "v1.43" "v1.42" "v1.41" "v1.40" "v1.39" "v1.38" "v1.37" do git fetch git checkout -b release-$version origin/release-$version @@ -67,7 +67,7 @@ jobs: git fetch git branch gh-pages origin/gh-pages - for version in "v1.96" "v1.95" "v1.94" "v1.93" "v1.92" "v1.91.0" "v1.91" "v1.90" "v1.89" "v1.88" "v1.87" "v1.86" "v1.85" "v1.84" "v1.83" "v1.82" "v1.81" "v1.80" "v1.79" "v1.78" "v1.77" "v1.76" "v1.75" "v1.74" "v1.73" "v1.72" "v1.71" "v1.70" "v1.69" "v1.68" "v1.67" "v1.66" "v1.65" "v1.64" "v1.63" "v1.62" "v1.61" "v1.60" "v1.59" "v1.58" "v1.57" "v1.56" "v1.55" "v1.54" "v1.53" "v1.52" "v1.51" "v1.50" "v1.49" "v1.48" "v1.47" "v1.46" "v1.45" "v1.44" "v1.43" "v1.42" "v1.41" "v1.40" "v1.39" "v1.38" "v1.37" + for version in "v1.97" "v1.96" "v1.95" "v1.94" "v1.93" "v1.92" "v1.91.0" "v1.91" "v1.90" "v1.89" "v1.88" "v1.87" "v1.86" "v1.85" "v1.84" "v1.83" "v1.82" "v1.81" "v1.80" "v1.79" "v1.78" "v1.77" "v1.76" "v1.75" "v1.74" "v1.73" "v1.72" "v1.71" "v1.70" "v1.69" "v1.68" "v1.67" "v1.66" "v1.65" "v1.64" "v1.63" "v1.62" "v1.61" "v1.60" "v1.59" "v1.58" "v1.57" "v1.56" "v1.55" "v1.54" "v1.53" "v1.52" "v1.51" "v1.50" "v1.49" "v1.48" "v1.47" "v1.46" "v1.45" "v1.44" "v1.43" "v1.42" "v1.41" "v1.40" "v1.39" "v1.38" "v1.37" do git checkout release-$version From c70fc551adaece3a3aa7c1aebfaf8d6b1268c5e3 Mon Sep 17 00:00:00 2001 From: Dmytro Kagirov Date: Wed, 29 Nov 2023 17:20:13 +0100 Subject: [PATCH 5/7] changelog fixed Signed-off-by: Dmytro Kagirov --- changelog.d/16533.doc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/changelog.d/16533.doc b/changelog.d/16533.doc index d2172bded45f..ae23a8a5782c 100644 --- a/changelog.d/16533.doc +++ b/changelog.d/16533.doc @@ -1 +1 @@ -Added version picker for Synapse documentation. Contributed by @Dmytro27Ind \ No newline at end of file +Added version picker for Synapse documentation. Contributed by @Dmytro27Ind. \ No newline at end of file From 356a663f5dd4d289dfb3dc81aa2168334c2ebdad Mon Sep 17 00:00:00 2001 From: Dmytro Kagirov Date: Mon, 11 Dec 2023 06:31:43 +0100 Subject: [PATCH 6/7] added v1.98 and version picker fixed Signed-off-by: Dmytro Kagirov --- .github/workflows/docs-add-version-picker.yaml | 6 +++--- docs/website_files/theme/index.hbs | 2 +- docs/website_files/version-picker.css | 2 +- docs/website_files/version-picker.js | 4 ++-- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/.github/workflows/docs-add-version-picker.yaml b/.github/workflows/docs-add-version-picker.yaml index b00d6336b370..717d5c85d3ab 100644 --- a/.github/workflows/docs-add-version-picker.yaml +++ b/.github/workflows/docs-add-version-picker.yaml @@ -25,7 +25,7 @@ jobs: - name: Copy files to release branches run: | - for version in "v1.97" "v1.96" "v1.95" "v1.94" "v1.93" "v1.92" "v1.91.0" "v1.91" "v1.90" "v1.89" "v1.88" "v1.87" "v1.86" "v1.85" "v1.84" "v1.83" "v1.82" "v1.81" "v1.80" "v1.79" "v1.78" "v1.77" "v1.76" "v1.75" "v1.74" "v1.73" "v1.72" "v1.71" "v1.70" "v1.69" "v1.68" "v1.67" "v1.66" "v1.65" "v1.64" "v1.63" "v1.62" "v1.61" "v1.60" "v1.59" "v1.58" "v1.57" "v1.56" "v1.55" "v1.54" "v1.53" "v1.52" "v1.51" "v1.50" "v1.49" "v1.48" "v1.47" "v1.46" "v1.45" "v1.44" "v1.43" "v1.42" "v1.41" "v1.40" "v1.39" "v1.38" "v1.37" + for version in "v1.98" "v1.97" "v1.96" "v1.95" "v1.94" "v1.93" "v1.92" "v1.91" "v1.90" "v1.89" "v1.88" "v1.87" "v1.86" "v1.85" "v1.84" "v1.83" "v1.82" "v1.81" "v1.80" "v1.79" "v1.78" "v1.77" "v1.76" "v1.75" "v1.74" "v1.73" "v1.72" "v1.71" "v1.70" "v1.69" "v1.68" "v1.67" "v1.66" "v1.65" "v1.64" "v1.63" "v1.62" "v1.61" "v1.60" "v1.59" "v1.58" "v1.57" "v1.56" "v1.55" "v1.54" "v1.53" "v1.52" "v1.51" "v1.50" "v1.49" "v1.48" "v1.47" "v1.46" "v1.45" "v1.44" "v1.43" "v1.42" "v1.41" "v1.40" "v1.39" "v1.38" "v1.37" do git fetch git checkout -b release-$version origin/release-$version @@ -45,7 +45,7 @@ jobs:
    \n\
    \n\ \n\ - \n\ + \n\
    \n\ \n\
      \n\ @@ -67,7 +67,7 @@ jobs: git fetch git branch gh-pages origin/gh-pages - for version in "v1.97" "v1.96" "v1.95" "v1.94" "v1.93" "v1.92" "v1.91.0" "v1.91" "v1.90" "v1.89" "v1.88" "v1.87" "v1.86" "v1.85" "v1.84" "v1.83" "v1.82" "v1.81" "v1.80" "v1.79" "v1.78" "v1.77" "v1.76" "v1.75" "v1.74" "v1.73" "v1.72" "v1.71" "v1.70" "v1.69" "v1.68" "v1.67" "v1.66" "v1.65" "v1.64" "v1.63" "v1.62" "v1.61" "v1.60" "v1.59" "v1.58" "v1.57" "v1.56" "v1.55" "v1.54" "v1.53" "v1.52" "v1.51" "v1.50" "v1.49" "v1.48" "v1.47" "v1.46" "v1.45" "v1.44" "v1.43" "v1.42" "v1.41" "v1.40" "v1.39" "v1.38" "v1.37" + for version in "v1.98" "v1.97" "v1.96" "v1.95" "v1.94" "v1.93" "v1.92" "v1.91" "v1.90" "v1.89" "v1.88" "v1.87" "v1.86" "v1.85" "v1.84" "v1.83" "v1.82" "v1.81" "v1.80" "v1.79" "v1.78" "v1.77" "v1.76" "v1.75" "v1.74" "v1.73" "v1.72" "v1.71" "v1.70" "v1.69" "v1.68" "v1.67" "v1.66" "v1.65" "v1.64" "v1.63" "v1.62" "v1.61" "v1.60" "v1.59" "v1.58" "v1.57" "v1.56" "v1.55" "v1.54" "v1.53" "v1.52" "v1.51" "v1.50" "v1.49" "v1.48" "v1.47" "v1.46" "v1.45" "v1.44" "v1.43" "v1.42" "v1.41" "v1.40" "v1.39" "v1.38" "v1.37" do git checkout release-$version diff --git a/docs/website_files/theme/index.hbs b/docs/website_files/theme/index.hbs index 2cb90073af38..f60a7e96aa51 100644 --- a/docs/website_files/theme/index.hbs +++ b/docs/website_files/theme/index.hbs @@ -135,7 +135,7 @@
      - +
        diff --git a/docs/website_files/version-picker.css b/docs/website_files/version-picker.css index 95018345cb19..28e5d5219aa1 100644 --- a/docs/website_files/version-picker.css +++ b/docs/website_files/version-picker.css @@ -41,7 +41,7 @@ background-color: var(--theme-popup-bg); } .version-picker .dropdown.active .select > i { - transform: rotate(-90deg); + transform: rotate(-180deg); } .version-picker .dropdown .dropdown-menu { position: absolute; diff --git a/docs/website_files/version-picker.js b/docs/website_files/version-picker.js index 8a89dbc6a993..b9d5106f7379 100644 --- a/docs/website_files/version-picker.js +++ b/docs/website_files/version-picker.js @@ -43,7 +43,7 @@ function initializeVersionDropdown(dropdown, dropdownMenu) { }; /** - * This function fetch the available versions from a GitHub repository + * This function fetches the available versions from a GitHub repository * and inserts them into the version picker. * * @param {Element} dropdown - The dropdown element. @@ -59,7 +59,7 @@ function fetchVersions(dropdown, dropdownMenu) { }).then(res => res.json() ).then(resObject => { - const excluded = ['dev-docs', 'v1.80.0', 'v1.69.0']; + const excluded = ['dev-docs', 'v1.91.0', 'v1.80.0', 'v1.69.0']; const tree = resObject.tree.filter(item => item.type === "tree" && !excluded.includes(item.path)); const versions = tree.map(item => item.path).sort(sortVersions); From c31402a3e2451f84e118a5e4a58f961d59ed696e Mon Sep 17 00:00:00 2001 From: Dmytro Kagirov Date: Mon, 11 Dec 2023 06:53:39 +0100 Subject: [PATCH 7/7] version picker sorting fixed Signed-off-by: Dmytro Kagirov --- docs/website_files/version-picker.js | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docs/website_files/version-picker.js b/docs/website_files/version-picker.js index b9d5106f7379..bb35a7d8961e 100644 --- a/docs/website_files/version-picker.js +++ b/docs/website_files/version-picker.js @@ -103,10 +103,6 @@ function sortVersions(a, b) { const versionA = (a.match(/v\d+(\.\d+)+/) || [])[0]; const versionB = (b.match(/v\d+(\.\d+)+/) || [])[0]; - // Handle versions without a version number (e.g., 'develop' and 'latest') - if (!versionA) return 1; - if (!versionB) return -1; - return versionB.localeCompare(versionA); }