Configuration
Customize your GTECH Documentation workspace with settings and integrations
Workspace Settings
You configure GTECH Documentation to match your team's preferences and requirements. This includes setting permissions, themes, and integrations that enhance usability. Adjust these options to optimize your documentation environment from the start.
Access Settings
Navigate to the workspace dashboard and select the settings gear icon.
Define Permissions
Assign roles to users: admin for full control, editor for content management, viewer for read access.
// API example for updating user roles
await fetch(`/api/workspaces/${workspaceId}/users/${userId}`, {
method: 'PATCH',
headers: { 'Authorization': `Bearer ${token}` },
body: JSON.stringify({ role: 'editor' })
});
Enable Integrations
Connect external services like GitHub for automatic syncing.
Integrations require OAuth approval for secure access.
Choose from light, dark, or custom themes to improve readability.
/* Custom CSS example for branding */
.docs-header {
background-color: #3B82F6;
color: white;
}
.content-body {
font-family: 'Inter', sans-serif;
}
Configure email and Slack notifications for document updates and mentions. You set thresholds for alerts, such as notifying on edits by non-admins.
Backup Configuration
Schedule automatic backups to external storage like S3 for data safety.
Search Indexing
Enable full-text search with custom stop words and synonyms.
# Configuration file example for workspace
workspace:
name: 'Project Docs'
theme: 'dark'
integrations:
github:
repo: 'org/project-docs'
webhook: true
slack:
channel: '#docs-updates'
permissions:
defaultRole: 'viewer'
{
"workspace": {
"name": "Project Docs",
"theme": "dark",
"integrations": {
"github": {
"repo": "org/project-docs",
"webhook": true
},
"slack": {
"channel": "#docs-updates"
}
},
"permissions": {
"defaultRole": "viewer"
}
}
}
Review all integration permissions carefully to avoid exposing sensitive data.
With these configurations, you tailor GTECH Documentation to fit seamlessly into your workflow. Regularly review settings as your project evolves to maintain efficiency.