New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
chore: Refactor docs to work with docs.eslint.org #15744
Conversation
Makefile.js
Outdated
@@ -622,7 +622,12 @@ target.gensite = function(prereleaseVersion) { | |||
|
|||
// 3. Copy docs folder to a temporary directory | |||
echo("> Copying the docs folder (Step 3)"); | |||
cp("-rf", "docs/*", TEMP_DIR); | |||
docFiles.forEach(filePath => { | |||
cp("-rf", `docs/src${filePath}*`, `${TEMP_DIR}/${filePath}`); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm getting Error: cp: dest is not a directory (too many sources)
here.
`${TEMP_DIR}/${filePath}`
evaluates to ./tmp///rules/
, there are two extra slashes.
We should update edit links, too: Line 700 in f535e15
For example, this evaluates to |
Oh nice catch. I've updated the edit links and fixed the copying. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.12.0` -> `8.13.0`](https://renovatebot.com/diffs/npm/eslint/8.12.0/8.13.0) | --- ### Release Notes <details> <summary>eslint/eslint</summary> ### [`v8.13.0`](https://github.com/eslint/eslint/releases/v8.13.0) [Compare Source](eslint/eslint@v8.12.0...v8.13.0) #### Features - [`274acbd`](eslint/eslint@274acbd) feat: fix no-eval logic for `this` in arrow functions ([#​15755](eslint/eslint#15755)) (Milos Djermanovic) #### Bug Fixes - [`97b57ae`](eslint/eslint@97b57ae) fix: invalid operator in operator-assignment messages ([#​15759](eslint/eslint#15759)) (Milos Djermanovic) #### Documentation - [`c32482e`](eslint/eslint@c32482e) docs: Typo in space-infix-ops docs ([#​15754](eslint/eslint#15754)) (kmin-jeong) - [`f2c2d35`](eslint/eslint@f2c2d35) docs: disambiguate types `FormatterFunction` and `LoadedFormatter` ([#​15727](eslint/eslint#15727)) (Francesco Trotta) #### Chores - [`bb4c0d5`](eslint/eslint@bb4c0d5) chore: Refactor docs to work with docs.eslint.org ([#​15744](eslint/eslint#15744)) (Nicholas C. Zakas) - [`d36f12f`](eslint/eslint@d36f12f) chore: remove `lib/init` from eslint config ([#​15748](eslint/eslint#15748)) (Milos Djermanovic) - [`a59a4e6`](eslint/eslint@a59a4e6) chore: replace `trimLeft`/`trimRight` with `trimStart`/`trimEnd` ([#​15750](eslint/eslint#15750)) (Milos Djermanovic) </details> --- ### Configuration 📅 **Schedule**: 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. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, click this checkbox. --- 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/1296 Reviewed-by: crapStone <crapstone@noreply.codeberg.org> Co-authored-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org> Co-committed-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>
* chore: Refactor docs to work with docs.eslint.org * Fix Makefile.js * fix copying of files * Fix edit links and copying commands
…)" This reverts commit 97e0137.
Prerequisites checklist
What is the purpose of this pull request? (put an "X" next to an item)
[ ] 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
[x] Other, please explain:
Refactored docs structure.
What changes did you make? (Give an overview)
I reorganized the docs folder in preparation for the new docs.eslint.org. Mostly, this meant moving the markdown files from directly under
docs
to inside ofdocs/src
. I did rename a couple of files and then updatedMakefile.js
to ensure it's reading from the correct locations and copying to the correct locations during a release.This is just the first step to help make these files compatible with docs.eslint.org.
Is there anything you'd like reviewers to focus on?
Did I miss anything?