Watching Morio through the oven window
After the initial months of design, preparation, and writing code, we've recently started working on the Morio documentation, including its automated publishing in a CI pipeline.
We strongly believe that documentation should never be an afterthought, but be written alongside the code itself. When trying to explain things in documentation, those things that are counter-intuitive and awkwardly named become obvious. And if we document early, we have a chance to intervene before these tweaks require too many changes.
As we do our work in the open, this means that our documentation too is now out there. Which is great, because it allows for early feedback on what we're doing, and how we're doing it.
But on the flip side, we need to be conscious of raised expectations, and prevent people from getting disappointed because their initial enthusiasm bumps into the still (very) rough edges of Morio.
For this reason, we'd like to clarity what you can expect at this time:
- Morio is not ready
Morio exists in various more or less broken states. We do not have any published releases at this time. We do not even have a stablemain
branch. Use the current Morio only as a learning experience. - Documentation is for the desired state
As we mentioned, we write our documentation as we make progress on Morio. So often we document the desired state where we are working towards. In other words, the documentation can sometimes be ahead of the implementation, and sometimes behind. The goal is that they will converge over time.
Even though things are not ready for production, for those who have taken an interest in Morio, we want to make it easy to familiarise yourself with the project, understand what we are trying to do, and how we are going about doing it. We are also open to contributions or ideas that can bring value to CERT-EU, our constituents, our partners, and our peers.
For this reason, we have published the Morio documentation site, rather than wait. It's like watching through the oven window as Morio is being baked. It's exciting to watch it rise, we'd love to hear your thoughts and opinions, but if you take out Morio now, it will not only cave in, you are also very likely to burn your hands.
That being said, it already smells great ๐
If you want to get involved, do not hesitate to leave your feedback.