Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

docs: split troubleshooting into granular sections#9024

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Conversation

JoshuaKGoldberg
Copy link
Member

@JoshuaKGoldbergJoshuaKGoldberg commentedApr 28, 2024
edited
Loading

PR Checklist

Overview

  • Move around the FAQs into a few new sections
  • Move aroundsidebar.base.js contents so the sidebar isn't now bigger than before
  • Add notes on followup issues we can file to fill out those new FAQs (💡!)
  • Add redirects so old user-facing code links included in code still work
BeforeAfter
Before screenshot showing the current menu with slightly more vertical heightAfter screenshot showing the updated menu with slightly less vertical height

💖

@typescript-eslint
Copy link
Contributor

Thanks for the PR,@JoshuaKGoldberg!

typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community.

The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately.

Thanks again!


🙏Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently onhttps://opencollective.com/typescript-eslint.

@netlifyNetlify
Copy link

netlifybot commentedApr 28, 2024
edited
Loading

Deploy Preview fortypescript-eslint ready!

NameLink
🔨 Latest commit33cf02a
🔍 Latest deploy loghttps://app.netlify.com/sites/typescript-eslint/deploys/6679ac1ec46bf20007a1094d
😎 Deploy Previewhttps://deploy-preview-9024--typescript-eslint.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 99 (🟢 up 1 from production)
Accessibility: 100 (no change from production)
Best Practices: 92 (no change from production)
SEO: 90 (no change from production)
PWA: 80 (no change from production)
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to yourNetlify site configuration.

@nx-cloudNx Cloud
Copy link

nx-cloudbot commentedApr 28, 2024
edited
Loading

☁️ Nx Cloud Report

CI is running/has finished running commands for commit33cf02a. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution


✅ Successfully ran 31 targets

Sent with 💌 fromNxCloud.

Copy link
MemberAuthor

@JoshuaKGoldbergJoshuaKGoldbergApr 28, 2024
edited
Loading

Choose a reason for hiding this comment

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

🤔 I'm on the fence of whether this deserves its own page. I think it could be moved to its own section inFAQs.mdx. Is there anything else we'd want to have here?

I was tempted to include typed linting.js info, but that's already covered inTyped Linting.

I'm leaning strongly towards this change (moving these two FAQs out) so we can reduce the size of theTroubleshooting portion of the sidebar.

Copy link
Member

@kirkwaiblingerkirkwaiblingerMay 11, 2024
edited
Loading

Choose a reason for hiding this comment

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

I think it's worth its own page! See also#8955 (comment)... maybe this is an opportunity to throw in an additional sentence or two that plenty of rules will have no effect on js files, but a few will enforce illegal syntax and must be disabled. And type-aware rules actuallycan work in js files.

Copy link
MemberAuthor

Choose a reason for hiding this comment

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

Yeah! Great. +1. I think that'd be an excellent followup to this (I suspect the discussion over how to phrase the.js recommendations might get long).

kirkwaiblinger reacted with thumbs up emoji
@JoshuaKGoldbergJoshuaKGoldberg requested review fromrubiesonthesky andJosh-Cena and removed request forrubiesontheskyMay 9, 2024 15:28
@JoshuaKGoldbergJoshuaKGoldberg marked this pull request as ready for reviewMay 9, 2024 15:29
@JoshuaKGoldbergJoshuaKGoldberg requested review froma team and removed request forrubiesontheskyMay 27, 2024 15:53
Copy link
Member

@kirkwaiblingerkirkwaiblinger left a comment

Choose a reason for hiding this comment

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

Overall looks sensible to me! A few teensy nits to resolve, and then a bunch of broken links, it looks like (including when using the search bar). But I'm assuming those are enforced by CI, rather than human eyes.
high five

@@ -1,189 +1,166 @@
---
id: faqs
title: FAQs
slug: /troubleshooting/
slug: /troubleshooting/faqs
Copy link
Member

Choose a reason for hiding this comment

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

This is going to break all of our historical links isn't it 😭

Maybe we need error code short URLs to make this easier huehuehue

Copy link
MemberAuthor

@JoshuaKGoldbergJoshuaKGoldbergMay 28, 2024
edited
Loading

Choose a reason for hiding this comment

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

It shouldn't with this redirects config! I really hope it doesn't. That'd be a bug if it does.

// in docusaurus.config.mts > redirects{from:'/troubleshooting',to:'/troubleshooting/faqs',},

But yeah strong +1 to error code short URLs.

@bradzacherbradzacher added the documentationDocumentation ("docs") that needs adding/updating labelMay 28, 2024
@bradzacher
Copy link
Member

bradzacher commentedJun 4, 2024
edited
Loading

PERSONALLY I don't love having valuable content on a page that's accessible via an expandable header.
EG/troubleshooting/faqs is accessible via theFAQs menu item and that menu item is expandable.
It's a confusing UX paradigm, IMO. Cos if I click on the arrow to expand then I see no menu item for "general FAQ"s

I think that either:
a) there should only be cursory information in the link for the expandable item. eg/users and/developers just has a summary of the section. Or
b) there should be a concrete menu item for that page so that it shows up in the expanded list. EG if you click on the "Getting Started" heading it is also available as the "Quickstart" sub-item.

