Update documentation for template consolidation work #3028
Conversation
5916b68 to
ee242ad
Compare
|
@nickgros @epicfaace I believe I have updated all of the documentation. I may push a few more changes for the |
docs/api-reference/uiSchema.md
Outdated
| ```jsx | ||
| const uiSchema = { | ||
| title: { | ||
| "classNames": "my class" |
There was a problem hiding this comment.
I think this is a big breaking change and to make it less painful to users to upgrade, what about just showing a warning instead of ignoring classNames completely? For example, I use rjsf in an upstream library where I store tons of form schemas / uiSchemas in a database. It's not feasible for me to rename classNames in all of them to ui:classNames.
The fundamental issue is that this breaking change is not as easy as just changing code, but could potentially require large data migrations, which is much more cumbersome. I wonder if many others would have a similar issue which would preclude them from upgrading to v5.
There was a problem hiding this comment.
Do those same schemas you have tucked away also use enumNames because those are being removed too :(
docs/api-reference/uiSchema.md
Outdated
| ```jsx | ||
| const uiSchema = { | ||
| title: { | ||
| "classNames": "my class" |
There was a problem hiding this comment.
For clarity, we should provide an example with ui:classNames in it
There was a problem hiding this comment.
If you look at the top of the file you'll see that I do provide ui:classNames in the main example of equivalence. Is that sufficient?
fea38c0 to
cef4037
Compare
cef4037 to
402dfec
Compare
|
@epicfaace @jacqueswho @nickgros I've resolved all conflicts and improved a few things. Please review ASAP so that I can begin the process of merging the |
|
@epicfaace If you'd rather have a little more time to review things, might I suggest letting this PR merge and following it up with an update in a later PR... It is a beta so things will take time to gel. |
- Updated the 5.x upgrade guide for the work done around template consolidation - Updated the advanced customization guides for the work done around template consolidation (slightly incomplete) - Updated the Form properties for the work done around template consolidation - Updated the UiSchema docs for the work done around template consolidation - Updated the Utililty function documentation for the work done around template consolidation - Updated the array documentation for work done around template consolidation
- Restored description of `RJSFSchema`
402dfec to
20d7008
Compare
* Update documentation for template consolidation work - Updated the 5.x upgrade guide for the work done around template consolidation - Updated the advanced customization guides for the work done around template consolidation (slightly incomplete) - Updated the Form properties for the work done around template consolidation - Updated the UiSchema docs for the work done around template consolidation - Updated the Utililty function documentation for the work done around template consolidation - Updated the array documentation for work done around template consolidation * - Additional documentation * - More changes for CHANGELOG.md as I review issues * - Made the `classNames` change a deprecation instead of a break - Restored description of `RJSFSchema` * - Additional cleanup of documentation after closer self-review
Reasons for making this change
CHANGELOG.mdto remark about issues fixed by this releaseChecklist
npm run test:updateto update snapshots, if needed.