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] Fix docs feedback widget not working #4905

Merged
merged 1 commit into from May 27, 2022

Conversation

cherniavskii
Copy link
Member

@cherniavskii cherniavskii commented May 16, 2022

I've noticed that feedback widget on MUI X docs website doesn't work:

Screenshot 2022-05-16 at 12 50 10

The reason is missing FEEDBACK_URL was missing in MUI X env.

Preview: https://deploy-preview-4905--material-ui-x.netlify.app/x/advanced-components/

@mui-bot
Copy link

mui-bot commented May 16, 2022

These are the results for the performance tests:

Test case Unit Min Max Median Mean σ
Filter 100k rows ms 276.6 517.1 408.8 401.06 97.257
Sort 100k rows ms 561.9 907.5 804.6 782.5 127.08
Select 100k rows ms 91.1 200.2 180.1 157.1 37.904
Deselect 100k rows ms 112.4 204.8 154.4 160.26 33.218

Generated by 🚫 dangerJS against ac8f9ba

docs/.env Outdated
@@ -0,0 +1 @@
FEEDBACK_URL=https://hgvi836wi8.execute-api.us-east-1.amazonaws.com
Copy link
Member

Choose a reason for hiding this comment

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

It could be an environment variable set by Netlify.

@oliviertassinari @mbrookes Is there a reason that forces to use docs/.env instead of an envvar? I didn't find any comment considering this option in mui/material-ui#22885

Copy link
Member

@mbrookes mbrookes May 16, 2022

Choose a reason for hiding this comment

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

I don't recall any specific reason, so probably just an implementation issue. I do remember that I found other issues (unrelated to this), but the record of those is lost in a Slack comment (I should really have opened a GitHub issue), and I haven't looked at it since. It certainly isn't perfect, so feel free to improve it in whatever way you see fit.

Copy link
Member Author

Choose a reason for hiding this comment

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

I'll move it to Netlify environment then

Copy link
Member

Choose a reason for hiding this comment

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

Form my perspective, MUI X shouldn't have to do anything to benefit from this feature, it should be fully isolated in the main repository, so no env variables. I'm adding this note to: https://www.notion.so/mui-org/Docs-page-feedback-rating-58166afbb53649c9ab873e646a637c8a#1a2cf3e6196d4b218b67169f811e280a

@cherniavskii cherniavskii merged commit 204f47b into mui:master May 27, 2022
@cherniavskii cherniavskii deleted the docs-feedback-widget branch May 27, 2022 13:32
@oliviertassinari oliviertassinari added bug 🐛 Something doesn't work docs Improvements or additions to the documentation labels May 27, 2022
alexfauquette pushed a commit to alexfauquette/mui-x that referenced this pull request Aug 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug 🐛 Something doesn't work docs Improvements or additions to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants