ckeditor5 icon indicating copy to clipboard operation
ckeditor5 copied to clipboard

Introduce Server-side editor API docs

Open DawidKossowski opened this issue 7 months ago • 1 comments

Suggested merge commit message (convention)

Docs: Introduce Server-side editor API docs.


Additional information

Do NOT merge it before CS releases the feature.

DawidKossowski avatar Jun 05 '25 06:06 DawidKossowski

Just an idea – any chance for a simple system diagram that shows e.g. a scene like this (naming of things should probably be improved a bit):

graph TD
    %% User A and B
    subgraph Browser_A["Browser (user A)"]
        A1["Editor instance (user A)"]
    end

    subgraph Browser_B["Browser (user B)"]
        B1["Editor instance (user B)"]
    end

    %% Cloud Services
    subgraph Cloud["Cloud Services"]
        C1["Editor instance (virtual user)"]
        CS["Collaboration Server"]
    end

    %% Application Backend
    Backend["Application backend (your system)"]

    %% Connections
    A1 --> CS
    B1 --> CS
    C1 --> CS
    Backend -->|Server-side Editor API| C1

Reinmar avatar Jun 11 '25 08:06 Reinmar

Looks like the CS part has been merged: https://github.com/cksource/docs/pull/760

godai78 avatar Jul 02 '25 11:07 godai78

Changes in CS have been temporarily retracted.

godai78 avatar Jul 03 '25 11:07 godai78

Docs are available on prod: https://ckeditor.com/docs/cs/latest/guides/collaboration/server-side-editor-api.html

jflakus-cksource avatar Jul 07 '25 08:07 jflakus-cksource

Are we rebasing to release?

Witoso avatar Jul 07 '25 14:07 Witoso

Are we rebasing to release?

No real need to do that. We may merge it now, "as is," just as well. Unless we specifically want to ship it with the release for some reason.

godai78 avatar Jul 08 '25 04:07 godai78

Please plan the merge of it 😊

Witoso avatar Jul 09 '25 08:07 Witoso