@@ -89,16 +89,23 @@ Resources should be global when:
8989
9090### Exporting resources
9191
92- Currently, CodeGate doesn't provide a built-in mechanism to export workspace configurations .
93- However, you can use the API to retrieve workspace configurations and save them externally :
92+ Exporting resources in CodeGate is designed to facilitate sharing workspaces between different instances .
93+ This is particularly useful for :
9494
95- ``` bash
96- # Get workspace configuration
97- curl -X GET http://localhost:8989/api/v1/workspaces/{workspace_name} -H " Content-Type: application/json "
95+ - ** Standardizing configurations ** : When you want to ensure consistent behavior across multiple CodeGate instances
96+ - ** Sharing best practices ** : When you've developed effective muxing rules or custom instructions that others could benefit from
97+ - ** Backup and recovery ** : To preserve important workspace configurations before making significant changes
9898
99- # Get workspace muxing rules
100- curl -X GET http://localhost:8989/api/v1/workspaces/{workspace_name}/muxes -H " Content-Type: application/json"
99+ When deciding whether to export resources, consider:
101100
102- # Get workspace custom instructions
103- curl -X GET http://localhost:8989/api/v1/workspaces/{workspace_name}/custom-instructions -H " Content-Type: application/json"
104- ```
101+ - ** Export workspace configurations** when they represent reusable patterns that could be valuable in other contexts
102+ - ** Export muxing rules** when they represent well-tested routing strategies that could be applied in other instances
103+ - ** Export custom instructions** when they contain general-purpose prompting strategies not specific to your instance
104+
105+ Avoid exporting:
106+ - Workspaces with instance-specific configurations that wouldn't be applicable elsewhere
107+ - Workspaces containing sensitive or organization-specific custom instructions
108+ - Resources that are tightly coupled to your specific provider endpoints or authentication setup
109+
110+ Note that conversation history, alerts, and token usage statistics are not included in exports as they
111+ represent instance-specific usage data rather than reusable configurations.
0 commit comments