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] Batch of fixes #16229

Merged
merged 8 commits into from
Jun 15, 2019
Merged

Conversation

oliviertassinari
Copy link
Member

@oliviertassinari oliviertassinari commented Jun 14, 2019

@oliviertassinari oliviertassinari added the docs Improvements or additions to the documentation label Jun 14, 2019
@mui-pr-bot
Copy link

mui-pr-bot commented Jun 14, 2019

Details of bundle changes.

Comparing: 627da22...64bde33

bundle parsed diff gzip diff prev parsed current parsed prev gzip current gzip
@material-ui/core 0.00% 0.00% 318,911 318,911 87,557 87,557
@material-ui/core/Paper 0.00% 0.00% 68,281 68,281 20,353 20,353
@material-ui/core/Paper.esm 0.00% 0.00% 61,578 61,578 19,133 19,133
@material-ui/core/Popper 0.00% 0.00% 28,968 28,968 10,411 10,411
@material-ui/core/Textarea 0.00% 0.00% 5,513 5,513 2,374 2,374
@material-ui/core/TrapFocus 0.00% 0.00% 3,755 3,755 1,580 1,580
@material-ui/core/styles/createMuiTheme 0.00% 0.00% 16,012 16,012 5,791 5,791
@material-ui/core/useMediaQuery 0.00% 0.00% 2,597 2,597 1,102 1,102
@material-ui/lab 0.00% 0.00% 140,480 140,480 43,417 43,417
@material-ui/styles 0.00% 0.00% 51,703 51,703 15,337 15,337
@material-ui/system 0.00% 0.00% 15,266 15,266 4,333 4,333
Button 0.00% 0.00% 84,273 84,273 25,630 25,630
Modal 0.00% 0.00% 20,345 20,345 6,689 6,689
Slider 0.00% 0.00% 74,587 74,587 23,184 23,184
colorManipulator 0.00% 0.00% 3,904 3,904 1,544 1,544
docs.landing 0.00% 0.00% 55,232 55,232 13,946 13,946
docs.main +0.01% 🔺 +0.01% 🔺 650,961 651,017 205,016 205,042
packages/material-ui/build/umd/material-ui.production.min.js 0.00% 0.00% 292,168 292,168 83,484 83,484

Generated by 🚫 dangerJS against 64bde33

README.md Outdated Show resolved Hide resolved
Co-Authored-By: Aditya Shankar <[email protected]>
docs/static/_redirects Outdated Show resolved Hide resolved
@oliviertassinari oliviertassinari dismissed eps1lon’s stale review June 15, 2019 10:13

Updated. I also had to change the status code from 307 to 302 to make it work. e.g: https://material-ui.com/r/caveat-with-refs-guide KO

@oliviertassinari oliviertassinari merged commit 564aed3 into mui:master Jun 15, 2019
@oliviertassinari oliviertassinari deleted the docs-batch-v4 branch June 15, 2019 15:42
@SerdarSanri
Copy link

@oliviertassinari I noticed you removed all 3.x version documentation under v3 in documentation. and I assume it is 3.9.2 which was the last 3.x version. Is this means all releases prior to 3.9.2 are no longer supported? In many companies like ours, upgrading a package major like material-ui is not that quick and easy thing to do. we were at 3.8. Now I see that entire documentation is gone that it will be really difficult for us to find out components supported in that version and their props etc without diving in material-ui source. wouldn't that be better to keep those in a separate place like an archive and announce when they will be removed so people who are using it will be aware at x date it will no longer be supported.

@oliviertassinari
Copy link
Member Author

oliviertassinari commented Jun 24, 2019

@SerdarSanri is your team able to use https://v3.material-ui.com/? This documents v3.9.3.

@SerdarSanri
Copy link

@oliviertassinari We haven't upgraded to 3.9.2 yet. At least it is in our pipeline. I should have download documentation for 3.8. But because I don't have a reference what is different in between 3.8 and 3.9 it may cause issues. We may use components/props doesn't exist yet at 3.8 but introduced after.

@oliviertassinari
Copy link
Member Author

oliviertassinari commented Jun 24, 2019

I can imagine, we don't document the version the new APIs have been introduced. I have removed the subdomains of older documentation versions as the builtin search was broken, making it hard to use. The new strategy should prevent this problem with the v4.x versions when we release v5.

We may use components/props doesn't exist yet at 3.8 but introduced after.

If that's the case, you will need to upgrade to use it right? The upgrade between v3.8 and v3.9.3 should be straightforward. I would encourage this approach. Let's wait and see if we get more request for this.

@SerdarSanri
Copy link

would that be possible to at least provide compressed documentation to download. So we can download and deploy locally.

@oliviertassinari
Copy link
Member Author

@SerdarSanri Sure, you can clone the repository, checkout the version, run yarn, run yarn docs:dev.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

V3 docs website is down Search for v3 docs is broken
6 participants