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: add TOC to user-guide/configuring.md #13727

Merged
merged 4 commits into from Oct 22, 2020

Conversation

@metasean
Copy link
Contributor

@metasean metasean commented Oct 1, 2020

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:

What changes did you make? (Give an overview)

Added a very basic Table of Contents to https://eslint.org/docs/user-guide/configuring / https://github.com/eslint/eslint/blob/master/docs/user-guide/configuring.md

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

https://github.com/metasean/eslint/blob/toc-for-contributing.md/docs/user-guide/configuring.md#configuring-eslint (scroll past the introductory text to see the TOC)

@eslint eslint bot added the triage label Oct 1, 2020
metasean added 2 commits Oct 1, 2020
@mdjermanovic
Copy link
Member

@mdjermanovic mdjermanovic commented Oct 18, 2020

Hi @metasean, thanks for the PR and sorry for the late response!

I think this would be a very useful addition. but we are currently reorganizing this document and that work will be done soon (#13632), so I'm not sure should we be making changes to this particular document in the meantime.

@kaicataldo what do you think about this?

@metasean
Copy link
Contributor Author

@metasean metasean commented Oct 19, 2020

@mdjermanovic - All I know is that I really hate having to search through this long page when I have a basic idea of what I'm looking for. (And I'm assuming I'm not the only one with this problem.)

So, as long as there's a better way to navigate all this information I'll be happy, regardless of whether that better way is based on this PR or on a re-organization of the documentation itself.

@kaicataldo
Copy link
Member

@kaicataldo kaicataldo commented Oct 19, 2020

I think this is fine. We will be updating this, but this seems useful in the interim. @khawarlatifkhan Thoughts?

@khawarlatifkhan
Copy link
Contributor

@khawarlatifkhan khawarlatifkhan commented Oct 20, 2020

@metasean this is really helpful. Thank you! We are currently working on the configuration documentation, both to reorganize the documentation and to improve its presentation. This TOC will def be helpful in the process.

@kaicataldo Thank you for pointing this out. Will keep this in mind as we move forward with the project.

@mdjermanovic
Copy link
Member

@mdjermanovic mdjermanovic commented Oct 20, 2020

Marking as accepted then.

@mdjermanovic mdjermanovic added accepted and removed evaluating labels Oct 20, 2020
Copy link
Member

@mdjermanovic mdjermanovic left a comment

I think that one link should be changed, everything else LGTM.

docs/user-guide/configuring.md Outdated Show resolved Hide resolved
Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
Copy link
Member

@mdjermanovic mdjermanovic left a comment

LGTM, thanks!

@mdjermanovic mdjermanovic merged commit dee0f77 into eslint:master Oct 22, 2020
12 checks passed
12 checks passed
Verify Files
Details
Test (ubuntu-latest, 14.x)
Details
Test (ubuntu-latest, 13.x)
Details
Test (ubuntu-latest, 12.x)
Details
Test (ubuntu-latest, 10.x)
Details
Test (ubuntu-latest, 10.12.0)
Details
Test (windows-latest, 12.x)
Details
Test (macOS-latest, 12.x)
Details
Browser Test
Details
commit-message PR title follows commit message guidelines
Details
licence/cla Contributor License Agreement is signed.
Details
release-monitor No patch release is pending
Details
@mdjermanovic
Copy link
Member

@mdjermanovic mdjermanovic commented Oct 22, 2020

Thanks for contributing!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

4 participants
You can’t perform that action at this time.