-
Notifications
You must be signed in to change notification settings - Fork 220
DOC-3498: tinymceai on-prem documentation.
#4137
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
kemister85
wants to merge
4
commits into
feature/8.6.0/DOC-3401
Choose a base branch
from
feature/8.6.0/DOC-3401_DOC-3498
base: feature/8.6.0/DOC-3401
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
7fdc6e5
DOC-3498: tinymceai on-prem documentation.
kemister85 b06e673
DOC-3498: Address content gaps identified in source audit
kemister85 157f923
DOC-3498: Expand acronyms on first prose use across on-premises pages
kemister85 1d8769c
DOC-3498: Clean up architecture overview diagram
kemister85 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| #!/usr/bin/env bash | ||
| # | ||
| # Re-renders all .mmd Mermaid sources to .svg in the on-premises images folder. | ||
| # | ||
| # Usage (from repo root): | ||
| # ./-scripts/render-mermaid.sh | ||
| # | ||
| # Requirements: | ||
| # Node.js (npx downloads @mermaid-js/mermaid-cli automatically) | ||
| # | ||
| set -euo pipefail | ||
|
|
||
| DIAGRAM_DIR="modules/ROOT/images/tinymceai-on-premises" | ||
| CONFIG_FILE=$(mktemp) | ||
|
|
||
| cat > "$CONFIG_FILE" << 'JSON' | ||
| { | ||
| "htmlLabels": false, | ||
| "flowchart": { "htmlLabels": false, "useMaxWidth": true }, | ||
| "sequence": { "useMaxWidth": true }, | ||
| "theme": "default" | ||
| } | ||
| JSON | ||
|
|
||
| trap 'rm -f "$CONFIG_FILE"' EXIT | ||
|
|
||
| count=0 | ||
| for mmd in "$DIAGRAM_DIR"/*.mmd; do | ||
| [ -f "$mmd" ] || continue | ||
| svg="${mmd%.mmd}.svg" | ||
| name=$(basename "$mmd") | ||
| printf " Rendering %s\n" "$name" | ||
| npx -y @mermaid-js/mermaid-cli -i "$mmd" -o "$svg" \ | ||
| -c "$CONFIG_FILE" --backgroundColor white 2>/dev/null | ||
|
|
||
| # Mermaid outputs width="100%" which has no intrinsic size in <img> tags. | ||
| # Replace with the actual pixel width from the viewBox so browsers can | ||
| # calculate the correct aspect ratio when the page scales the image. | ||
| vb_width=$(grep -o 'viewBox="[^"]*"' "$svg" | head -1 | awk -F'[ "]' '{print $4}') | ||
| if [ -n "$vb_width" ]; then | ||
| vb_int=$(printf "%.0f" "$vb_width") | ||
| perl -i -pe "s/width=\"100%\"/width=\"${vb_int}\"/" "$svg" | ||
| fi | ||
|
|
||
| count=$((count + 1)) | ||
| done | ||
|
|
||
| printf "\nRendered %d diagrams in %s\n" "$count" "$DIAGRAM_DIR" |
4 changes: 4 additions & 0 deletions
4
modules/ROOT/images/tinymceai-on-premises/advanced-scenarios-fig-1.mmd
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| flowchart LR | ||
| Editor[TinyMCE editor] <-->|chat / quick actions| AI[AI Service] | ||
| AI -->|MCP tools/call| MCP[MCP Server<br>knowledge-hub] | ||
| MCP -->|read| KB[Confluence ·<br>Notion ·<br>GitBook ·<br>internal wiki] | ||
1 change: 1 addition & 0 deletions
1
modules/ROOT/images/tinymceai-on-premises/advanced-scenarios-fig-1.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 14 additions & 0 deletions
14
modules/ROOT/images/tinymceai-on-premises/advanced-scenarios-fig-2.mmd
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| flowchart LR | ||
| subgraph Tenants[Your SaaS customers] | ||
| CA[Customer A users] | ||
| CB[Customer B users] | ||
| CC[Customer C users] | ||
| end | ||
| subgraph AISvc[Single AI service deployment] | ||
| EA[Environment A<br>access keys A<br>isolated conversations] | ||
| EB[Environment B<br>access keys B<br>isolated conversations] | ||
| EC[Environment C<br>access keys C<br>isolated conversations] | ||
| end | ||
| CA --> EA --> OpenAI[OpenAI] | ||
| CB --> EB --> Anthropic[Anthropic] | ||
| CC --> EC --> Azure[Azure OpenAI] |
1 change: 1 addition & 0 deletions
1
modules/ROOT/images/tinymceai-on-premises/advanced-scenarios-fig-2.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 8 additions & 0 deletions
8
modules/ROOT/images/tinymceai-on-premises/advanced-scenarios-fig-3.mmd
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| flowchart LR | ||
| Lawyer[TinyMCE editor<br>used by lawyer] <--> AI[AI Service] | ||
| AI -->|tools/call| MCP1[MCP: contract-db] | ||
| AI -->|tools/call| MCP2[MCP: compliance-checker] | ||
| AI -->|tools/call| MCP3[MCP: precedent-search] | ||
| MCP1 --> ContractDB[(Contract clause<br>repository)] | ||
| MCP2 --> ComplianceRules[(Regulatory<br>rule sets)] | ||
| MCP3 --> PrecedentIdx[(Precedent<br>search index)] |
1 change: 1 addition & 0 deletions
1
modules/ROOT/images/tinymceai-on-premises/advanced-scenarios-fig-3.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
28 changes: 28 additions & 0 deletions
28
modules/ROOT/images/tinymceai-on-premises/complete-guide-fig-1.mmd
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| flowchart TB | ||
| Browser["Browser<br>TinyMCE editor + tinymceai plugin"] | ||
| TokenEP["Your token endpoint<br>signs HS256 JWTs"] | ||
| Browser -->|"fetch JWT"| TokenEP | ||
| Browser -->|"HTTPS + Bearer JWT"| LB | ||
|
|
||
| subgraph App["Application layer (stateless, N replicas)"] | ||
| LB["Reverse proxy / Load balancer<br>nginx · ALB · K8s Ingress<br>TLS termination · SSE pass-through"] | ||
| AIN["ai-service replica N"] | ||
| AI2["ai-service replica 2"] | ||
| AI1["ai-service replica 1"] | ||
| LB --> AIN | ||
| LB --> AI2 | ||
| LB --> AI1 | ||
| end | ||
|
|
||
| subgraph Data["Shared data layer"] | ||
| DB[("SQL database<br>MySQL 8.0+ / PostgreSQL 13+")] | ||
| Cache[("Redis 3.2.6+")] | ||
| Storage[("File storage<br>S3 · Azure Blob · filesystem")] | ||
| end | ||
|
|
||
| AI1 --> Data | ||
|
|
||
| AI1 -->|"HTTPS"| LLM["LLM provider<br>OpenAI · Anthropic · Google ·<br>Azure · Bedrock · Vertex ·<br>self-hosted"] | ||
|
|
||
| AI1 -.->|"telemetry"| Obs["OpenTelemetry · Langfuse"] | ||
| AI1 -.->|"tool calls"| MCP["MCP servers"] |
1 change: 1 addition & 0 deletions
1
modules/ROOT/images/tinymceai-on-premises/complete-guide-fig-1.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
?