[docs] Split the Editing page #7772

cherniavskii · 2023-01-31T10:18:59Z

Part of #7762

Changes:

split Editing page into multiple pages
move the editing recipes page to Editing -> Examples page

Preview: https://deploy-preview-7772--material-ui-x.netlify.app/x/react-data-grid/editing/

mui-bot · 2023-01-31T10:25:21Z

Netlify deploy preview

Netlify deploy preview: https://deploy-preview-7772--material-ui-x.netlify.app/

Updated pages

These are the results for the performance tests:

Test case	Unit	Min	Max	Median	Mean	σ
Filter 100k rows	ms	499.9	1,117.3	499.9	796.46	265.633
Sort 100k rows	ms	585.8	1,154.1	585.8	893.6	191.212
Select 100k rows	ms	189.4	394.7	286.7	294.36	66.653
Deselect 100k rows	ms	187.3	318.6	211	241.48	50.112

Generated by 🚫 dangerJS against 42c0caa

alexfauquette

Naming sounds nice. 👌

I did not read entirely the page content assuming it's copied past

I'm wondering, do you plan to add sections in "row editing" page. Otherwise, it could go to the overview page with

editMode="row" section between "making colums editable" and "value parser/setter"
CRUD example at then end

For the two other sections, they are shorts but very advanced and well-scoped, so not a problem

alexfauquette · 2023-02-02T09:16:36Z

docs/.link-check-errors.txt

@@ -2,5 +2,6 @@ Broken links found by `yarn docs:link-check` that exist:

 - https://mui.com/blog/material-ui-v4-is-out/#premium-themes-store-✨
 - https://mui.com/size-snapshot
+- https://mui.com/x/react-data-grid/editing/#row-editing


This will require an update of the material-ui repo. Especially the PricingTable.tsx

Yes, after releasing the v6 stable

github-actions · 2023-02-06T16:45:27Z

This pull request has conflicts, please resolve those before we can evaluate the pull request.

cherniavskii · 2023-02-08T18:08:29Z

I'm wondering, do you plan to add sections in "row editing" page. Otherwise, it could go to the overview page with

editMode="row" section between "making colums editable" and "value parser/setter"

CRUD example at then end

The CRUD example is part of the Row editing section, so I would rather not split them.

LukasTy

Looks great! 💯
A similar makeover (splitting into several smaller pages) has been done to the pickers getting started page quite successfully recently. 👍

docs/data/pages.ts

MBilalShafi · 2023-05-22T12:51:18Z

@cherniavskii Would you like to proceed with it or do you see a problem? I am trying to do a similar division of pages for Filtering.

cherniavskii · 2023-06-19T18:02:44Z

I've updated the PR and split the editing page again, here's the current structure: https://deploy-preview-7772--material-ui-x.netlify.app/x/react-data-grid/editing/

cherniavskii · 2023-06-19T18:08:22Z

docs/data/pages.ts

+ { pathname: '/x/react-data-grid/editing/persistence' },
+ { pathname: '/x/react-data-grid/editing/custom-edit-component' },
+ { pathname: '/x/react-data-grid/editing/editing-events' },
+ { pathname: '/x/react-data-grid/editing/recipes' },


We didn't reach an agreement on "Examples" vs "Recipes" in #7762 😅

I kept the previous title ("Recipes") for now, feel free to vote on this comment if you have a preference:

🚀 for "Recipes"

🎉 for "Examples"

@richbustos What do you think about this one?

richbustos

LGTM!

MBilalShafi

Nice update

MBilalShafi · 2023-07-03T09:30:04Z

docs/data/data-grid/editing/custom-edit-component.md

+
+<p class="description">Creating custom edit component.</p>
+
+## Create your own edit component


Could we discard this heading in favor of the main one (i.e Custom edit component)?

MBilalShafi · 2023-07-03T09:30:54Z

docs/data/data-grid/editing/editing-events.md

+
+<p class="description">Using editing events.</p>
+
+## Editing events


Same with this one?

MBilalShafi · 2023-07-03T09:33:38Z

docs/data/data-grid/editing/persistence.md

@@ -0,0 +1,59 @@
+# Data Grid - Editing Persistence


Since we only cover server-side persistence on this page, would it be better to call it Server-side persistence and discard the extra heading (i.e. Server-side persistence), or we plan to extend it with the other topics which fall under persistence?

github-actions · 2023-07-14T17:49:08Z

This pull request has conflicts, please resolve those before we can evaluate the pull request.

joserodolfofreitas

Bumping this awesome update.

cherniavskii added docs Improvements or additions to the documentation component: data grid This is the name of the generic UI component, not the React module! labels Jan 31, 2023

cherniavskii force-pushed the split-editing-page branch from a8cd03a to 3d1b6d3 Compare January 31, 2023 11:02

cherniavskii marked this pull request as ready for review January 31, 2023 11:15

cherniavskii mentioned this pull request Jan 31, 2023

[RFC] Improve Recipes discoverability #7762

Open

alexfauquette approved these changes Feb 2, 2023

View reviewed changes

github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Feb 6, 2023

LukasTy approved these changes Feb 16, 2023

View reviewed changes

docs/data/pages.ts Show resolved Hide resolved

cherniavskii mentioned this pull request May 31, 2023

[docs] Improve discoverability of Filtering section of docs #9074

Merged

cherniavskii added 4 commits June 19, 2023 19:30

extract persistence page

09fdd1f

extract custom edit component page

0c3e4aa

extract editing events page

4ef5ed2

move editing recipes to the editing docs group

2211a38

cherniavskii force-pushed the split-editing-page branch from 3d1b6d3 to 2211a38 Compare June 19, 2023 17:50

github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Jun 19, 2023

cherniavskii added 2 commits June 19, 2023 19:55

add redirect

cfd99d6

fix outdated links

42c0caa

cherniavskii commented Jun 19, 2023

View reviewed changes

cherniavskii requested review from joserodolfofreitas and richbustos June 19, 2023 18:08

cherniavskii changed the title ~~[DataGrid] Improve editing examples discoverability~~ [docs] Split Editing page Jun 20, 2023

romgrk approved these changes Jun 20, 2023

View reviewed changes

richbustos approved these changes Jun 23, 2023

View reviewed changes

cherniavskii changed the title ~~[docs] Split Editing page~~ [docs] Split the Editing page Jun 26, 2023

MBilalShafi approved these changes Jul 3, 2023

View reviewed changes

github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Jul 14, 2023

joserodolfofreitas approved these changes Aug 7, 2023

View reviewed changes

MBilalShafi changed the base branch from master to v6.x March 21, 2024 02:44

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[docs] Split the Editing page #7772

[docs] Split the Editing page #7772

cherniavskii commented Jan 31, 2023 •

edited

Loading

mui-bot commented Jan 31, 2023 •

edited

Loading

alexfauquette left a comment

alexfauquette Feb 2, 2023

cherniavskii Feb 8, 2023

github-actions bot commented Feb 6, 2023

cherniavskii commented Feb 8, 2023

LukasTy left a comment

MBilalShafi commented May 22, 2023 •

edited

Loading

cherniavskii commented Jun 19, 2023

cherniavskii Jun 19, 2023

cherniavskii Jun 26, 2023

richbustos left a comment

MBilalShafi left a comment

MBilalShafi Jul 3, 2023

MBilalShafi Jul 3, 2023

MBilalShafi Jul 3, 2023

github-actions bot commented Jul 14, 2023

joserodolfofreitas left a comment


		<p class="description">Creating custom edit component.</p>

		## Create your own edit component


		<p class="description">Using editing events.</p>

		## Editing events

[docs] Split the Editing page #7772

Are you sure you want to change the base?

[docs] Split the Editing page #7772

Conversation

cherniavskii commented Jan 31, 2023 • edited Loading

mui-bot commented Jan 31, 2023 • edited Loading

Netlify deploy preview

Updated pages

alexfauquette left a comment

Choose a reason for hiding this comment

alexfauquette Feb 2, 2023

Choose a reason for hiding this comment

cherniavskii Feb 8, 2023

Choose a reason for hiding this comment

github-actions bot commented Feb 6, 2023

cherniavskii commented Feb 8, 2023

LukasTy left a comment

Choose a reason for hiding this comment

MBilalShafi commented May 22, 2023 • edited Loading

cherniavskii commented Jun 19, 2023

cherniavskii Jun 19, 2023

Choose a reason for hiding this comment

cherniavskii Jun 26, 2023

Choose a reason for hiding this comment

richbustos left a comment

Choose a reason for hiding this comment

MBilalShafi left a comment

Choose a reason for hiding this comment

MBilalShafi Jul 3, 2023

Choose a reason for hiding this comment

MBilalShafi Jul 3, 2023

Choose a reason for hiding this comment

MBilalShafi Jul 3, 2023

Choose a reason for hiding this comment

github-actions bot commented Jul 14, 2023

joserodolfofreitas left a comment

Choose a reason for hiding this comment

cherniavskii commented Jan 31, 2023 •

edited

Loading

mui-bot commented Jan 31, 2023 •

edited

Loading

MBilalShafi commented May 22, 2023 •

edited

Loading