I personally find all the time that I click the arrow and don't find what i'm looking for - only to realise that I actually wanted to click 10px to the left on the item itself.
The UX confusion is that so many sites treat an expandable section header purely as a button to expand the section. Others also do what docusaurus does and treats it as its own menu item AND as a button to expand the section.

I hate it, personally!
One other point against it. On mobile if you click on the heading instead of the arrow (which is really easy to fat finger and do accidentally) then the entire menu disappears and you see the page. So if you were trying to view a sub-menu item you need to re-open the menu again.

I do this all the time on my phone and I hate it. For example I've done this a few times:

  1. open typescript-eslint.io
  2. tap the hamburger to open the menu
  3. tap docs
  4. the menu disappears and I'm on the "getting started" page
  5. tap the hamburger
  6. tap to expand the "contributing" section
  7. accidentally fat-fingered it and tapped the heading instead of the arrow
  8. the menu disappears and I'm on the "contributing" page
  9. tap the hamburger a 3rd time
  10. now I can get to the sub items

Super clunky UX - I hate it.


So I'd suggest adding a "General" item beneath FAQs which allows you to see the "general FAQs".

JoshuaKGoldberg reacted with thumbs up emojiJoshuaKGoldberg reacted with heart emoji

@JoshuaKGoldbergJoshuaKGoldberg requested review frombradzacher and removed request forbradzacherJune 4, 2024 12:31
kirkwaiblinger
kirkwaiblinger previously approved these changesJun 21, 2024
@JoshuaKGoldberg
Copy link
MemberAuthor

So I'd suggest adding a "General" item beneath FAQs which allows you to see the "general FAQs".

Following up explicitly: I did this, so that when you click eitherTroubleshooting & FAQs orFAQs, it takes you to the childGeneral page. 👍

@codecovCodecov
Copy link

codecovbot commentedJun 22, 2024
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.17%. Comparing base(23e6468) to head(5e8c5c3).
Report is 1 commits behind head on main.

Current head5e8c5c3 differs from pull request most recent head33cf02a

Pleaseupload reports for the commit33cf02a to get more accurate results.

Additional details and impacted files
@@            Coverage Diff             @@##             main    #9024      +/-   ##==========================================- Coverage   88.17%   88.17%   -0.01%==========================================  Files         415      415                Lines       14363    14362       -1       Branches     4187     4187              ==========================================- Hits        12665    12664       -1  Misses       1381     1381                Partials      317      317
FlagCoverage Δ
unittest88.17% <ø> (-0.01%)⬇️

Flags with carried forward coverage won't be shown.Click here to find out more.

FilesCoverage Δ
packages/typescript-estree/src/convert.ts28.58% <ø> (ø)
...-estree/src/create-program/createProjectProgram.ts100.00% <ø> (ø)
...eate-program/validateDefaultProjectForFilesGlob.ts100.00% <ø> (ø)

... and1 file with indirect coverage changes

@JoshuaKGoldbergJoshuaKGoldbergforce-pushed thedocs-troubleshooting-sections branch fromd1ddbc2 to585423dCompareJune 22, 2024 19:55
@JoshuaKGoldberg
Copy link
MemberAuthor

JoshuaKGoldberg commentedJun 22, 2024
edited
Loading

Ugh. I messed up the Git merges. Will fix this in a bit.

Edit: done, I think.

@bradzacherbradzacher added the awaiting responseIssues waiting for a reply from the OP or another party labelJun 23, 2024
@JoshuaKGoldbergJoshuaKGoldbergforce-pushed thedocs-troubleshooting-sections branch from585423d tobafe6c8CompareJune 24, 2024 16:28
@JoshuaKGoldbergJoshuaKGoldbergforce-pushed thedocs-troubleshooting-sections branch from052c190 to03275e9CompareJune 24, 2024 17:15
@JoshuaKGoldberg
Copy link
MemberAuthor

I'm going to merge this now, because it's been sitting for a while and the merge conflicts keep getting more painful 😅. I think as a followup we'll want to do two things:

@JoshuaKGoldbergJoshuaKGoldberg merged commit635133a intotypescript-eslint:mainJun 24, 2024
60 of 61 checks passed
@github-actionsgithub-actionsbot locked asresolvedand limited conversation to collaboratorsJul 3, 2024
Sign up for freeto subscribe to this conversation on GitHub. Already have an account?Sign in.
Reviewers

@rubiesontheskyrubiesontheskyrubiesonthesky left review comments

@kirkwaiblingerkirkwaiblingerkirkwaiblinger left review comments

@Josh-CenaJosh-CenaAwaiting requested review from Josh-Cena

@bradzacherbradzacherAwaiting requested review from bradzacher

Assignees
No one assigned
Labels
awaiting responseIssues waiting for a reply from the OP or another partydocumentationDocumentation ("docs") that needs adding/updating
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Docs: Separate FAQs into discrete sections
5 participants
@JoshuaKGoldberg@bradzacher@rubiesonthesky@kirkwaiblinger@Josh-Cena

[8]ページ先頭

©2009-2025 Movatter.jp