HocusPocus is enabled, but nothing has changed

[JustDoItSascha]

I have seen that there is a HocusPocus part in the values.yaml and from the short comment I thought activating this would bring real-time features. I assumed this means things like live changes when someone writes comments and stuff like this.

HocusPocus runs, I also see the config was set automatically in the admin section. But no websocket has opened and no real-time changes. What did I do wrong?

[brunopagno]

Hey, this is still pretty much an experimental feature we're working on. If you want to get a bit more context you can take a look at this epic. Summarizing, the idea is to allow for multiple users to collaborate when editting documents on the documents module.

If you wish to play around you can enable the feature flag Block note editor, and create a document with the category Experimental, but be aware that it is not fully functional and will have issues. And that data persisted using this experimental feature might be lost in the future when we do a full release.

[JustDoItSascha]

Ah ok, understood. Then I have two questions:

1. What exactly is the document module? (I'm completely new to open project and don't see it anywhere.
2. But is there then a collaboration method? That I see in real time when someone adds a comment or changes a description on a ticket which i'm looking at right now?

Edit: I have seen that comments are plopping in. But changes on the description for example not.

[wielinde]

@JustDoItSascha The Documents module can be activated per project (in the project settings) just as many other modules, e.g. Wiki, GitHub integration, ... Up until now it served as a very basic place to share documents (often files) with the project team. We don't believe that many people use it. And that is why it is our first candidate to get familiar with the real time editing tech stack. In case we users have a bad experience here, they will not hate us as much as if we create a bad experience in the Work packages module.

Obviously, it would be most valuable to have real time editing in work packages, for example for collaboratively working on a work package description. That is indeed our long stretch goal. And to get there we first need to learn a lot. Websockets for instance can be nasty in corporate environments that have special firewalls etc. Also, it requires to have a separate server/service running. We will only achieve this for containerized environments. Packaged based installation will not receive these features anymore. And not everybody will be happy about it.

[JustDoItSascha]

@wielinde Hey! I activated the feature under /admin/settings/experimental and activated the documents module in the project. But I cannot choose category "Experimental" for a document 🤔

[brunopagno]

@JustDoItSascha you need to create it under admin/settings/document_categories