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

Split data binding page in docs #1996

Merged
merged 13 commits into from
May 17, 2023

Conversation

apedroferreira
Copy link
Member

@apedroferreira apedroferreira commented May 10, 2023

@apedroferreira apedroferreira added the docs Improvements or additions to the documentation label May 10, 2023
@apedroferreira apedroferreira self-assigned this May 10, 2023
@apedroferreira apedroferreira changed the title Split data binding Split data binding page in docs May 10, 2023
Let me know how it looks, also if it should be recorded in light mode.
Compressed gif with zooming
mp4 is 500KB while gif was 1MB. Also, I think having video controls is helpful as one can make it fullscreen, pause.
This is just an ongoing experimentation, will further improve this.
<!-- <img src="/static/toolpad/docs/data-binding/bind-16.gif" alt="Binding result" width="902px" // style="margin-bottom: 8px;" />
!-->

<video autoplay muted loop playsinline controls>
Copy link
Member

Choose a reason for hiding this comment

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

Can you verify whether we're efficiently serving these videos? https://stackoverflow.com/a/10330501

Copy link
Member

@prakhargupta1 prakhargupta1 May 16, 2023

Choose a reason for hiding this comment

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

Yes, in the HTTP headers following conditions are being met: Content-Type: video/mp4 and Accept-Ranges: bytes, and no Content-Encoding.

The video was recorded in dark theme and as discussed yesterday, it should be in light theme so, we'll have to remove these commits.

@prakhargupta1 prakhargupta1 linked an issue May 15, 2023 that may be closed by this pull request
15 tasks
!-->

<video autoplay muted loop playsinline controls>
<source src="/static/toolpad/docs/data-binding/bind-17.mp4" type="video/mp4">
Copy link
Member

Choose a reason for hiding this comment

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

Toolpad is in dark mode in this video

Copy link
Member

@Janpot Janpot left a comment

Choose a reason for hiding this comment

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

Gonna approve already but left two comments with minor issues

Co-authored-by: Jan Potoms <2109932+Janpot@users.noreply.github.com>
Signed-off-by: Pedro Ferreira <10789765+apedroferreira@users.noreply.github.com>
@apedroferreira
Copy link
Member Author

apedroferreira commented May 16, 2023

@prakhargupta1 Will you handle the rest of this PR? I can assign it to you.

Let me know if I can help with anything else here or if there's anything else I could add or fix here.

Also, we discussed that maybe "Data binding" should not be its own section, but be inside some other section?
In that case if we have a final decision I can move them inside the right section in this PR.
I guess we could put it under "Building UI" but I don't mind it being its own section either.

Edit: actually I'll also have to rebase this on master after merging #1997, probably. Rebased.

@Janpot
Copy link
Member

Janpot commented May 16, 2023

In terms of docs structure, maybe we should just devote some sync meeting time and think about it holistically? In the meantime I don't think it should block merging this PR. It shouldn't be a big effort to rearrange pages afterwards.

@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label May 16, 2023
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label May 16, 2023
@prakhargupta1
Copy link
Member

@apedroferreira You can remove my commits as all of it was recorded in dark mode. I'll redo ot and create a separate PR.
Also, let's utilize coming Friday's product meeting to discuss docs structure.

@apedroferreira apedroferreira merged commit 7cfa487 into mui:master May 17, 2023
@apedroferreira apedroferreira deleted the split-data-binding branch May 17, 2023 18:43
@@ -1,6 +1,10 @@
import * as React from 'react';
import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs';
import { demos, docs, demoComponents } from '../../data/toolpad/data-binding.md?@mui/markdown';
Copy link
Member

Choose a reason for hiding this comment

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

Deleted pages need a redirection, fixed in #2083

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.

Docs to be added for following sections
4 participants