DOC Remove GraphQL #556
DOC Remove GraphQL #556
Conversation
emteknetnz
force-pushed
the
pulls/6/remove-graphql
branch
5 times, most recently
from
fcb8db7 to
ac22c8f
Compare
GuySartorelli
left a comment
GuySartorelli
left a comment
There was a problem hiding this comment.
There's docs not in the graphql section that need updating, e.g. https://docs.silverstripe.org/en/5/developer_guides/customising_the_admin_interface/reactjs_redux_and_graphql/ and https://docs.silverstripe.org/en/5/developer_guides/model/versioning/#history-viewer-gql
emteknetnz
force-pushed
the
pulls/6/remove-graphql
branch
2 times, most recently
from
5c3771a to
906da23
Compare
|
Have removed the other mentions of graphql in the docs |
|
|
||
| See [Reading versions by stage](#reading-versions-by-stage) for more about using reading modes. | ||
|
|
||
| ## Using the history viewer |
There was a problem hiding this comment.
Need to document the new way to do it, rather than just deleting the docs altogether. This is still a valid thing for people to want to do.
There was a problem hiding this comment.
Turns out you can just add HistoryViewerField to your form and it works.
There was a problem hiding this comment.
This still hasn't been updated? It should be pretty quick docs to write. Just a short php example adding that field to a new Root.History tab.
There was a problem hiding this comment.
Have added.
In my testing I noticed pretty quickly the DataObjects with has_many relations doesn't work in the history viewer, because there's no react GridField. I've opted to just remove the GridFields
- I'm manually removing them in the versioned-admin PR here
- I've added a comment to the framework PR about why we don't use the structural schema data type
I also noticed that when reverting a DataObject that the edit form still shows the old record instead of the reverted to version, so I've opted to simply refresh the entire page. Regular pages don't have this issue because the pages reloads when switching between tabs (which doesn't happen with regular DataObjects). New code to do that here
|
Linting failure as well. |
emteknetnz
force-pushed
the
pulls/6/remove-graphql
branch
from
906da23 to
6129be0
Compare
|
|
||
| See [Reading versions by stage](#reading-versions-by-stage) for more about using reading modes. | ||
|
|
||
| ## Using the history viewer |
There was a problem hiding this comment.
This still hasn't been updated? It should be pretty quick docs to write. Just a short php example adding that field to a new Root.History tab.
emteknetnz
force-pushed
the
pulls/6/remove-graphql
branch
3 times, most recently
from
b7ef6aa to
01392da
Compare
|
Still has a linting failure. |
emteknetnz
force-pushed
the
pulls/6/remove-graphql
branch
2 times, most recently
from
d339e38 to
f48b162
Compare
emteknetnz
force-pushed
the
pulls/6/remove-graphql
branch
from
f48b162 to
b5a8f84
Compare
GuySartorelli
left a comment
GuySartorelli
left a comment
There was a problem hiding this comment.
re-approved most recent changes
| This example assumes you have some `DataObject` model and somewhere to view that model (e.g. in a `ModelAdmin`). We'll walk you through the steps required to add some JavaScript to tell the history viewer how to handle requests for your model. | ||
|
|
||
| For this example we'll start with this simple `DataObject`: | ||
| You can add the [`HistoryViewerField`](api:SilverStripe\VersionedAdmin\Forms\HistoryViewerField) to the edit form of any [`DataObject`](api:SilverStripe\ORM\DataObject) with the [`Versioned`](api:SilverStripe\Versioned\Versioned) extension. This will allow CMS users revert to a previous version of the record. |
There was a problem hiding this comment.
| You can add the [`HistoryViewerField`](api:SilverStripe\VersionedAdmin\Forms\HistoryViewerField) to the edit form of any [`DataObject`](api:SilverStripe\ORM\DataObject) with the [`Versioned`](api:SilverStripe\Versioned\Versioned) extension. This will allow CMS users revert to a previous version of the record. | |
| You can add the [`HistoryViewerField`](api:SilverStripe\VersionedAdmin\Forms\HistoryViewerField) to the edit form of any [`DataObject`](api:SilverStripe\ORM\DataObject) with the [`Versioned`](api:SilverStripe\Versioned\Versioned) extension. This will allow CMS users to view the version history for the record and revert to a previous version of the record. |
2 participants
Issue silverstripe/silverstripe-admin#1799
GraphQL is becoming an optional module, so docs are being re-housed in the GraphQL module