Skip to content

docs(confluence): add Confluence knowledge integration guide#1098

Draft
christestet wants to merge 1 commit intoopen-webui:devfrom
christestet:docs/confluence-integration-dev
Draft

docs(confluence): add Confluence knowledge integration guide#1098
christestet wants to merge 1 commit intoopen-webui:devfrom
christestet:docs/confluence-integration-dev

Conversation

@christestet
Copy link

Important

This PR is a DRAFT — it depends on an unreleased feature in the main repo. Please review together with the feature PR once merged.

Related feature PR: open-webui/open-webui#21727

Summary

  • Adds documentation for the new Confluence knowledge integration
  • Targets dev branch as the feature is not yet released
  • File: docs/tutorials/integrations/confluence.mdx

What's in this doc

  1. Admin setup — enable the integration, set Confluence base URL and deployment type; env var alternatives (ENABLE_CONFLUENCE_INTEGRATION, CONFLUENCE_BASE_URL, CONFLUENCE_DEPLOYMENT_TYPE)
  2. Per-user credentials — Cloud (email + API token from id.atlassian.com) vs. Data Center (Personal Access Token or username/password), stored per-user (no shared service account)
  3. Import workflow — step-by-step: select space → browse hierarchical page tree → select pages/subtrees → import with progress feedback
  4. Architecture reference — table of backend components, API endpoints, config variables, auth methods
  5. Troubleshooting — missing menu option, failed connection test, empty spaces list, failed imports, stale content

Test plan

  • Doc renders correctly in Docusaurus (mdx, tables, admonitions)
  • Feature PR merged → convert to ready for review
  • Verify sidebar position (33) doesn't conflict with adjacent entries

🤖 Generated with Claude Code

@pr-validator-bot
Copy link

ℹ️ Documentation PR Guidelines

👋 Welcome! This is an automated message posted on all new documentation PRs to help guide our contributors. Just because this comment appeared doesn't mean you have done anything wrong!

Please ensure you're using the correct branches:

Target branch (where you're merging TO):

  • dev branch: For documentation related to upcoming Open WebUI releases (new features, new environment variables, anything dependent on unreleased versions and unreleased features/fixes/changes)
  • main branch: For content that can go live immediately (fixes, tutorials, documentation not dependent on unreleased features)

Source branch (where you're merging FROM):

  • If targeting dev, create your branch from your fork's dev branch
  • If targeting main, create your branch from your fork's main branch
  • ⚠️ Mismatched branches can and will result in unwanted file changes being included in your PR!

If your docs PR depends on a pending PR in open-webui/open-webui:

  • Convert this PR to DRAFT mode!
  • Link to the related main repo PR in your description for clarity
  • We'll review both together once the PR on the main repo is merged

Please adjust your PR target branch, source branch, and/or draft status accordingly if needed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants