[PLAT-4042] Document CONNECT_WORKSPACE_URN option #72
Conversation
docs/guides/render-static-scenes.mdx
Outdated
| :::tip | ||
| Scenes that are created or updated with the metadata key/value pair `"CONNECT_WORKSPACE_URN": "{YOUR_URN}"` will be added to the corresponding Connect workspace. This information can be added to the attributes section of your requests: | ||
| ``` | ||
| "attributes": { | ||
| "metadata": { | ||
| "CONNECT_WORKSPACE_URN": "{YOUR_URN}" | ||
| } | ||
| } | ||
| ``` | ||
| ::: |
There was a problem hiding this comment.
What do you think of having a separate section for this on the Import Data page? Seems more related to the importing of your data vs rendering. Also guessing that the import data guide will expand with details about integrating with your PDM.
There was a problem hiding this comment.
That's fair. How about this?
|
| @@ -254,3 +254,15 @@ curl --location --request GET \ | |||
|
|
|||
| </TabItem> | |||
| </Tabs> | |||
|
|
|||
| :::tip | |||
There was a problem hiding this comment.
Instead of a tip, how about a new section Adding Scenes to Connect? This way it's listed in the TOC and allows for hyperlinking.
There was a problem hiding this comment.
I'm going to leave it as-is for now, because that might lead to a larger restructuring of how this information is grouped. I'm not sure it makes sense to have a full section called Adding Scenes to Connect, but not share how to create a scene until two pages later. I think it's a good idea for the future though!
Summary
This PR updates the documentation to include information on how to set CONNECT_WORKSPACE_URN in order to automatically push data to a specific location in Connect.