docs: switch language based on current path #16687

kecrily · 2022-12-20T13:56:27Z

Prerequisites checklist

I have read the contributing guidelines.

What is the purpose of this pull request? (put an "X" next to an item)

[x] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofix to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:

What changes did you make? (Give an overview)

Instead of directing users to homepages in other languages for no reason, they are redirected to corresponding pages in other languages based on the path of the current page

Is there anything you'd like reviewers to focus on?

It is an addition to eslint/eslint.org#380

ref eslint/eslint.org#380

netlify · 2022-12-20T13:56:32Z

✅ Deploy Preview for docs-eslint ready!

Name	Link
🔨 Latest commit	`723b4e1`
🔍 Latest deploy log	https://app.netlify.com/sites/docs-eslint/deploys/64252b6349a51e00083a76be
😎 Deploy Preview	https://deploy-preview-16687--docs-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

docs/src/_includes/components/language-switcher.html

amareshsm

LGTM . I would like someone else to double-check.

nzakas · 2023-02-07T21:17:08Z

@mdjermanovic can you review this to make sure your concerns were addressed?

mdjermanovic · 2023-02-08T08:44:39Z

I think #16687 (comment) hasn't been addressed yet.

docs/src/_includes/components/language-switcher.html

github-actions · 2023-02-19T22:31:25Z

Hi everyone, it looks like we lost track of this pull request. Please review and see what the next steps are. This pull request will auto-close in 7 days without an update.

amareshsm · 2023-02-20T02:28:48Z

Bump

nzakas · 2023-03-01T22:17:44Z

@amareshsm please don't leave "bump" comments, as they just create noise and don't add anything to the discussion.

If you're waiting for a particular response, please mention that.

@kecrily @mdjermanovic it looks like we are looking for feedback from you on this?

mdjermanovic

When browsing the HEAD version, the language dropdown shows "English (US) (Latest)" as the selected item, which would be confusing since the version being browsed is not the latest version:

mdjermanovic · 2023-03-10T09:59:36Z

docs/src/_includes/components/language-switcher.html

+                data-url="https://{{ other_site.hostname }}/docs/latest{{ page.url | prettyURL }}"
+                {% if site.language.code==other_site.language.code %}selected{% endif %}
+            >
+                {{ other_site.language.flag }} {{ other_site.language.name }}{% if site.language.code!=other_site.language.code and not isLatest %} ({{ other_site.footer.language_switcher.latest }}){% endif %}


This logic makes sense to me, but I'm not sure if shortcodes can be used in this context. I tried this locally with BRANCH=latest env variable, and (最新) still appears. This probably means that isLatest in this context refers to a global variable that doesn't exist so not isLatest is always true.

We have a global variable GIT_BRANCH that we're already using in the version switcher component, so we could use it here as well:

Suggested change

{{ other_site.language.flag }} {{ other_site.language.name }}{% if site.language.code!=other_site.language.code and not isLatest %} ({{ other_site.footer.language_switcher.latest }}){% endif %}

{{ other_site.language.flag }} {{ other_site.language.name }}{% if site.language.code!=other_site.language.code and GIT_BRANCH!="latest" %} ({{ other_site.footer.language_switcher.latest }}){% endif %}

(最新) still appear is the expected behavior, it means that if you select it you will choose to jump to the latest Chinese site.

But it's great to be able to reuse existing variables, thanks for the reminder

(最新) still appear is the expected behavior, it means that if you select it you will choose to jump to the latest Chinese site.

Isn't the expected behavior that (最新) doesn't appear on eslint.org/docs/latest? I thought that was the goal of the not isLatest condition.

Isn't the expected behavior that (最新) doesn't appear on eslint.org/docs/latest? I thought that was the goal of the not isLatest condition.

@mdjermanovic If the language of the current site is different from the language of the target site, latest is always displayed. If the current language and the target language are the same, latest is displayed when the current site is latest.

nzakas · 2023-03-28T18:07:30Z

@mdjermanovic can you re-review this please?

docs/src/_includes/components/language-switcher.html

Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>

mdjermanovic

