zonemaster
Removes old design documents
Purpose
As commented in #573 there are two old design documents that were never completed and never updated. They are not used.
This PR removes the documents and updates the README file listing them.
How to test this PR
Documentation only.
I read through these documents and I think they actually reflect the state of the system really well, even though they haven't been touched for years. They seem fairly timeless to me. I suggest we resurrect them rather than delete them. I can take it upon myself to make the updates.
Easy updates:
- They still refer to Zonemaster even though we renamed the component to Zonemaster Engine.
- The performance non-goal should be upgraded to a proper goal after our last F2F, though it should remain at a lower priority than the three original goals.
Practices we should resurrect:
- The Guideline document speaks of perltidy and perlcritic, and we actually have the config files for these still in the zonemaster-engine root! We should really start using them. Perhaps the config files need some minimal tweaking before we can take them up again, I'm not sure. Then we should integrate checks for them in our CI.
Items for discussion:
- The Architecture document speak of an Information Object and the Guideline document has an "Exposing test metadata" section. They seem to be about different sides of the same coin. This isn't really implemented as an object today, and I'm not sure of its usefulness. This is probably a good topic for a WG meeting.
- The Guideline document has a "Returning information from tests, the practice" section. I'm sure we have things to tell on this subject and it might actually be a healthy thing to actually do. However I can't just spit out an outline for this. Maybe we could brainstorm it at a WG meeting?
What do you guys say? Delete or resurrect? And are there any other noteworthy things in the documents that I didn't list above?
