docs: add guide for migrating a team to another OCS instance#539
docs: add guide for migrating a team to another OCS instance#539SmittieC wants to merge 1 commit into
Conversation
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
| - api/index.md | ||
| - api/getting_started_with_oauth.md | ||
| - API Access: tech-hub/api_access.md | ||
| - Migrate a Team to Another Instance: tech-hub/migrate_team.md |
There was a problem hiding this comment.
This line is at 4-space indent, which makes it a sibling of OCS API: — i.e. a new top-level Tech Hub page, not a child under "OCS API" after "API Access" (children sit at 6 spaces). The PR description says it was added "under Tech Hub → OCS API, after API Access," which contradicts this placement.
Top-level placement is arguably the better fit (this isn't really an "OCS API" topic), so this may just be a stale description — but please confirm the intent and either fix the description or nest it under OCS API:.
|
Docs review — Solid, well-structured first draft. Step ordering, cross-reference anchors, admonition syntax (including the blank line before the bulleted list in the "Effects of migration mode" warning), and the definition-list troubleshooting section all check out. Both key-generation snippets are correct and produce interchangeable RSA-2048 PEMs, and every internal link target resolves. A few items worth addressing before this leaves draft: Should fix
Suggestions
|
Summary
Adds a step-by-step how-to guide for migrating a team from one OCS instance to another (e.g. from the hosted
www.openchatstudio.comto a self-hosted target), aimed at team admins / self-hosting operators.The guide covers, in order:
sync_teammanagement command (source-run and Docker variants)reregister_webhooks(auto + manual channels)It ends with a prominent warning to leave migration mode enabled on the source until the team is deleted there, plus "what is / isn't migrated" summaries and a troubleshooting section.
Added to the nav in
mkdocs.ymlunder Tech Hub → OCS API, after API Access.Verification
uv run zensical build --clean --strictpasses with no issues.🤖 Generated with Claude Code