Added some basic extension documentation #87
Conversation
docs/planning/extensions.mdx
Outdated
| @@ -0,0 +1,64 @@ | |||
| # Extensions | |||
There was a problem hiding this comment.
Idle thought: Would it make sense for this to be an Advanced topic, ie Advanced - Incons?
docs/planning/extensions.mdx
Outdated
There was a problem hiding this comment.
Structurally, I think this page can be split into two sections:
- User-facing: how to find and run extensions in the UI, and that there will be a notification indicating if the run was successful (you don't need to specify that it's a Toast notif, since the average Aerie user may not be familiar with notification type names)
- Deployment-manager-facing: how to add new extensions, what the expected payload and response packets look like.
Those might even be two pages, one in planning and one in deployment, with planning linking to deployment in a similar way the planning mission model page links to the create a model docs.
Regardless, there ought to be a brief demo video or screenshot showing the reader what and where they should look to find extensions in the UI, as the intro paragraph just says "If there are not any extensions defined the button to view them will be hidden", with no indication to the reader of what that button looks like.
Additionally, these API queries should be at least duplicated on a page in the API section of our docs.
docs/planning/extensions.mdx
Outdated
| After creating an Extension, you need to define the roles that are allowed to access it through the following Hasura mutation: | ||
|
|
||
| ```graphql | ||
| mutation InsertExtensionRole($extensionRole: extension_roles_insert_input!) { | ||
| insert_extension_roles_one(object: $extensionRole) { | ||
| id | ||
| } | ||
| } | ||
| ``` |
There was a problem hiding this comment.
Minor, ignorable: Offering the bulk query may be better, if the expectation is that multiple roles can run an extension
Just some basic docs for Extensions!