docs: deploy prerelease docs under the `/docs/next/` path #16541

snitin315 · 2022-11-12T01:50:44Z

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)

Resolve #16041

Update Makefile.js to push to the next branch during prerelease.
Update the docs site to use pathPrefix of /docs/next/ when deployed from the next branch.
Update the drop-down to include “NEXT” beneath “HEAD”.

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

netlify · 2022-11-12T01:51:12Z

✅ Deploy Preview for docs-eslint ready!

Name	Link
🔨 Latest commit	`2d18f58`
🔍 Latest deploy log	https://app.netlify.com/sites/docs-eslint/deploys/63bd399143558d0008a58c68
😎 Deploy Preview	https://deploy-preview-16541--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.

kecrily

LGTM

Makefile.js

mdjermanovic · 2022-11-13T23:42:06Z

This file should also be updated:

https://github.com/eslint/eslint/blob/main/docs/src/_includes/partials/versions-list.html

That list appears here:

https://deploy-preview-16541--docs-eslint.netlify.app/versions/

docs/.eleventy.js

Makefile.js

docs/.eleventy.js

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

Makefile.js

docs/.eleventy.js

Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>

docs/.eleventy.js

nzakas

LGTM. Just waiting for @mdjermanovic to review.

amareshsm

LGTM

mdjermanovic

LGTM, thanks!

I'm just not sure if we should merge this now because NEXT would appear in version switchers but there's no next version of the docs yet, so if someone selects it they'll get 404 on https://eslint.org/docs/next/.

nzakas · 2022-11-30T21:20:17Z

Yeah, we don't want NEXT to show up in the dropdown until we have an actual major prerelease. Can we disable that using a data file so it's easy to update?

mdjermanovic

Requesting a change to prevent accidental merging until #16541 (comment) is addressed.

snitin315 · 2022-12-02T15:31:08Z

I'll update it.

nzakas · 2022-12-26T21:11:24Z

@snitin315 are you still working on this?

snitin315 · 2022-12-27T00:13:58Z

@nzakas yes, I'll update the PR by today/tomorrow.

snitin315 · 2022-12-31T12:05:38Z

@mdjermanovic @nzakas I've addressed #16541 (comment) via adding a showNextVersion key in the config.json file.

nzakas

LGTM. Just waiting for @mdjermanovic to approve.

mdjermanovic · 2023-01-10T09:23:00Z

docs/src/_includes/components/nav-version-switcher.html

+            {% if config.showNextVersion == true %}
+                <option value="NEXT" data-url="/docs/next/" {% if GIT_BRANCH == "next" %}selected{% endif %}>NEXT</option>
+            {% endif %}
+            <option value="NEXT" data-url="/docs/next/" {% if GIT_BRANCH == "next" %}selected{% endif %}>NEXT</option>


The second <option value="NEXT" ... should be removed?

Yes, good catch.

Suggested change

{% if config.showNextVersion == true %}

<option value="NEXT" data-url="/docs/next/" {% if GIT_BRANCH == "next" %}selected{% endif %}>NEXT</option>

{% endif %}

<option value="NEXT" data-url="/docs/next/" {% if GIT_BRANCH == "next" %}selected{% endif %}>NEXT</option>

{% if config.showNextVersion == true %}

<option value="NEXT" data-url="/docs/next/" {% if GIT_BRANCH == "next" %}selected{% endif %}>NEXT</option>

{% endif %}

@mdjermanovic fixed.

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.31.0` -> `8.32.0`](https://renovatebot.com/diffs/npm/eslint/8.31.0/8.32.0) | --- ### Release Notes <details> <summary>eslint/eslint</summary> ### [`v8.32.0`](https://github.com/eslint/eslint/releases/tag/v8.32.0) [Compare Source](eslint/eslint@v8.31.0...v8.32.0) #### Features - [`fc20f24`](eslint/eslint@fc20f24) feat: add suggestions for redundant wrapping in prefer-regex-literals ([#16658](eslint/eslint#16658)) (YeonJuan) #### Bug Fixes - [`b4f8329`](eslint/eslint@b4f8329) fix: ignore directives for no-fallthrough ([#16757](eslint/eslint#16757)) (gfyoung) #### Documentation - [`17b65ad`](eslint/eslint@17b65ad) docs: IA Update page URL move ([#16665](eslint/eslint#16665)) (Ben Perlmutter) - [`5981296`](eslint/eslint@5981296) docs: fix theme switcher button ([#16752](eslint/eslint#16752)) (Sam Chen) - [`6669413`](eslint/eslint@6669413) docs: deploy prerelease docs under the `/docs/next/` path ([#16541](eslint/eslint#16541)) (Nitin Kumar) - [`78ecfe0`](eslint/eslint@78ecfe0) docs: use inline code for rule options name ([#16768](eslint/eslint#16768)) (Percy Ma) - [`fc2ea59`](eslint/eslint@fc2ea59) docs: Update README (GitHub Actions Bot) - [`762a872`](eslint/eslint@762a872) docs: Update README (GitHub Actions Bot) #### Chores - [`2952d6e`](eslint/eslint@2952d6e) chore: sync templates/\*.md files with issue templates ([#16758](eslint/eslint#16758)) (gfyoung) - [`3e34418`](eslint/eslint@3e34418) chore: Add new issues to triage project ([#16740](eslint/eslint#16740)) (Nicholas C. Zakas) </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/1734 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: deploy prerelease docs under the /next path

29ebad4

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

kecrily approved these changes Nov 12, 2022

View reviewed changes

snitin315 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 Nov 12, 2022

harish-sethuraman approved these changes Nov 12, 2022

View reviewed changes

mdjermanovic requested changes Nov 13, 2022

View reviewed changes

Makefile.js Outdated Show resolved Hide resolved

nzakas requested changes Nov 14, 2022

View reviewed changes

docs/.eleventy.js Outdated Show resolved Hide resolved

Makefile.js Outdated Show resolved Hide resolved

docs: deploy prerelease docs under the /docs/next/ path

0abff15

snitin315 commented Nov 16, 2022

View reviewed changes

Makefile.js Show resolved Hide resolved

snitin315 added 2 commits November 16, 2022 07:06

docs: fix versions list

37fb000

docs: fix versions page

e9f12d0

mdjermanovic requested changes Nov 17, 2022

View reviewed changes

docs/.eleventy.js Outdated Show resolved Hide resolved

fix: update docs/.eleventy.js

4743304

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

nzakas requested changes Nov 22, 2022

View reviewed changes

Makefile.js Show resolved Hide resolved

docs/.eleventy.js Outdated Show resolved Hide resolved

docs: update docs/.eleventy.js

16ae716

Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>

snitin315 commented Nov 23, 2022

View reviewed changes

docs/.eleventy.js Outdated Show resolved Hide resolved

docs: fix lint

ae668f2

nzakas approved these changes Nov 23, 2022

View reviewed changes

amareshsm approved these changes Nov 27, 2022

View reviewed changes

mdjermanovic approved these changes Nov 28, 2022

View reviewed changes

mdjermanovic requested changes Dec 2, 2022

View reviewed changes

docs: show NEXT based on config

336a58f

snitin315 requested a review from a team as a code owner December 31, 2022 11:46

nzakas approved these changes Jan 2, 2023

View reviewed changes

mdjermanovic reviewed Jan 10, 2023

View reviewed changes

docs: update docs/src/_includes/components/nav-version-switcher.html

2d18f58

mdjermanovic approved these changes Jan 11, 2023

View reviewed changes

mdjermanovic merged commit 6669413 into main Jan 11, 2023
21 checks passed

mdjermanovic deleted the docs/pre-release branch January 11, 2023 18:26

docs: deploy prerelease docs under the `/docs/next/` path #16541

docs: deploy prerelease docs under the `/docs/next/` path #16541

snitin315 commented Nov 12, 2022

netlify bot commented Nov 12, 2022 •

edited

kecrily left a comment

mdjermanovic commented Nov 13, 2022

nzakas left a comment

amareshsm left a comment

mdjermanovic left a comment

nzakas commented Nov 30, 2022

mdjermanovic left a comment

snitin315 commented Dec 2, 2022

nzakas commented Dec 26, 2022

snitin315 commented Dec 27, 2022

snitin315 commented Dec 31, 2022

nzakas left a comment

mdjermanovic Jan 10, 2023

snitin315 Jan 10, 2023

snitin315 Jan 10, 2023

mdjermanovic left a comment

docs: deploy prerelease docs under the /docs/next/ path #16541

docs: deploy prerelease docs under the /docs/next/ path #16541

Conversation

snitin315 commented Nov 12, 2022

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 Nov 12, 2022 • edited

✅ Deploy Preview for docs-eslint ready!

kecrily left a comment

Choose a reason for hiding this comment

mdjermanovic commented Nov 13, 2022

nzakas left a comment

Choose a reason for hiding this comment

amareshsm left a comment

Choose a reason for hiding this comment

mdjermanovic left a comment

Choose a reason for hiding this comment

nzakas commented Nov 30, 2022

mdjermanovic left a comment

Choose a reason for hiding this comment

snitin315 commented Dec 2, 2022

nzakas commented Dec 26, 2022

snitin315 commented Dec 27, 2022

snitin315 commented Dec 31, 2022

nzakas left a comment

Choose a reason for hiding this comment

mdjermanovic Jan 10, 2023

Choose a reason for hiding this comment

snitin315 Jan 10, 2023

Choose a reason for hiding this comment

snitin315 Jan 10, 2023

Choose a reason for hiding this comment

mdjermanovic left a comment

Choose a reason for hiding this comment

docs: deploy prerelease docs under the `/docs/next/` path #16541

docs: deploy prerelease docs under the `/docs/next/` path #16541

netlify bot commented Nov 12, 2022 •

edited