Skip to content

docs: replace some mermaid charts with excalidraw#1098

Merged
func25 merged 1 commit into
masterfrom
docs-images-upd
Feb 16, 2026
Merged

docs: replace some mermaid charts with excalidraw#1098
func25 merged 1 commit into
masterfrom
docs-images-upd

Conversation

@hagen1778

Copy link
Copy Markdown
Contributor

This is an attempt to replace some of the mermaid diagrams with excalidraw diagrams. Excalidraw is supposed to make those diagrams look better and still keep the source updateable.


I have attempted to update only diagrams that aren't good looking and could be complex in understanding or managing.

This is an attempt to replace some of the mermaid diagrams with excalidraw diagrams.
Excalidraw is supposed to make those diagrams look better and still keep the source
updateable.
@hagen1778 hagen1778 requested review from func25 and valyala February 12, 2026 16:19

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

2 issues found across 8 files

Prompt for AI agents (all issues)

Check if these issues are valid — if so, understand the root cause of each and fix them.


<file name="docs/victorialogs/security-and-lb.md">

<violation number="1" location="docs/victorialogs/security-and-lb.md:68">
P2: The referenced image file is not present in the repository, so this diagram will render as a broken image. Add the image asset (or revert to the previous diagram) so the doc stays self-contained.</violation>

<violation number="2" location="docs/victorialogs/security-and-lb.md:407">
P2: The referenced image file is not present in the repository, so this diagram will render as a broken image. Add the image asset (or revert to the previous diagram) so the doc stays self-contained.</violation>
</file>

Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.

Comment thread docs/victorialogs/security-and-lb.md
Comment thread docs/victorialogs/security-and-lb.md

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 8 files

@kapouer

kapouer commented Feb 13, 2026

Copy link
Copy Markdown

I am baffled by the huge step back in the documentation indexability and formatting caused by this PR.
Markdown graphs will be readable in ten years.
Excalidraw won't.

@hagen1778

Copy link
Copy Markdown
Contributor Author

Markdown graphs will be readable in ten years.

@kapouer could you please elaborate on it?

I understand how easier it is to maintain the mermaid graph - you can patch it right in the .md file, no knowledge of excalidraw required. That's for sure.
The drawback of this ability is that complex mermaid diagrams are too bulky. Take an example of HA setup:
image
This diagram is pretty simple, btw. But it takes so much space to explain a very simple concept.
The hand-drawn version of it is smaller in size and is just easier to read:
image

So that's a tradeoff between maintainability and visual aspect. This PR is a suggestion, it can be accepted or declined based on amount of pros&cons it provides.

@kapouer

kapouer commented Feb 16, 2026

Copy link
Copy Markdown

I understand the need for more compact diagrams (did you try to render it with elk, or optimize it using some LLM ?).
However those are not exactly the same two diagrams, so it's no wonder one is less compact.

@hagen1778

hagen1778 commented Feb 16, 2026

Copy link
Copy Markdown
Contributor Author

did you try to render it with elk, or optimize it using some LLM?

I did. And I didn't like what I got. Getting better at it is always an option. But I think the price for that outweighs the pros.

Please note, I have no intention to reduce docs quality. If maintainers think it got worse - they can just reject the request.

However those are not exactly the same two diagrams, so it's no wonder one is less compact.

I have intentionally removed what I thougt has low informational impact or is confusing.

@func25

func25 commented Feb 16, 2026

Copy link
Copy Markdown
Member

Mermaid is easy for creating diagrams, but it turns out to be hard to control style, spacing, alignment, etc so it is not a great visualization tool. We have very few images in the documentation, so maintainability effort is low. Using Excalidraw is fine and results in higher quality.

@func25 func25 merged commit c9fee61 into master Feb 16, 2026
1 check passed
@func25 func25 deleted the docs-images-upd branch February 16, 2026 16:37
@func25

func25 commented Feb 16, 2026

Copy link
Copy Markdown
Member

Thanks for your contribution to the docs

valyala added a commit that referenced this pull request Jun 2, 2026
…47d6a8 and b0f3bfc

- Return back the contents of the TLS section at https://docs.victoriametrics.com/victorialogs/cluster/#tls .
  This contents describes how to set up TLS communication between nodes in VictoriaLogs cluster.
  This contents isn't generic, so it cannot be moved to the https://docs.victoriametrics.com/victorialogs/security-and-lb/ .
  Moreover, the migration of these docs to the https://docs.victoriametrics.com/victorialogs/security-and-lb/
  resulted in the loss of clarity of these docs because of AI slop.

- Return back the contents of the mTLS section at https://docs.victoriametrics.com/victorialogs/cluster/#mtls .
  This contents describes how to set up mTLS between nodes in VictoriaLogs cluster.
  This contents isn't generic, so it cannot be moved to the https://docs.victoriametrics.com/victorialogs/security-and-lb/ .
  Again, the migration of these docs to the https://docs.victoriametrics.com/victorialogs/security-and-lb/
  resulted in the loss of clarity because of AI slop.

- Move the 'Security on untrusted networks' chapter to the top of the https://docs.victoriametrics.com/victorialogs/security-and-lb/ ,
  since it contains the most important recommended security advice for VictoriaLogs components - to run everything in trusted private
  networks, and to expose to the Internet only vmauth. Clarify this chapter a bit.

- Simplify vmauth config examples by removing non-essential configs from them at https://docs.victoriametrics.com/victorialogs/security-and-lb/ .

- Drop docs/victorialogs/security-and-lb-search-auth.webp , since it was misleading and incorrectly reflected the load balancing config for vmauth
  among vlselect nodes in a single VictoriaLogs cluster.
  This is a follow-up for the commit c9fee61 . Updates #1098 .

- Remove misleading AI-generated chapters with close to zero useful information from https://docs.victoriametrics.com/victorialogs/security-and-lb/ .

- Clarify the rest of the chapters at https://docs.victoriametrics.com/victorialogs/security-and-lb/
  and clean them up from AI slop.

Updates #715
Updates #654
@valyala

valyala commented Jun 2, 2026

Copy link
Copy Markdown
Contributor

FYI, I removed the docs/victorialogs/security-and-lb-search-auth.webp image in the commit 4ba11fe , because it was incorrect. It didn't match the contents of the chapter it was put into. This chapter - https://docs.victoriametrics.com/victorialogs/security-and-lb/#search-authorization - describes how to set up load balancing among vlselect nodes in a single cluster, while the removed image contained two independent clusters. @hagen1778 , could you create the correct image and return back it to the chapter? It would be great to have clear images for other chapters at https://docs.victoriametrics.com/victorialogs/security-and-lb/ too.

valyala added a commit that referenced this pull request Jun 2, 2026
… file, since it became unused after the commit 4ba11fe

Updates #1098
@hagen1778

Copy link
Copy Markdown
Contributor Author

Follow-up PR #1474 with images updates.

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.

4 participants