Skip to content
This repository was archived by the owner on Jun 5, 2025. It is now read-only.

Add developer documentation for workspaces #1237

Merged
JAORMX merged 3 commits into from
Mar 6, 2025
Merged

Add developer documentation for workspaces #1237

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
18fdc54
Add developer documentation for workspaces
JAORMX Mar 6, 2025
6ad0504
Update docs/workspaces.md
JAORMX Mar 6, 2025
96ff607
Add guidance on exporting
JAORMX Mar 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Add guidance on exporting 
Signed-off-by: Juan Antonio Osorio <ozz@stacklok.com>
  • Loading branch information
@JAORMX
JAORMX committed Mar 6, 2025
commit 96ff6071d4d19fb2ed6555a593689f991d03d3a9
27 changes: 17 additions & 10 deletions docs/workspaces.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,16 +89,23 @@ Resources should be global when:

### Exporting resources

Currently, CodeGate doesn't provide a built-in mechanism to export workspace configurations.
However, you can use the API to retrieve workspace configurations and save them externally:
Exporting resources in CodeGate is designed to facilitate sharing workspaces between different instances.
This is particularly useful for:

```bash
# Get workspace configuration
curl -X GET http://localhost:8989/api/v1/workspaces/{workspace_name} -H "Content-Type: application/json"
- **Standardizing configurations**: When you want to ensure consistent behavior across multiple CodeGate instances
- **Sharing best practices**: When you've developed effective muxing rules or custom instructions that others could benefit from
- **Backup and recovery**: To preserve important workspace configurations before making significant changes

# Get workspace muxing rules
curl -X GET http://localhost:8989/api/v1/workspaces/{workspace_name}/muxes -H "Content-Type: application/json"
When deciding whether to export resources, consider:

# Get workspace custom instructions
curl -X GET http://localhost:8989/api/v1/workspaces/{workspace_name}/custom-instructions -H "Content-Type: application/json"
```
- **Export workspace configurations** when they represent reusable patterns that could be valuable in other contexts
- **Export muxing rules** when they represent well-tested routing strategies that could be applied in other instances
- **Export custom instructions** when they contain general-purpose prompting strategies not specific to your instance

Avoid exporting:
- Workspaces with instance-specific configurations that wouldn't be applicable elsewhere
- Workspaces containing sensitive or organization-specific custom instructions
- Resources that are tightly coupled to your specific provider endpoints or authentication setup

Note that conversation history, alerts, and token usage statistics are not included in exports as they
represent instance-specific usage data rather than reusable configurations.