A place for important notes
Closed this issue · 3 comments
How do we keep important notes? Look at the following example. I had this very important sentence about the configuration of clusters in networks. But I am sure I will not find it again on those big websites...
Don’t forget that the Hazelcast cluster should live within one LAN. So even if you run the cluster on multiple Docker hosts, they should be located in one local network. If you need to synchronize Hazelcast data across multiple data centers, then have a look at the WAN Replication feature that is part of Hazelcast Enterprise. which you will need a license to access.
https://hazelcast.com/blog/configuring-hazelcast-in-non-orchestrated-docker-environments/
This heavily depends on the Use-Case:
If this is nothing more than a personal note: A personal notebook 😛
If this belongs to a topic that already can/should get documented (e.g., the concept "Hazelcast cluster" or the tasks "Running a cluster on multiple Docker hosts" and "Synchronizing Hazelcast data across multiple Data Centers"), in there
If this will later be relevant for a section of the documentation, in a reusable topic. For example, this might be a good case for a <note type="remember"> or a <note type="warning"> element. If you put such an element (with a unique ID!) into a topic called, say topics/reusable/notes.dita (which will be "just" a <topic>), this can get inserted into other topics using DITA's reusability features (cf. chapter 10 in DITA Best Practices: A Roadmap for Writing, Editing, and Architecting in DITA (IBM Press) (English Edition))
It is a detail on configuring the cluster system. This is extremly hard to find and will come up every time we build a new cluster for a customer.
We have this place now in the "Internal Documentation" docs. I'm closing this issue 🙂