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-deprecated eslint-deprecated bot added the triage An ESLint team member will look at this issue soon label Oct 1, 2020
@mdjermanovic mdjermanovic added documentation Relates to ESLint's documentation evaluating The team will evaluate this issue to decide whether it meets the criteria for inclusion and removed triage An ESLint team member will look at this issue soon labels Oct 18, 2020
@mdjermanovic
Copy link
Member

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

@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

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

@khawarlatifkhan
Copy link
Contributor

@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

Marking as accepted then.

@mdjermanovic mdjermanovic added accepted There is consensus among the team that this change meets the criteria for inclusion and removed evaluating The team will evaluate this issue to decide whether it meets the criteria for inclusion labels Oct 20, 2020
Copy link
Member

@mdjermanovic mdjermanovic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

@mdjermanovic mdjermanovic merged commit dee0f77 into eslint:master Oct 22, 2020
@mdjermanovic
Copy link
Member

Thanks for contributing!

@eslint-github-bot eslint-github-bot bot locked and limited conversation to collaborators Apr 21, 2021
@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 Apr 21, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion 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