LGTM, thanks!

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [eslint](https://eslint.org) ([source](https://github.com/eslint/eslint)) | devDependencies | minor | [`8.37.0` -> `8.39.0`](https://renovatebot.com/diffs/npm/eslint/8.37.0/8.39.0) | --- ### Release Notes <details> <summary>eslint/eslint</summary> ### [`v8.39.0`](https://github.com/eslint/eslint/releases/tag/v8.39.0) [Compare Source](eslint/eslint@v8.38.0...v8.39.0) #### Features - [`3f7af9f`](eslint/eslint@3f7af9f) feat: Implement `SourceCode#markVariableAsUsed()` ([#17086](eslint/eslint#17086)) (Nicholas C. Zakas) #### Documentation - [`6987dc5`](eslint/eslint@6987dc5) docs: Fix formatting in Custom Rules docs ([#17097](eslint/eslint#17097)) (Milos Djermanovic) - [`4ee92e5`](eslint/eslint@4ee92e5) docs: Update README (GitHub Actions Bot) - [`d8e9887`](eslint/eslint@d8e9887) docs: Custom Rules cleanup/expansion ([#16906](eslint/eslint#16906)) (Ben Perlmutter) - [`1fea279`](eslint/eslint@1fea279) docs: Clarify how to add to tsc agenda ([#17084](eslint/eslint#17084)) (Nicholas C. Zakas) - [`970ef1c`](eslint/eslint@970ef1c) docs: Update triage board location (Nicholas C. Zakas) - [`6d8bffd`](eslint/eslint@6d8bffd) docs: Update README (GitHub Actions Bot) #### Chores - [`60a6f26`](eslint/eslint@60a6f26) chore: upgrade [@eslint/js](https://github.com/eslint/js)[@8](https://github.com/8).39.0 ([#17102](eslint/eslint#17102)) (Milos Djermanovic) - [`d5ba5c0`](eslint/eslint@d5ba5c0) chore: package.json update for [@eslint/js](https://github.com/eslint/js) release (ESLint Jenkins) - [`f57eff2`](eslint/eslint@f57eff2) ci: run tests on Node.js v20 ([#17093](eslint/eslint#17093)) (Nitin Kumar) - [`9d1b8fc`](eslint/eslint@9d1b8fc) perf: Binary search in token store `utils.search` ([#17066](eslint/eslint#17066)) (Francesco Trotta) - [`07a4435`](eslint/eslint@07a4435) chore: Add request for minimal repro to bug report ([#17081](eslint/eslint#17081)) (Nicholas C. Zakas) - [`eac4943`](eslint/eslint@eac4943) refactor: remove unnecessary use of `SourceCode#getAncestors` in rules ([#17075](eslint/eslint#17075)) (Milos Djermanovic) - [`0a7b60a`](eslint/eslint@0a7b60a) chore: update description of `SourceCode#getDeclaredVariables` ([#17072](eslint/eslint#17072)) (Milos Djermanovic) - [`6e2df71`](eslint/eslint@6e2df71) chore: remove unnecessary references to the LICENSE file ([#17071](eslint/eslint#17071)) (Milos Djermanovic) ### [`v8.38.0`](https://github.com/eslint/eslint/releases/tag/v8.38.0) [Compare Source](eslint/eslint@v8.37.0...v8.38.0) #### Features - [`a1d561d`](eslint/eslint@a1d561d) feat: Move getDeclaredVariables and getAncestors to SourceCode ([#17059](eslint/eslint#17059)) (Nicholas C. Zakas) #### Bug Fixes - [`1c1ece2`](eslint/eslint@1c1ece2) fix: do not report on `RegExp(...args)` in `require-unicode-regexp` ([#17037](eslint/eslint#17037)) (Francesco Trotta) #### Documentation - [`7162d34`](eslint/eslint@7162d34) docs: Mention new config system is complete ([#17068](eslint/eslint#17068)) (Nicholas C. Zakas) - [`0fd6bb2`](eslint/eslint@0fd6bb2) docs: Update README (GitHub Actions Bot) - [`c83531c`](eslint/eslint@c83531c) docs: Update/remove external links, eg. point to `eslint-community` ([#17061](eslint/eslint#17061)) (Pelle Wessman) - [`a3aa6f5`](eslint/eslint@a3aa6f5) docs: Clarify `no-div-regex` rule docs ([#17051](eslint/eslint#17051)) (Francesco Trotta) - [`b0f11cf`](eslint/eslint@b0f11cf) docs: Update README (GitHub Actions Bot) - [`da8d52a`](eslint/eslint@da8d52a) docs: Update the second object instance for the "no-new" rule ([#17020](eslint/eslint#17020)) (Ahmadou Waly NDIAYE) - [`518130a`](eslint/eslint@518130a) docs: switch language based on current path ([#16687](eslint/eslint#16687)) (Percy Ma) - [`24206c4`](eslint/eslint@24206c4) docs: Update README (GitHub Actions Bot) #### Chores - [`59ed060`](eslint/eslint@59ed060) chore: upgrade [@eslint/js](https://github.com/eslint/js)[@8](https://github.com/8).38.0 ([#17069](eslint/eslint#17069)) (Milos Djermanovic) - [`88c0898`](eslint/eslint@88c0898) chore: package.json update for [@eslint/js](https://github.com/eslint/js) release (ESLint Jenkins) - [`cf682d2`](eslint/eslint@cf682d2) refactor: simplify new-parens rule schema ([#17060](eslint/eslint#17060)) (MHO) - [`0dde022`](eslint/eslint@0dde022) ci: bump actions/add-to-project from 0.4.1 to 0.5.0 ([#17055](eslint/eslint#17055)) (dependabot\[bot]) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  Co-authored-by: cabr2-bot <cabr2.help@gmail.com> Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1852 Reviewed-by: Epsilon_02 <epsilon_02@noreply.codeberg.org> Co-authored-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org> Co-committed-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>

docs: switch language based on current path

a01a222

ref eslint/eslint.org#380

kecrily requested a review from a team as a code owner December 20, 2022 13:56

eslint-github-bot bot added triage An ESLint team member will look at this issue soon documentation Relates to ESLint's documentation labels Dec 20, 2022

amareshsm added accepted There is consensus among the team that this change meets the criteria for inclusion and removed triage An ESLint team member will look at this issue soon labels Dec 20, 2022

mdjermanovic reviewed Dec 23, 2022

View reviewed changes

docs/src/_includes/components/language-switcher.html Outdated Show resolved Hide resolved

Merge branch 'main' of https://github.com/eslint/eslint into docs/path

fcf6e8e

mdjermanovic reviewed Dec 24, 2022

View reviewed changes

docs/src/_includes/components/language-switcher.html Outdated Show resolved Hide resolved

amareshsm approved these changes Dec 26, 2022

View reviewed changes

kecrily requested a review from mdjermanovic February 8, 2023 09:09

mdjermanovic reviewed Feb 9, 2023

View reviewed changes

docs/src/_includes/components/language-switcher.html Outdated Show resolved Hide resolved

harish-sethuraman reviewed Feb 9, 2023

View reviewed changes

docs/src/_includes/components/language-switcher.html Show resolved Hide resolved

github-actions bot added the Stale label Feb 19, 2023

Rec0iL99 removed the Stale label Feb 20, 2023

mdjermanovic requested changes Mar 2, 2023

View reviewed changes

kecrily requested a review from mdjermanovic March 10, 2023 07:20

mdjermanovic reviewed Mar 10, 2023

View reviewed changes

fix: redirect to latest when version isn't latest

4d7944f

kecrily force-pushed the docs/path branch from f2f064c to 4d7944f Compare March 22, 2023 08:07

mdjermanovic reviewed Mar 28, 2023

View reviewed changes

docs/src/_includes/components/language-switcher.html Outdated Show resolved Hide resolved

Update docs/src/_includes/components/language-switcher.html

723b4e1

Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>

mdjermanovic approved these changes Apr 1, 2023

View reviewed changes

mdjermanovic merged commit 518130a into main Apr 1, 2023
21 checks passed

mdjermanovic deleted the docs/path branch April 1, 2023 23:11

github-actions bot mentioned this pull request May 2, 2023

Upgraded some dependencies - Attempt 2 AurorNZ/report-updated-dependencies#638

Merged

mdjermanovic mentioned this pull request May 27, 2023

Bug: Documentation licensed under non-OSS compatible license #17225

Closed

eslint-github-bot bot locked and limited conversation to collaborators Sep 29, 2023

eslint-github-bot bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Sep 29, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: switch language based on current path #16687

docs: switch language based on current path #16687

kecrily commented Dec 20, 2022 •

edited

netlify bot commented Dec 20, 2022 •

edited

amareshsm left a comment •

edited

nzakas commented Feb 7, 2023

mdjermanovic commented Feb 8, 2023

github-actions bot commented Feb 19, 2023

amareshsm commented Feb 20, 2023

nzakas commented Mar 1, 2023

mdjermanovic left a comment

mdjermanovic Mar 10, 2023

kecrily Mar 10, 2023

mdjermanovic Mar 14, 2023

kecrily Mar 22, 2023

nzakas commented Mar 28, 2023

mdjermanovic left a comment

	{{ other_site.language.flag }} {{ other_site.language.name }}{% if site.language.code!=other_site.language.code and not isLatest %} ({{ other_site.footer.language_switcher.latest }}){% endif %}
	{{ other_site.language.flag }} {{ other_site.language.name }}{% if site.language.code!=other_site.language.code and GIT_BRANCH!="latest" %} ({{ other_site.footer.language_switcher.latest }}){% endif %}

docs: switch language based on current path #16687

docs: switch language based on current path #16687

Conversation

kecrily commented Dec 20, 2022 • edited

Prerequisites checklist

What is the purpose of this pull request? (put an "X" next to an item)

What changes did you make? (Give an overview)

Is there anything you'd like reviewers to focus on?

netlify bot commented Dec 20, 2022 • edited

✅ Deploy Preview for docs-eslint ready!

amareshsm left a comment • edited

Choose a reason for hiding this comment

nzakas commented Feb 7, 2023

mdjermanovic commented Feb 8, 2023

github-actions bot commented Feb 19, 2023

amareshsm commented Feb 20, 2023

nzakas commented Mar 1, 2023

mdjermanovic left a comment

Choose a reason for hiding this comment

mdjermanovic Mar 10, 2023

Choose a reason for hiding this comment

kecrily Mar 10, 2023

Choose a reason for hiding this comment

mdjermanovic Mar 14, 2023

Choose a reason for hiding this comment

kecrily Mar 22, 2023

Choose a reason for hiding this comment

nzakas commented Mar 28, 2023

mdjermanovic left a comment

Choose a reason for hiding this comment

kecrily commented Dec 20, 2022 •

edited

netlify bot commented Dec 20, 2022 •

edited

amareshsm left a comment •

edited