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
Refactored Installation page to no longer use tabs #11050
Refactored Installation page to no longer use tabs #11050
Conversation
Deploy preview ready! Built with commit 66b3e90 |
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.
OK
Can we maybe add a note to Babel section that once again mentions you don't need to configure anything if you use CRA? For some reason people just skip ahead there and get lost :-( |
Sounds like you have a somewhat specific idea of what you want to be added where, and I don't. Mind posting a follow-up a PR that does this? I'd be happy to review it. |
I don't really have a solution to that problem. (Well, tabs were a solution but they introduced other problems.) I just know that people don't read titles on one page, skip ahead, and then don't realise they've missed the section they needed. I've seen countless reports from people who tried CRA and then for some reason continued reading down and attempted to install webpack and Babel on top of it. They didn't believe CRA just works out of the box. They saw "Enabling JSX and ES6" and thought they need to do it even if it's in a completely separate section. |
I'd be happy to spend some time going over the docs with a fresh set of eyes, maybe trying to tackle some problems like this, if Sophie thinks it's worth the time spent. Will add it to the discussion notes for today's sync. |
Maybe it makes sense to just split these into three separate pages? |
@sophiebits Like I described in the PR description, "Breaking the sub-sections into their own pages" ? Or something else... |
Yes, that. 😳 |
Yeah, i'm not opposed to doing that. I mostly held off because I didn't know how many existing links it might break. (We can clearly search within the site and fix any internal ones, but I've been finding out there are a lot of external links to the site.) |
JS redirect? |
Yeah I guess we could do that but it seems...shitty. We would have to replace the |
Would this be different from any other time we move files around? Seems like if A redirects to B then we move B to a new page C, we need to add redirects from B to C regardless, and the chain A -> B -> C would work. Sorry if I'm misunderstanding something. |
Yes, in that it would be unexpected. As someone modifying markdown content in a |
Resolves #11043
The installation page previously used a one-off tab mechanism to visual limit the content shown on the screen. Unfortunately this mechanism did not work correctly in production on the new website, causing some links to show the incorrect content.
Ultimately this PR resolves the issue by removing all of the embedded HTML+CSS in the
installation.md
file in favor of standard markdown syntax. I believe this is the best short-term solution and that we can revisit the UI/UX of this page in the future to improve it (cc @joecritch).The anchor tags should now work correctly, eg https://deploy-preview-11050--reactjs.netlify.com//docs/installation.html#using-a-cdn
For posterity, I also considered the following alternative approaches.
Breaking the sub-sections into their own pages
Pros:
Cons:
/docs/installation.html#using-a-cdn
Keeping content in a single page but with side-nav headers
Pros:
Cons: