Skip to content
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

Docs: remove duplicate code path analysis document #15033

Merged
merged 1 commit into from Sep 8, 2021

Conversation

mdjermanovic
Copy link
Member

@mdjermanovic mdjermanovic commented Sep 6, 2021

Prerequisites checklist

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 autofixing to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:

We have two same documents about code path analysis:

(A) https://github.com/eslint/eslint/blob/master/docs/developer-guide/code-path-analysis.md
(B) https://github.com/eslint/eslint/blob/master/docs/developer-guide/code-path-analysis/README.md

Links in other documents are pointing to (A).

This is (A) on our website: https://eslint.org/docs/developer-guide/code-path-analysis

(B) is actually inaccessible on our website (unless someone adds /index.html to the URL) due to Netlify's default rules which redirect foo/bar/ to foo/bar if there's foo/bar.html file on the server. https://eslint.org/docs/developer-guide/code-path-analysis/ would be (B) but it redirects to (A).

In #14886, we updated only (B). It took me time to figure out why the change doesn't appear on https://eslint.org/docs/8.0.0/developer-guide/code-path-analysis, and then I updated (A) manually on the website (eslint/archive-website#865).

In #14287 we updated both documents with seemingly same changes, but the change in (B) was slightly different and wrong.

Maintaining two documents with the same content is obviously error-prone, so I think we should remove one of them.

What changes did you make? (Give an overview)

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

If anyone wants to double-check the final version in (A), I compared (A) and (B) locally and the only differences I could find were:

@mdjermanovic mdjermanovic added the documentation Relates to ESLint's documentation label Sep 6, 2021
nzakas
nzakas approved these changes Sep 8, 2021
Copy link
Member

@nzakas nzakas left a comment

LGTM. Nice catch.

@aladdin-add aladdin-add merged commit dd56631 into master Sep 8, 2021
14 checks passed
@aladdin-add aladdin-add deleted the codepathanalysis-dupe-docs branch Sep 8, 2021
@eslint-github-bot eslint-github-bot bot locked and limited conversation to collaborators Mar 8, 2022
@eslint-github-bot 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 Mar 8, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
archived due to age This issue has been archived; please open a new issue for any further discussion documentation Relates to ESLint's documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants