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

[Doc] Add documentation for the versioning features #9584

Merged
merged 3 commits into from
Jan 16, 2024
Merged

Conversation

fzaninotto
Copy link
Member

The ra-history package adds many new features allowing to:

  • Prevent data loss with robust version control
  • Enhance transparency with detailed change logs
  • Uncover insights with the 'diff' feature, a powerful tool for comparing versions
  • Boost confidence in making changes with easy rollback options

These features are documented in the Enterprise Edition website at https://marmelab.com/ra-enterprise/modules/ra-history

Yet, to make these features discoverable, we need to mention them in the OSS documentation. But we can't create one page per new component - the OSS doc is already very crowded.

  • Add mention of ra-history in the Fetures chapter
  • Add mention of derived components in <SimpleForm> and <TabbedForm> chapters
  • Add <RevisionsButton> chapter
  • Add index entry for all the new components

@fzaninotto fzaninotto added the RFR Ready For Review label Jan 15, 2024
@@ -756,34 +755,6 @@ const ProductEdit = () => (

**Tip**: In this example, both the `<ReviewsFormTab>` and the `<ReferenceManyField>` issue a `dataProvider.getManyReference()` call to fetch the related reviews. Thanks to react-query's query deduplication logic, the dataProvider only receives one request to fetch the reviews.

## Displaying a Tab Based On Permissions
Copy link
Member Author

Choose a reason for hiding this comment

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

Moved down to be closer to the RBAC section

@djhi djhi merged commit e6edfe4 into master Jan 16, 2024
5 checks passed
@djhi djhi deleted the history-doc branch January 16, 2024 11:31
@djhi djhi added this to the 4.16.7 milestone Jan 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
RFR Ready For Review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants